feat(docs): Introduce Conventional Commits & release process docs #717
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
phated
requested review from
jfecher,
TomAFrench,
kevaundray,
vezenovm,
guipublic,
joss-aztec and
kobyhallx
|
@critesjosh and or @Globallager can you take a look at the now SUPPORT.MD file? |
|
Added them as reviewers, but worth noting that I just copy-pasted from CONTRIBUTING.md so we didn't lose anything. |
Savio-Sou
previously approved these changes
Feb 1, 2023
|
Should we also disable normal & rebase PR merges to better enforce squash merging once this goes in? cc @kevaundray
|
Savio-Sou
reviewed
Feb 1, 2023
5 tasks
phated
dismissed stale reviews from vezenovm, TomAFrench, and Savio-Sou
via
4dc28a1
phated
force-pushed
the
phated/release-process
branch
from
4dc28a1 to
686fbb5
Compare
jfecher
approved these changes
Feb 3, 2023
kevaundray
approved these changes
Feb 3, 2023
phated
changed the title
TomAFrench
added a commit
to TomAFrench/noir
that referenced
this pull request
Feb 3, 2023
* master: feat(nargo): Add `nargo test` command to run all unit tests (noir-lang#728) chore(ci): Apply `doc needed` label automatically on PRs (noir-lang#733) chore(ci): Remove failing bors workflow (noir-lang#744) feat(ci): Add workflow to validate PR title (noir-lang#730) feat(docs): Introduce Conventional Commits & release process docs (noir-lang#717)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Related issue(s)
Resolves #607
Description
This introduces a process for Noir releases that leverages Conventional Commits and the release-please tool to produce a "release pull request" containing an auto-generated changelog, appropriate SemVer bumps, and lockfile updates.
Summary of changes
I reorganized the
SUPPORT.mdfile to contain community-facing things, and then updatedCONTRIBUTING.mdto discuss my proposed release solution. I also updated therelease.ymlworkflow to use release-please.Dependency additions / changes
Test additions / changes
Checklist
cargo fmtwith default settings.Additional context
I'll be discussing our workflow changes at the scheduled meeting time 🎉
We'll also want to tag a version right before we land this so we can have everything onward follow the convention.