-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Include documentation + committing release branch (#52)
* Include documentation + committing release branch * Add env for author * Fix indent * Set CI commit email to machine account
- Loading branch information
1 parent
b582ecf
commit 0c5e321
Showing
3 changed files
with
28 additions
and
13 deletions.
There are no files selected for viewing
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
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
# How to release a new version of DeepView.Profile | ||
- Go to Github repo and run the action `build-and-publish-new-version`. You will be prompted to specify the version number. | ||
|
||
- This runs a GitHub Action that will take the following steps: | ||
1. Fetches the repo and its dependencies | ||
2. Creates a release branch | ||
3. Updates the version number to the user-specified version by updating the pyproject.toml | ||
4. Commits the changes and tag the commit with the version number | ||
5. Builds the Python build artifacts | ||
7. Publishes a release to Github | ||
8. Create a PR to merge back into main | ||
9. Publishes to Test PyPI | ||
10. Publishes to PyPI | ||
|
||
- The action `build-and-publish-new-version` is defined under `.github/workflows/build-and-publish-new-versionyaml` | ||
|
||
- This release process follows the release process outlined in [OneFlow](https://www.endoflineblog.com/oneflow-a-git-branching-model-and-workflow). |