-
Notifications
You must be signed in to change notification settings - Fork 12
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add deploy workflow and release instructions
- Loading branch information
1 parent
ac8e8c4
commit bbda04d
Showing
4 changed files
with
52 additions
and
2 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,28 @@ | ||
name: deploy | ||
|
||
on: | ||
push: | ||
tags: | ||
- "v*" | ||
|
||
jobs: | ||
|
||
deploy: | ||
runs-on: ubuntu-latest | ||
|
||
steps: | ||
- uses: actions/checkout@v3 | ||
|
||
- name: Build and Check Package | ||
uses: hynek/build-and-inspect-python-package@v1.5 | ||
|
||
- name: Download Package | ||
uses: actions/download-artifact@v3 | ||
with: | ||
name: Packages | ||
path: dist | ||
|
||
- name: Publish package to PyPI | ||
uses: pypa/gh-action-pypi-publish@master | ||
with: | ||
password: ${{ secrets.pypi_token }} |
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,2 @@ | ||
Next Release | ||
============ |
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 @@ | ||
Here are the steps on how to make a new release. | ||
|
||
1. Create a ``release-VERSION`` branch from ``upstream/master``. | ||
2. Install ``bumpversion`` and execute: | ||
|
||
:: | ||
|
||
bumpversion minor --new-version 1.0.11 | ||
|
||
Changing ``minor`` and ``--new-version`` above accordingly. | ||
|
||
3. Push a branch with the changes. | ||
4. Once all builds pass and at least another maintainer approves, push a tag to ``upstream`` in the format ``v1.0.11`. | ||
This will deploy to PyPI. | ||
5. Merge the PR (do not squash, to keep the tag). | ||
6. Create a new release on GitHub, posting the contents of the current CHANGELOG. | ||
7. Open a new PR clearing the ``CHANGELOG.md`` file. |