diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml deleted file mode 100644 index 2e42932..0000000 --- a/.github/workflows/release.yml +++ /dev/null @@ -1,31 +0,0 @@ -name: Release - -on: - push: - tags: - - "*.*" - -jobs: - release: - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@v2 - - - name: Setup Python 3.10 - uses: actions/setup-python@v2 - with: - python-version: "3.10" - architecture: "x64" - - - name: Install flit - run: pip install flit - - - name: Build - run: flit build - - - name: Publish to PyPI - env: - FLIT_USERNAME: __token__ - FLIT_PASSWORD: ${{ secrets.PYPI_TOKEN }} - run: | - flit publish diff --git a/CONTRIBUTOR.md b/CONTRIBUTOR.md deleted file mode 100644 index 49824b6..0000000 --- a/CONTRIBUTOR.md +++ /dev/null @@ -1,7 +0,0 @@ -## To release - -1. Update the version in `pyproject.toml`; commit -2. Tag the commit with the same version: `git tag -s 0.2` -3. Push the commit and tag: `git push --tags origin main` -4. Update the version in `pyproject.toml` to the next development - version; push diff --git a/RELEASE.md b/RELEASE.md new file mode 100644 index 0000000..42cc3ff --- /dev/null +++ b/RELEASE.md @@ -0,0 +1,58 @@ +# Release process for `lazy_loader` + +## Introduction + +Example `version` + +- 1.8.dev0 \# development version of 1.8 (release candidate 1) +- 1.8rc1 \# 1.8 release candidate 1 +- 1.8rc2.dev0 \# development version of 1.8 (release candidate 2) +- 1.8 \# 1.8 release +- 1.9.dev0 \# development version of 1.9 (release candidate 1) + +## Process + +- Update and review `CHANGELOG.md`: + + gem install github_changelog_generator + github_changelog_generator -u scientific-python -p lazy_loader --since-tag= + +- Update `version` in `pyproject.toml`. + +- Commit changes: + + git add pyproject.toml CHANGELOG.md + git commit -m 'Designate release' + +- Add the version number (e.g., [v1.2.0]{.title-ref}) as a tag in git: + + git tag -s [-u ] v -m 'signed tag' + + If you do not have a gpg key, use -u instead; it is important for + Debian packaging that the tags are annotated + +- Push the new meta-data to github: + + git push --tags origin main + + where `origin` is the name of the `github.com:scientific-python/lazy_loader` + repository + +- Review the github release page: + + https://github.com/scientific-python/lazy_loader/releases + +- Publish on PyPi: + + git clean -fxd + pip install flit + flit build + flit publish + +- Update `version` in `pyproject.toml`. + +- Commit changes: + + git add pyproject.toml + git commit -m 'Bump version' + git push origin main