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

feat(release): add nx release plan:check command to ensure relevant version plans exist #27343

Merged
merged 2 commits into from
Aug 12, 2024

Conversation

JamesHenry
Copy link
Collaborator

@JamesHenry JamesHenry commented Aug 8, 2024

Current Behavior

When using version plans as a versioning strategy with nx release, there is no way to enforce that version plan files are created when changing files.

Expected Behavior

There is a new nx release plan:check subcommand, intended to be run in CI (and/or potentially a git hook) which will return with exit code 1 if touched projects are not represented in at least one version plan file on disk.

What constitutes a touched file is shared with our affected logic in other commands, with the additionally capability to be able to ignore file patterns from consideration. This would be useful for not requiring version plans when only documentation or spec files change, for example.

Related Issue(s)

Fixes #

Copy link

vercel bot commented Aug 8, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

1 Skipped Deployment
Name Status Preview Updated (UTC)
nx-dev ⬜️ Ignored (Inspect) Visit Preview Aug 12, 2024 4:48pm

@JamesHenry JamesHenry force-pushed the release-plan-check branch 2 times, most recently from 59b25fa to e77dced Compare August 8, 2024 15:40
@JamesHenry JamesHenry changed the title feat(release): add nx release plan-check command to ensure relevant version plans exist feat(release): add nx release plan:check command to ensure relevant version plans exist Aug 9, 2024
@JamesHenry JamesHenry marked this pull request as ready for review August 9, 2024 14:27
@JamesHenry JamesHenry requested review from a team as code owners August 9, 2024 14:27
@JamesHenry JamesHenry requested review from xiongemi, ndcunningham, fahslaj and FrozenPandaz and removed request for ndcunningham and xiongemi August 9, 2024 14:27
@JamesHenry JamesHenry enabled auto-merge (squash) August 12, 2024 16:52
@FrozenPandaz FrozenPandaz disabled auto-merge August 12, 2024 17:44
@FrozenPandaz FrozenPandaz merged commit 4108bfc into master Aug 12, 2024
6 checks passed
@FrozenPandaz FrozenPandaz deleted the release-plan-check branch August 12, 2024 17:44
Copy link

This pull request has already been merged/closed. If you experience issues related to these changes, please open a new issue referencing this pull request.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Aug 30, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants