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

Automate stable releases for installation method use #750

Open
dutterbutter opened this issue Nov 28, 2024 · 1 comment · Fixed by #762
Open

Automate stable releases for installation method use #750

dutterbutter opened this issue Nov 28, 2024 · 1 comment · Fixed by #762
Assignees

Comments

@dutterbutter
Copy link
Collaborator

dutterbutter commented Nov 28, 2024

Description

Our current nightly release process causes users to immediately adopt the latest release via the provided installation method. This approach has a drawback: any bugs introduced in the nightly build can directly impact users when they install or update using foundryup-zksync.

To address this, we will include a versioned releases that prioritize stability for installation and updates. This will involve leveraging a release workflow similar to the one under development for zksync-era core (see issue) with the exclusion of crates publishing. The new release flow will include:

Proposed Workflow

  1. Automated Release PRs:

    • Automatically generate and update a "Release PR" for every merge to the main branch.
    • This ensures visibility of upcoming changes, enabling the team to review and manage the release process effectively.
  2. Release Manager Review:

    • The releases will be approved and merge the "Release PR" once all checks are complete and the release is ready.
  3. Versioned and Tagged Releases:

    • A new release (e.g., v0.0.3) will be created upon merging the Release PR.
    • The release will include relevant changelogs and release notes and will be tagged as "latest."
  4. Stable Installation Updates:

    • The foundryup-zksync installation method will fetch the "latest" tagged release, ensuring users always get a stable version.
  5. Nightly Releases

    • Nightly releases will continue to be created and tagged accordingly
@antonbaliasnikov
Copy link
Contributor

Found out the flaw in release-plz config that without publishing to crates.io it will not properly work until release-plz/release-plz#1144 is fixed.

To do:

  • Implement release-please solution that does not require publishing
  • Document the release process in RELEASE.md

CC: @dutterbutter

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 a pull request may close this issue.

2 participants