Skip to content

Commit 2d5da71

Browse files
authored
Document Release Instructions (#54)
1 parent 57bd504 commit 2d5da71

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

CONTRIBUTING.md

+23
Original file line numberDiff line numberDiff line change
@@ -48,3 +48,26 @@ it, you can serve it locally by following [these steps](https://docs.github.com/
4848

4949
NOTE: There can be a delay between changes going into the `master` branch and
5050
GitHub Pages rebuilding with the changes.
51+
52+
## Releasing
53+
54+
The version checked into source is kept in an alpha state until we are ready to release. The release workflow automatically increments the version to a non-alpha version when a GitHub Release is created, and then moves to the next alpha afterwards.
55+
56+
The release process is as follows:
57+
58+
1. Check the version located in [pyproject.toml](https://github.com/ni/python-styleguide/blob/main/pyproject.toml).
59+
1. Create a [new release](https://github.com/ni/python-styleguide/releases/new) with the appropriate description.
60+
1. Use the current version to specify the git tag. (remove the alpha part) (v1.0.0).
61+
1. Publish the release.
62+
63+
Once this is released, it should show up on https://pypi.org/project/ni-python-styleguide/.
64+
65+
### Manually Setting Version
66+
67+
The Poetry verison can be manually overridden through `poetry version` commands. The version checked into source should be in an alpha state.
68+
69+
In a fork:
70+
71+
1. Run `poetry version preminor` for minor update (v0.1.7-alpha.0 -> v0.2.0-alpha.0).
72+
1. Run `poetry version premajor` for major update (v0.6.7-alpha.0 -> v1.0.0-alpha.0).
73+
1. Merge the fork and complete the normal release process above.

0 commit comments

Comments
 (0)