Skip to content

Document and script the current release process #205

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

Closed
nwneisen opened this issue Jun 21, 2023 · 0 comments
Closed

Document and script the current release process #205

nwneisen opened this issue Jun 21, 2023 · 0 comments
Labels
build documentation Improvements or additions to documentation

Comments

@nwneisen
Copy link
Contributor

nwneisen commented Jun 21, 2023

This issue is to document and script the release process that was used when creating v0.3.3 for a future reference.

A longer term solution would be to setup a github action to do everything but I'd like to capture everything known until then.

This is the process I used to create the release binaries on my local machine:

  1. Bump the versions in the VERSION and packaging/common.mk files and commit the changes
  2. Run the make command for each OS
    make deb
    make rpm
    make static-linux
    make cross-win
    make cross-mac
    make cross-arm
  3. Copy each of the binaries from their output path to a common folder for uploading
  4. Verify the binaries are a reasonable size compared to previous releases
  5. Create the release using the github release interface. Tag the commit that was a result of step one. Create the release notes using the previous release tag and the new release tag as the range.

Summary:

  • Disable .github/workflows/publish.yml so it does not get accidentally triggered or used
  • Add a make command or a bash script to generate the release binaries and move them to a common folder for uploading
  • Document the process in the project's README.md
@nwneisen nwneisen added documentation Improvements or additions to documentation build labels Jun 21, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
build documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant