Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Tag 2.3 Release #128

Closed
mattt opened this issue Sep 25, 2019 · 7 comments
Closed

Tag 2.3 Release #128

mattt opened this issue Sep 25, 2019 · 7 comments
Milestone

Comments

@mattt
Copy link
Collaborator

mattt commented Sep 25, 2019

With Xcode 11 and Swift 5.1 now officially released, and with so many improvements and additions to the library, I think now would be a great time to cut a new minor release.

@regexident Is there any work still pending that you'd like to include in 2.3?

@mattt mattt added this to the 2.3 milestone Sep 25, 2019
@regexident
Copy link
Collaborator

regexident commented Sep 25, 2019

The following test files I so far haven't "modernized":

  • AuxiliaryTests.swift
  • ConvolutionTests.swift
  • HyperbolicTests.swift
  • TrigonometricTests.swift

'ConvolutionTests.swift' looks fine to me, but 'HyperbolicTests.swift' and 'TrigonometricTests.swift' still have tests & benchmarks combined, which I would like to split up/clean up.

And I'd want to update the README's inventory, adding any missing public additions.

Other than that I think we're in a good shape for a 2.3 🙂.

@regexident
Copy link
Collaborator

@mattt With the issues of above comment fixed by now I'd say v2.3 is good to go. 👍

@regexident regexident mentioned this issue Oct 22, 2019
11 tasks
@mattt
Copy link
Collaborator Author

mattt commented Oct 23, 2019

I think this is a great opportunity to revisit our release process. I don't want to hold things up too much, and maybe these are things that we can defer to 2.3.1 or 3.0, but here's what I'd like to see at some point:

@regexident Do you have strong opinions about any of these? Anything else you'd like us to incorporate as part of our release process?

@regexident
Copy link
Collaborator

👌 🎉


In theory aggregating the release notes should result in the change log, but keeping an actual CHANGES.md file has the benefit of requiring pull requests (or changes in general) to leave a trace in that file before approval can be given. Additionally, unlike release notes you do not lose a changelog when moving from Github, i.e. less vendor lock-in.

As such CHANGES.md should be our source of truth, with release notes being an optional lossy and fragmented mirror of it.


[…] though I'm not sure how this relates or can be derived automatically from a changelog)

If we were to use the https://keepachangelog.com/en/1.0.0/ "standard" for CHANGES.md, then we might be able to use a tool like clparse (Rust; maintained; available via Homebrew) to parse the changelog, searching for a version entry matching the release tag and extract its information, optionally failing CI if nothing found.

Alternatively one could simply link from the release note to the corresponding section of CHANGES.md by using …/CHANGELOG.md#100---2017-06-20 (i.e. 1.0.0 @ 2017-06-20).

I have no experience with automating Github releases though, so just guessing.


All of this sounds like a good candidate for adding a .github/PULL_REQUEST_TEMPLATE.md?

While we're at that we might as well add .github/CONTRIBUTING.md and .github/ISSUE_TEMPLATE.md.

@regexident
Copy link
Collaborator

I think this is a great opportunity to revisit our release process. …

Github Actions? 🤔

@mattt
Copy link
Collaborator Author

mattt commented Oct 28, 2019

Github Actions? 🤔

😓 That's something I hadn't take into account before we spun the project out into its own org. Whereas I personally have access to the GitHub Actions preview, this new org doesn't (yet). I'll see if there's an easy way to request access.Never mind! Action away!

@regexident
Copy link
Collaborator

regexident commented Nov 2, 2019

For 2.3.0 I opted to do things manually for now.

(Cocoapods has been updated, too.)

There are however a few actions that look like they could come in handy, most notably:

  • Release Drafter: Drafts your next release notes as pull requests are merged into master.

https://github.com/sdras/awesome-actions#pull-requests

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants