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

Document the version release process #1744

Open
rachitnigam opened this issue Oct 15, 2023 · 1 comment
Open

Document the version release process #1744

rachitnigam opened this issue Oct 15, 2023 · 1 comment
Labels
C: Docs Documentation to add/improve S: Available Can be worked upon

Comments

@rachitnigam
Copy link
Contributor

Currently, this is something only I do but it would be good to have a documentation page describing how to release a new version. Briefly:

  1. Bump the version field in Cargo.toml for all the dependencies and build-dependencies.
  2. Update the CHANGELOG.md file and commit the changes (without pushing yet)
  3. Release the packages on cargo in dependency order. This is successful when the calyx package is published. If anything goes wrong and you need to make changes, make the changes and add them to the commit using git comment --amend
  4. Add a new tag for the version using git tag <version>
  5. Push the commit (git push) and the tag (git push --tags). The latter command might not quite be thing to do because it pushes all the tags.
  6. Once the tag is published, draft a new release on GitHub. Copy over the changes from the CHANGELOG.md file for the current release.

Once all of this is done, new docker containers with the specific version tag will be automatically built using Depot and tagged as latest.

@rachitnigam rachitnigam added S: Available Can be worked upon C: Docs Documentation to add/improve labels Oct 15, 2023
@sampsyo
Copy link
Contributor

sampsyo commented Oct 16, 2023

Documenting this so it's easy to "turn the crank" sounds great.

Even more ambitiously, at some point you can imagine automating some of the mechanical stuff (such as the Cargo publishing) with a tag-triggered Action…

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C: Docs Documentation to add/improve S: Available Can be worked upon
Projects
None yet
Development

No branches or pull requests

2 participants