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

chore(repo): add release workflow action #51

Merged
merged 3 commits into from
May 10, 2024

Conversation

Cammisuli
Copy link
Member

@Cammisuli Cammisuli commented May 8, 2024

Releasing new versions

Versioning requires triggering the Nx Cloud Workflow Release workflow with comma separated commits to cherry pick and the version to release as.

Note

Only the version number is needed if a new release is needed. The workflow will automatically create the branch and tag from the HEAD of main if the new version is a major. Or it will use the latest HEAD on the relative major branch based on the version number. (This allows us to place commits in release branches, and tag them when needed)

The workflow will do the following:

  • All major releases will have its own releases/v* branch
  • The head of each release branch will always have the major v* tag pointing to the HEAD of the branch. If minor/patch releases are needed multiple tags will be created for it.
  • Examples:
    • Releasing 4.1 will have tags v4 and v4.1 created at the HEAD of the release branch.
    • Releasing 4.2 will have tags v4 and v4.2 created at the HEAD of the release branch. Previous tags (v4.1 in this case) will remain unchanged
    • Releasing 4.2.1 will have tags v4, v4.2 and v4.2.1 created at the HEAD.
  • Users are able to use v4 and get all minor and patches automatically
  • Users are able to use v4.1 and get all patches automatically

Important

Tags should not be created directly on main, and will always be created off release branches. This allows us to iterate on main without causing too many disruptions for users.

@Cammisuli Cammisuli force-pushed the create-release-workflow branch from 0055c74 to 1fc5ec6 Compare May 8, 2024 19:14
@Cammisuli Cammisuli requested a review from rarmatei May 9, 2024 13:50
@Cammisuli Cammisuli merged commit fbd7dcb into nrwl:main May 10, 2024
1 check passed
@Cammisuli Cammisuli deleted the create-release-workflow branch May 10, 2024 13:55
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