Skip to content

Commit ac14832

Browse files
committed
add section about how to create a new release
1 parent 198a7c8 commit ac14832

File tree

1 file changed

+32
-0
lines changed

1 file changed

+32
-0
lines changed

CONTRIBUTING.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -123,3 +123,35 @@ e.g.:
123123
```shell
124124
make -C docs html
125125
```
126+
127+
128+
## Creating a New Release
129+
130+
To create a new release of pyscript-cli, follow these steps:
131+
132+
1. Update the version number in `src/pyscript/version`
133+
134+
2. Update CHANGELOG.md with the changes since the last release
135+
136+
3. Create a new git tag matching the version number:
137+
```shell
138+
git tag X.Y.Z
139+
```
140+
141+
4. Push the tag to GitHub:
142+
```shell
143+
git push origin X.Y.Z
144+
```
145+
146+
5. The GitHub Actions workflow will automatically:
147+
- Verify the tag matches the version in `src/pyscript/version`
148+
- Run tests
149+
- Build and publish the package to PyPI
150+
- Create a GitHub release
151+
152+
6. Verify the new version is available on PyPI: https://pypi.org/project/pyscript-cli/
153+
154+
Note: Make sure all tests pass locally before creating a new release. The release workflow will fail if there are any test failures or version mismatches.
155+
156+
Note 2: The version number in `src/pyscript/version` and the tag pushed to git (`X.Y.Z` in the example above) MUST MATCH! If they don't match the, the
157+
action to create and publish the release won't start.

0 commit comments

Comments
 (0)