mirror of
https://github.com/xmonad/xmonad.git
synced 2025-05-19 08:30:21 -07:00
9849800dc5
During the release of xmonad 0.17.0, I realized that we need to be able to upload candidates before tagging the release on GitHub, because there might be issues with the tarball and Hackage may reject it. When that happened, I had to remove the release, delete the tag, upload the candidate manually to see what's wrong with it, try to fix it, upload it manually again, and so on. This commit swaps the logic: when the workflow is invoked manually, it uploads the candidate. This can be done multiple times, and once everything is fine, the release can finally be tagged and it's released to Hackage proper. The only disadvantage is that we need to remember to try uploading the candidate. Not sure if there's a perfect solution…
116 lines
4.8 KiB
Diff
116 lines
4.8 KiB
Diff
Piggy-back on the haskell-ci workflow for automatic releases to Hackage.
|
|
|
|
This extends the workflow with two additional triggers:
|
|
|
|
* When the Haskell-CI workflow is triggered manually with a non-empty version
|
|
input (matching the version in the cabal file), a candidate release is
|
|
uploaded to Hackage and docs are submitted for it as Hackage can't build
|
|
them itself (https://github.com/haskell/hackage-server/issues/925).
|
|
|
|
Note that promoting the candidate on Hackage discards the uploaded docs
|
|
(https://github.com/haskell/hackage-server/issues/70). Don't do that.
|
|
|
|
* When a release is created on GitHub, a final release is uploaded to Hackage
|
|
and docs are submitted for it.
|
|
|
|
The automation uses a special Hackage user: https://hackage.haskell.org/user/xmonad
|
|
and each repo (X11, xmonad, xmonad-contrib) has its own HACKAGE_API_KEY token
|
|
set in GitHub repository secrets.
|
|
|
|
--- .github/workflows/haskell-ci.yml.orig
|
|
+++ .github/workflows/haskell-ci.yml
|
|
@@ -14,8 +14,15 @@
|
|
#
|
|
name: Haskell-CI
|
|
on:
|
|
- - push
|
|
- - pull_request
|
|
+ push:
|
|
+ pull_request:
|
|
+ release:
|
|
+ types:
|
|
+ - published
|
|
+ workflow_dispatch:
|
|
+ inputs:
|
|
+ version:
|
|
+ description: candidate version (must match version in cabal file)
|
|
jobs:
|
|
linux:
|
|
name: Haskell-CI - Linux - ${{ matrix.compiler }}
|
|
@@ -31,6 +38,7 @@
|
|
compilerVersion: 9.0.1
|
|
setup-method: hvr-ppa
|
|
allow-failure: false
|
|
+ upload: true
|
|
- compiler: ghc-8.10.4
|
|
compilerKind: ghc
|
|
compilerVersion: 8.10.4
|
|
@@ -209,8 +217,66 @@
|
|
${CABAL} -vnormal check
|
|
- name: haddock
|
|
run: |
|
|
- $CABAL v2-haddock $ARG_COMPILER --with-haddock $HADDOCK $ARG_TESTS $ARG_BENCH all
|
|
+ $CABAL v2-haddock $ARG_COMPILER --with-haddock $HADDOCK $ARG_TESTS $ARG_BENCH --haddock-for-hackage --builddir $GITHUB_WORKSPACE/haddock all
|
|
- name: unconstrained build
|
|
run: |
|
|
rm -f cabal.project.local
|
|
$CABAL v2-build $ARG_COMPILER --disable-tests --disable-benchmarks all
|
|
+ - name: upload artifacts (sdist)
|
|
+ if: matrix.upload
|
|
+ uses: actions/upload-artifact@v2
|
|
+ with:
|
|
+ path: ${{ github.workspace }}/sdist/*.tar.gz
|
|
+ - name: upload artifacts (haddock)
|
|
+ if: matrix.upload
|
|
+ uses: actions/upload-artifact@v2
|
|
+ with:
|
|
+ path: ${{ github.workspace }}/haddock/*-docs.tar.gz
|
|
+ - name: hackage upload (candidate)
|
|
+ if: matrix.upload && github.event_name == 'workflow_dispatch' && github.event.inputs.version != ''
|
|
+ run: |
|
|
+ set -ex
|
|
+ PACKAGE_VERSION="${PACKAGE_VERSION#v}"
|
|
+ curl \
|
|
+ --silent --show-error --fail \
|
|
+ --header "Accept: text/plain" \
|
|
+ --header "Authorization: X-ApiKey $HACKAGE_API_KEY" \
|
|
+ --form package=@"${GITHUB_WORKSPACE}/sdist/${PACKAGE_NAME}-${PACKAGE_VERSION}.tar.gz" \
|
|
+ https://hackage.haskell.org/packages/candidates/
|
|
+ curl \
|
|
+ --silent --show-error --fail \
|
|
+ -X PUT \
|
|
+ --header "Accept: text/plain" \
|
|
+ --header "Authorization: X-ApiKey $HACKAGE_API_KEY" \
|
|
+ --header "Content-Type: application/x-tar" \
|
|
+ --header "Content-Encoding: gzip" \
|
|
+ --data-binary @"${GITHUB_WORKSPACE}/haddock/${PACKAGE_NAME}-${PACKAGE_VERSION}-docs.tar.gz" \
|
|
+ https://hackage.haskell.org/package/${PACKAGE_NAME}-${PACKAGE_VERSION}/candidate/docs
|
|
+ env:
|
|
+ HACKAGE_API_KEY: ${{ secrets.HACKAGE_API_KEY }}
|
|
+ PACKAGE_NAME: ${{ github.event.repository.name }}
|
|
+ PACKAGE_VERSION: ${{ github.event.inputs.version }}
|
|
+ - name: hackage upload (release)
|
|
+ if: matrix.upload && github.event_name == 'release'
|
|
+ run: |
|
|
+ set -ex
|
|
+ PACKAGE_VERSION="${PACKAGE_VERSION#v}"
|
|
+ curl \
|
|
+ --silent --show-error --fail \
|
|
+ --header "Accept: text/plain" \
|
|
+ --header "Authorization: X-ApiKey $HACKAGE_API_KEY" \
|
|
+ --form package=@"${GITHUB_WORKSPACE}/sdist/${PACKAGE_NAME}-${PACKAGE_VERSION}.tar.gz" \
|
|
+ https://hackage.haskell.org/packages/
|
|
+ curl \
|
|
+ --silent --show-error --fail \
|
|
+ -X PUT \
|
|
+ --header "Accept: text/plain" \
|
|
+ --header "Authorization: X-ApiKey $HACKAGE_API_KEY" \
|
|
+ --header "Content-Type: application/x-tar" \
|
|
+ --header "Content-Encoding: gzip" \
|
|
+ --data-binary @"${GITHUB_WORKSPACE}/haddock/${PACKAGE_NAME}-${PACKAGE_VERSION}-docs.tar.gz" \
|
|
+ https://hackage.haskell.org/package/${PACKAGE_NAME}-${PACKAGE_VERSION}/docs
|
|
+ env:
|
|
+ HACKAGE_API_KEY: ${{ secrets.HACKAGE_API_KEY }}
|
|
+ PACKAGE_NAME: ${{ github.event.repository.name }}
|
|
+ PACKAGE_VERSION: ${{ github.event.release.tag_name }}
|