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

Set version to 1.5.0 #2540

Merged
merged 2 commits into from
Jun 26, 2024
Merged

Set version to 1.5.0 #2540

merged 2 commits into from
Jun 26, 2024

Conversation

mortenpi
Copy link
Member

@mortenpi mortenpi commented Jun 26, 2024

Let's get the admonition style changes out there.


Pre-release

  • Change the version number in Project.toml
    • If the release is breaking, increment MAJOR
    • If the release adds a new user-visible feature, increment MINOR
    • Otherwise (bug-fixes, documentation improvements), increment PATCH
  • Update CHANGELOG.md, following the existing style (in particular, make sure that the change log for this version has the correct version number and date).
  • Run make changelog, to make sure that all the issue references in CHANGELOG.md are up to date.
  • Check that the commit messages in this PR do not contain [ci skip]
  • Run regression-tests workflow using a workflow_dispatch trigger to check for any changes that broke extensions: https://github.com/JuliaDocs/Documenter.jl/actions/runs/9673025407

The release

  • After merging the pull request, tag the release. There are two options for this:

    1. Comment [at]JuliaRegistrator register on the GitHub commit.
    2. Use JuliaHub's package registration feature to trigger the registration.

    Either of those should automatically publish a new version to the Julia registry.

  • Once registered, the TagBot.yml workflow should create a tag, and rebuild the documentation for this tag.

  • These steps can take quite a bit of time (1 hour or more), so don't be surprised if the new documentation takes a while to appear.

@mortenpi mortenpi merged commit ce1fe29 into master Jun 26, 2024
23 checks passed
@mortenpi mortenpi deleted the mp/1.5.0 branch June 26, 2024 07:50
@mortenpi
Copy link
Member Author

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.

2 participants