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

Add release output information to README/documentation #22

Open
alexjhawk opened this issue Jul 11, 2023 · 1 comment
Open

Add release output information to README/documentation #22

alexjhawk opened this issue Jul 11, 2023 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@alexjhawk
Copy link
Collaborator

hms-networks/sc-ewon-flexy-extensions-lib#56, @it-hms:

Add directions to the readme for contributing a release. This includes the following steps:

  • do not name feature branch release/vX.Y.Z. This will will be done by automation.
  • ensure that CHANGELOG.MD has been updated
  • last commit subject should be RELEASE: vX.Y.Z
  • When PR is approved, delete feature branch(s). create tag from main branch.
git tag vX.Y.Z
git push vX.Y.Z 
@alexjhawk alexjhawk added the documentation Improvements or additions to documentation label Jul 11, 2023
@alexjhawk
Copy link
Collaborator Author

Replicating issue hms-networks/sc-ewon-flexy-extensions-lib#56 from https://github.com/hms-networks/sc-ewon-flexy-extensions-lib.

This suggested change also applies to the development environment documentation provided in this repository. Projects based on this starter project are/should be linked to this repository for development environment documentation. This will clarify the process for generating a release.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant