Skip to content

RELEASE.md

Latest commit

 

History

History
32 lines (27 loc) · 1001 Bytes

RELEASE.md

File metadata and controls

32 lines (27 loc) · 1001 Bytes

Release instructions for ScanCode.io

Automated release workflow

  • Create a new release-x.x.x branch
  • Update the version in:
    • pyproject.toml
    • scancodeio/__init__.py
    • CHANGELOG.rst (set date)
  • Run $ uv lock to update the version in the uv.lock file
  • Commit and push this branch: "chore: bump version to vx.x.x for release"
  • Create a PR and merge once approved
  • Tag and push that tag. This will trigger the pypi-release.yml GitHub workflow that takes care of building the dist release files and upload those to pypi: 
    VERSION=vx.x.x  # <- Set the new version here
git tag -a $VERSION -m ""
git push origin $VERSION
  • Review the GitHub release created by the workflow at https://github.com/aboutcode-org/scancode.io/releases

Manual build

cd scancode.io
source .venv/bin/activate
python -m pip install build
python -m build --sdist --wheel --outdir dist/ .

The distribution files will be available in the local dist/ directory.