Skip to content

Commit a525623

Browse files
committed
docs: Improved RELEASE documentation
1 parent 325127a commit a525623

2 files changed

Lines changed: 36 additions & 6 deletions

File tree

CHANGELOG.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,11 @@
33
## 0.4.0 (06-10-2025)
44
- #19 - Removed Python 2 support and Six
55
- #28 - Set default_auto_field to django.db.models.AutoField in HeraldConfig
6+
- Added support for Django 5.2
67
- Updated GitHub Actions to fix Node12 depreciation warnings
78
- Update CI text matrix for supported Django / Python version
89
- docs: Update README
9-
- Added support for Django 5.2
10+
- docs: Improved RELEASE documentation
1011

1112

1213
## 0.3.0 (10-18-2022)

RELEASE.md

Lines changed: 34 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,34 @@
1-
1. Bump version number in `herald/__init__.py`
2-
2. Verify entry in `CHANGELOG.txt`
3-
3. Run `python setup.py sdist bdist_wheel`
4-
4. Run `twine upload dist/*`
5-
5. Add release on GitHub
1+
# How to Release
2+
3+
## Prerequistics
4+
5+
1. Install `setuptools` and `twine`:
6+
7+
```bash
8+
pip install setuptools twine
9+
```
10+
11+
## Procedure
12+
13+
1. Bump version number in `herald/__init__.py` and commit to source control.
14+
15+
2. Verify entry in `CHANGELOG.md`.
16+
17+
3. Build distribution:
18+
19+
```bash
20+
python setup.py sdist bdist_wheel
21+
```
22+
23+
4. Upload the distribution to PyPI and follow the prompts to provide the API token:
24+
25+
```bash
26+
twine upload dist/*
27+
```
28+
29+
5. Create a new release and tag on GitHub:
30+
31+
1. Go to [Draft a new release](https://github.com/peterfarrell/django-heralder/releases/new)
32+
2. Choose tag. If you have not created a tag yet, you can create one "on publish". Use the format of `vX.X.X`.
33+
3. Set the release title to the version. Ex: `vX.X.X`
34+
5. In the body for the release, copy the bullets of items from the `CHANGELOG.md`.

0 commit comments

Comments
 (0)