diff --git a/.github/release-drafter.yml b/.github/release-drafter.yml index d21cb40..215a03d 100644 --- a/.github/release-drafter.yml +++ b/.github/release-drafter.yml @@ -24,6 +24,8 @@ categories: labels: - "dependencies" - "build" +name-template: 'v$RESOLVED_VERSION' +tag-template: 'v$RESOLVED_VERSION' autolabeler: - label: 'documentation' files: diff --git a/.github/workflows/publish.yaml b/.github/workflows/publish.yaml index 197de25..a11a36d 100644 --- a/.github/workflows/publish.yaml +++ b/.github/workflows/publish.yaml @@ -1,10 +1,12 @@ name: Publish Python distributions to PyPI -on: push +on: + release: + types: [published] jobs: build-n-publish: - name: Build and publish to PyPI + name: Make Release on PyPI and Github runs-on: ubuntu-latest steps: - uses: actions/checkout@master diff --git a/README.md b/README.md index eac14cb..1254e03 100644 --- a/README.md +++ b/README.md @@ -57,7 +57,7 @@ Aaron Parsons ----------------------------------------------------------------------------- -# Package Info for Developers +## Package Info for Developers The miriad source code (`aipy/miriad/mirsrc`) was included from MIRIAD 4.0.5. To update, download a MIRIAD distribution and copy `$MIR/src/subs/*` and @@ -66,3 +66,11 @@ To update, download a MIRIAD distribution and copy `$MIR/src/subs/*` and Healpix source code (`aipy/healpix/cxx`) was included from Healpix 2.01. To update, download a HEALPix distribution and copy `src/cxx` into `aipy/healpix`. + +## Making Releases (for Maintainers) + +To make a release of `aipy` (both on Github and PyPI), head to the most current +[Draft Release](https://github.com/HERA-Team/aipy/releases) and note the *suggested* +release version. Contact the maintainers with your intention to make a release either +to that version (or, if appropriate, to a different version), and publish the release +via the Github UI. All done! \ No newline at end of file