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

Simplify the release process (no more build script or release branches) #281

Merged
merged 9 commits into from
Sep 23, 2024

Conversation

DilumAluthge
Copy link
Member

@DilumAluthge DilumAluthge commented Aug 31, 2024

Fixes #280

After this PR, the release process of this repo becomes very simple:

  1. Create the new vMAJOR.MINOR.PATCH tag locally (and push it).
  2. Update the vMAJOR tag locally (and force-push it).
  3. Go to https://github.com/julia-actions/setup-julia/releases and create the release.

This is the exact same release process that is used in the julia-actions/cache repo1.

So, by having the same release process across multiple repos, this should make things easier for maintainers.

Benefits:

  1. There are no more long release instructions.
  2. There is no more build script that needs to be run.
  3. There are no more release branches.
  4. There is no need to run tests on the release branches, and then wait for those tests to pass before you can proceed.

Other benefits

  1. As an added benefit, after this, PRs to this repo become useable. So, if someone wants to test out a PR before it is merged, they can simply do uses: julia-actions/setup-julia@name-of-pr-branch.

Footnotes

  1. See the devdocs here: https://github.com/julia-actions/cache/blob/main/devdocs/making_a_new_release.md

@DilumAluthge DilumAluthge force-pushed the dpa/simplify-release-process branch 3 times, most recently from fedbeaf to 707e9cb Compare August 31, 2024 15:37
@DilumAluthge DilumAluthge marked this pull request as ready for review August 31, 2024 15:55
@DilumAluthge DilumAluthge requested a review from a team as a code owner August 31, 2024 15:55
@DilumAluthge DilumAluthge requested review from omus and IanButterworth and removed request for a team August 31, 2024 15:56
.github/workflows/pr_checks.yml Outdated Show resolved Hide resolved
.github/workflows/pr_checks.yml Outdated Show resolved Hide resolved
.github/workflows/pr_checks.yml Outdated Show resolved Hide resolved
.github/workflows/pr_checks.yml Outdated Show resolved Hide resolved
.github/workflows/pr_checks.yml Outdated Show resolved Hide resolved
@omus
Copy link
Contributor

omus commented Sep 19, 2024

I agree with the idea of checking in the built version

@DilumAluthge DilumAluthge marked this pull request as draft September 19, 2024 21:18
@DilumAluthge DilumAluthge marked this pull request as ready for review September 20, 2024 12:34
@DilumAluthge
Copy link
Member Author

@omus This is ready for another round of review.

@DilumAluthge
Copy link
Member Author

Bump @omus @IanButterworth

Copy link
Member

@IanButterworth IanButterworth left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If you believe in this design I'm happy to move to it. I suggest you lead the next release so that if anything goes wrong we can be reactive in fixing it.

@DilumAluthge DilumAluthge merged commit a0a0978 into master Sep 23, 2024
68 checks passed
@DilumAluthge DilumAluthge deleted the dpa/simplify-release-process branch September 23, 2024 22:17
@DilumAluthge
Copy link
Member Author

DilumAluthge commented Sep 23, 2024

I just cut a new release (v2.5.0), and I updated the v2 alias, just so that we can test out the new release process.

We can quickly revert if something breaks.

@DilumAluthge
Copy link
Member Author

I also updated the latest alias.

@DilumAluthge
Copy link
Member Author

From a quick test (JuliaLang/Example.jl#80), everything seems to be working.

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

Successfully merging this pull request may close these issues.

Automate publishing process to avoid issues
3 participants