Feature/release version management#1
Draft
LiamCottrell wants to merge 1 commit intoTerenceJefferies:masterfrom
Draft
Feature/release version management#1LiamCottrell wants to merge 1 commit intoTerenceJefferies:masterfrom
LiamCottrell wants to merge 1 commit intoTerenceJefferies:masterfrom
Conversation
comitizen added to allow ease of standardisation of commits with `npx git-cz`. standard-version added to update package.json with version depending on comit history `npm run release`. Husky added to add validation hook to commits to make sure we are adhering to `conventional commits` standard.
Owner
|
@LiamCottrell Love the idea, before we merge can you create a contributing guide for the repo? Avoid having to look up what to do with all of this post-merge? |
Author
|
I can do! I’ve noticed that I probably shouldn’t include the chore commit to tag the release at the feature branch level and this should be performed on master. I’ll make some amendments and give a contribute.md as part of the proposal |
LiamCottrell
force-pushed
the
feature/Release-Version-Management
branch
from
0e4d8a4 to
ab7b184
Compare
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Added a solution to allow the management of releases in the future with a lot of the manual changing of files removed.
The proposed solution does the following:
Makes use of the
Conventional Commitsstandard for commits, which is a syntaxual standard to use when decorating your messages to add new feature/bugfixes etc.We use the
comitizenpackage to take the effort of writing these commits away so they can be generated for us, and thenpx git-czcommand can be used.The addition of
huskythen is used as a commit hook to make sure the moderation of the Conventional Commits standard and prevents non-syntaxually correct commits.Finally, the use of
standard-versionadds a new script that by calculation of features added and git history, it increments the package.json correctly with the changes and tags the release appropriately. It then also makes changes to the Changelog file for us with the features added with a given release.