Skip to content

Commit 5a82086

Browse files
ericwbsigmavirus24
andauthored
Add instructions for Maintainers to create/publish a release (#1275)
* Add instructions for Maintainers to create/publish a release This change adds steps to the Contributing document instructions to Maintainers on how to create and publish a release. * Update CONTRIBUTING.md Co-authored-by: Ian Stapleton Cordasco <[email protected]> --------- Co-authored-by: Ian Stapleton Cordasco <[email protected]>
1 parent 2d0b675 commit 5a82086

File tree

1 file changed

+33
-2
lines changed

1 file changed

+33
-2
lines changed

CONTRIBUTING.md

Lines changed: 33 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -56,15 +56,20 @@ git clone https://github.com/<your username>/bandit.git
5656

5757
Create you own branch to start writing code:
5858
```shell script
59-
git checkout -b mybranch
59+
git switch -c mybranch
60+
<create local changes>
61+
git add <changed files>
62+
git commit -S
63+
<create a good commit message>
6064
git push origin mybranch
6165
```
6266
You can test any changes with tox:
6367

6468
```shell script
6569
pip install tox
6670
tox run -e pep8
67-
tox run -e py37
71+
tox run -e format
72+
tox run -e py39
6873
tox run -e docs
6974
tox run -e cover
7075
```
@@ -245,3 +250,29 @@ To register your plugin, you have two options:
245250
bson = bandit_bson:formatter
246251
bandit.plugins =
247252
mako = bandit_mako
253+
254+
## Creating and Publishing a Release (Maintainers)
255+
256+
### Create the GitHub Release
257+
258+
1. Navigate to the [Releases](https://github.com/PyCQA/bandit/releases) page
259+
2. Click on `Draft a new release`
260+
3. Under `Choose a tag` enter a new release version (typically increment the patch number) and select `Create new tag: <version> on publish`
261+
4. Click on `Generate release notes`
262+
5. Click on `Publish release`
263+
264+
### Publish the Release to Test PyPI
265+
266+
1. Go to `Actions` tab
267+
2. Click on the `Publish to Test PyPI` action
268+
3. Click on `Run workflow`
269+
4. Select `Use workflow from`, then `Tags` tab, and select `<version>`
270+
5. Click on `Run workflow`
271+
272+
### Publish the Release to PyPI
273+
274+
1. Go to `Actions` tab
275+
2. Click on the `Publish to PyPI` action
276+
3. Click on `Run workflow`
277+
4. Select `Use workflow from`, then `Tags` tab, and select `<version>`
278+
5. Click on `Run workflow`

0 commit comments

Comments
 (0)