From 57c57f04fe719c6c8376f73eef2b166db2d50f1b Mon Sep 17 00:00:00 2001 From: Lehman Garrison Date: Thu, 16 Nov 2023 14:47:29 -0500 Subject: [PATCH] ci: update release procedure --- .github/workflows/tests.yml | 5 ----- RELEASING.md | 12 ++++++++++++ RELEASING.rst | 8 -------- 3 files changed, 12 insertions(+), 13 deletions(-) create mode 100644 RELEASING.md delete mode 100644 RELEASING.rst diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml index d5d38066..fa6bfe08 100644 --- a/.github/workflows/tests.yml +++ b/.github/workflows/tests.yml @@ -23,11 +23,6 @@ jobs: runs-on: ubuntu-latest steps: - - name: Dump GitHub context - env: - GITHUB_CONTEXT: ${{ toJson(github) }} - run: echo "$GITHUB_CONTEXT" - - uses: actions/checkout@v4 with: fetch-depth: 0 diff --git a/RELEASING.md b/RELEASING.md new file mode 100644 index 00000000..a5e08971 --- /dev/null +++ b/RELEASING.md @@ -0,0 +1,12 @@ +# Release Procedure + +- Update `CHANGES.rst` (check `git diff vOLD`) +- Check that GitHub CI is passing +- Check that docs are building +- Make a new git tag: +```console +$ git tag -a vX.Y.Z -m 'Version X.Y.Z' +$ git push origin vX.Y.Z +``` +- Check that GitHub Actions built, tested, and uploaded the release to PyPI +- Make a GitHub release of tag vX.Y.Z: https://github.com/abacusorg/abacusutils/releases diff --git a/RELEASING.rst b/RELEASING.rst deleted file mode 100644 index 5c23ca5b..00000000 --- a/RELEASING.rst +++ /dev/null @@ -1,8 +0,0 @@ -Release Procedure -================= - -- Update ``CHANGES.rst`` (check ``git diff vOLD``) -- Check that GitHub CI is passing -- Check that docs are building -- Make a new release/git tag on GitHub: https://github.com/abacusorg/abacusutils/releases -- Check that GitHub Actions pushed a PyPI release from the GitHub release