Skip to content

Commit 60bb279

Browse files
committed
Add release documentation
Signed-off-by: tdruez <[email protected]>
1 parent 2e1a0d1 commit 60bb279

File tree

1 file changed

+31
-0
lines changed

1 file changed

+31
-0
lines changed

RELEASE.md

+31
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# Release instructions for `ScanCode.io`
2+
3+
### Automated release workflow
4+
5+
- Create a new `release-x.x.x` branch
6+
- Update the version in:
7+
- `setup.cfg` (2 entries)
8+
- `scancodeio/__init__.py`
9+
- `CHANGELOG.rst` (set date)
10+
- Commit and push this branch
11+
- Create a PR and merge once approved
12+
- Tag and push that tag. This will triggers the `pypi-release.yml` GitHub workflow that
13+
takes care of building the dist release files and upload those to pypi:
14+
```
15+
VERSION=vx.x.x # <- Set the new version here
16+
git tag -a $VERSION -m ""
17+
git push origin $VERSION
18+
```
19+
- Review the GitHub release created by the workflow at
20+
https://github.com/aboutcode-org/scancode.io/releases
21+
22+
### Manual build
23+
24+
```
25+
cd scancode.io
26+
source .venv/bin/activate
27+
pip install build
28+
python -m build --sdist --wheel --outdir dist/ .
29+
```
30+
31+
The distribution files will be available in the local `dist/` directory.

0 commit comments

Comments
 (0)