ci: Push docker hub description automatically on main branch #2949
Workflow file for this run
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: CI | |
| on: | |
| push: | |
| branches: | |
| - main | |
| - v[0-9]+ | |
| tags: | |
| - devel | |
| - v* | |
| concurrency: | |
| # Terminate all previous runs of the same workflow for pull requests | |
| group: ci-${{ github.head_ref || github.run_id }} | |
| cancel-in-progress: true | |
| jobs: | |
| check: | |
| name: Check | |
| uses: ./.github/workflows/check.yaml | |
| secrets: | |
| CACHIX_AUTH_TOKEN: ${{ secrets.CACHIX_AUTH_TOKEN }} | |
| docs: | |
| name: Docs | |
| uses: ./.github/workflows/docs.yaml | |
| secrets: | |
| CACHIX_AUTH_TOKEN: ${{ secrets.CACHIX_AUTH_TOKEN }} | |
| test: | |
| name: Test | |
| uses: ./.github/workflows/test.yaml | |
| secrets: | |
| CACHIX_AUTH_TOKEN: ${{ secrets.CACHIX_AUTH_TOKEN }} | |
| CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }} | |
| build: | |
| name: Build | |
| uses: ./.github/workflows/build.yaml | |
| secrets: | |
| CACHIX_AUTH_TOKEN: ${{ secrets.CACHIX_AUTH_TOKEN }} | |
| arm: | |
| name: Build / Cabal - aarch64 GHC 9.4.8 | |
| if: vars.SSH_ARM_ENABLED | |
| runs-on: ubuntu-22.04 | |
| outputs: | |
| remotepath: ${{ steps.Remote-Dir.outputs.remotepath }} | |
| env: | |
| GITHUB_COMMIT: ${{ github.sha }} | |
| GHC_VERSION: '9.4.8' | |
| steps: | |
| - uses: actions/checkout@0ad4b8fadaa221de15dcec353f45205ec38ea70b # v4.1.4 | |
| - id: Remote-Dir | |
| name: Unique directory name for the remote build | |
| run: echo "remotepath=postgrest-build-$(uuidgen)" >> "$GITHUB_OUTPUT" | |
| - name: Copy script files to the remote server | |
| uses: appleboy/scp-action@master | |
| with: | |
| host: ${{ secrets.SSH_ARM_HOST }} | |
| username: ubuntu | |
| key: ${{ secrets.SSH_ARM_PRIVATE_KEY }} | |
| fingerprint: ${{ secrets.SSH_ARM_FINGERPRINT }} | |
| source: ".github/scripts/arm/*" | |
| target: ${{ steps.Remote-Dir.outputs.remotepath }} | |
| strip_components: 3 | |
| - name: Build ARM | |
| uses: appleboy/ssh-action@master | |
| env: | |
| REMOTE_DIR: ${{ steps.Remote-Dir.outputs.remotepath }} | |
| with: | |
| host: ${{ secrets.SSH_ARM_HOST }} | |
| username: ubuntu | |
| key: ${{ secrets.SSH_ARM_PRIVATE_KEY }} | |
| fingerprint: ${{ secrets.SSH_ARM_FINGERPRINT }} | |
| command_timeout: 120m | |
| script_stop: true | |
| envs: GITHUB_COMMIT,REMOTE_DIR,GHC_VERSION | |
| script: bash ~/$REMOTE_DIR/build.sh "$GITHUB_COMMIT" "$REMOTE_DIR" "GHC_VERSION" | |
| - name: Download binaries from remote server | |
| uses: nicklasfrahm/scp-action@main | |
| with: | |
| direction: download | |
| host: ${{ secrets.SSH_ARM_HOST }} | |
| username: ubuntu | |
| key: ${{ secrets.SSH_ARM_PRIVATE_KEY }} | |
| fingerprint: ${{ secrets.SSH_ARM_FINGERPRINT }} | |
| source: "${{ steps.Remote-Dir.outputs.remotepath }}/result.tar.xz" | |
| target: "result.tar.xz" | |
| - name: Extract downloaded binaries | |
| run: tar -xvf result.tar.xz && rm result.tar.xz | |
| - name: Save aarch64 executable as artifact | |
| uses: actions/upload-artifact@65462800fd760344b1a7b4382951275a0abb4808 # v4.3.3 | |
| with: | |
| name: postgrest-ubuntu-aarch64 | |
| path: result/postgrest | |
| if-no-files-found: error | |
| tag: | |
| name: Release / Tag | |
| if: | | |
| startsWith(github.ref, 'refs/heads/') && | |
| needs.docs.result == 'success' && | |
| needs.test.result == 'success' && | |
| needs.build.result == 'success' && | |
| (needs.arm.result == 'skipped' || success()) | |
| permissions: | |
| contents: write | |
| runs-on: ubuntu-22.04 | |
| needs: | |
| - docs | |
| - test | |
| - build | |
| - arm | |
| steps: | |
| - uses: actions/checkout@0ad4b8fadaa221de15dcec353f45205ec38ea70b # v4.1.4 | |
| with: | |
| ssh-key: ${{ secrets.POSTGREST_SSH_KEY }} | |
| - name: Tag latest commit | |
| run: | | |
| cabal_version="$(grep -oP '^version:\s*\K.*' postgrest.cabal)" | |
| if [[ "$cabal_version" == *.*.* ]]; then | |
| if [ -z "$(git tag --list "v$cabal_version")" ]; then | |
| git tag "v$cabal_version" | |
| git push origin "v$cabal_version" | |
| fi | |
| else | |
| git tag -f "devel" | |
| git push -f origin "devel" | |
| fi | |
| prepare: | |
| name: Release / Prepare | |
| if: | | |
| startsWith(github.ref, 'refs/tags/') && | |
| needs.docs.result == 'success' && | |
| needs.test.result == 'success' && | |
| needs.build.result == 'success' && | |
| (needs.arm.result == 'skipped' || success()) | |
| runs-on: ubuntu-22.04 | |
| needs: | |
| - docs | |
| - test | |
| - build | |
| - arm | |
| steps: | |
| - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4 | |
| - name: Check the version to be released | |
| run: | | |
| cabal_version="$(grep -oP '^version:\s*\K.*' postgrest.cabal)" | |
| if [ "${GITHUB_REF_NAME}" != "devel" ] && [ "${GITHUB_REF_NAME}" != "v$cabal_version" ]; then | |
| echo "Tagged version ($GITHUB_REF_NAME) does not match the one in postgrest.cabal (v$cabal_version). Aborting release..." | |
| exit 1 | |
| fi | |
| - name: Identify changes from CHANGELOG.md | |
| run: | | |
| if [ "${GITHUB_REF_NAME}" == "devel" ]; then | |
| echo "Getting unreleased changes..." | |
| sed -n "1,/## Unreleased/d;/## \[/q;p" CHANGELOG.md > CHANGES.md | |
| else | |
| echo "Full release (no '-' in version), getting changes for version $version ..." | |
| sed -n "1,/## \[$version\]/d;/## \[/q;p" CHANGELOG.md > CHANGES.md | |
| fi | |
| echo "Relevant extract from CHANGELOG.md:" | |
| cat CHANGES.md | |
| - name: Save CHANGES.md as artifact | |
| uses: actions/upload-artifact@65462800fd760344b1a7b4382951275a0abb4808 # v4.3.3 | |
| with: | |
| name: release-changes | |
| path: CHANGES.md | |
| if-no-files-found: error | |
| github: | |
| name: Release / GitHub | |
| permissions: | |
| contents: write | |
| runs-on: ubuntu-22.04 | |
| needs: | |
| - prepare | |
| if: success() || needs.prepare.result == 'success' | |
| steps: | |
| - uses: actions/checkout@0ad4b8fadaa221de15dcec353f45205ec38ea70b # v4.1.4 | |
| - name: Download all artifacts | |
| uses: actions/download-artifact@65a9edc5881444af0b9093a5e628f2fe47ea3b2e # v4.1.7 | |
| with: | |
| path: artifacts | |
| - name: Create release bundle with archives for all builds | |
| run: | | |
| find artifacts -type f -iname postgrest -exec chmod +x {} \; | |
| mkdir -p release-bundle | |
| tar cJvf "release-bundle/postgrest-${GITHUB_REF_NAME}-linux-static-x64.tar.xz" \ | |
| -C artifacts/postgrest-linux-static-x64 postgrest | |
| tar cJvf "release-bundle/postgrest-${GITHUB_REF_NAME}-macos-x64.tar.xz" \ | |
| -C artifacts/postgrest-macos-x64 postgrest | |
| tar cJvf "release-bundle/postgrest-${GITHUB_REF_NAME}-freebsd-x64.tar.xz" \ | |
| -C artifacts/postgrest-freebsd-x64 postgrest | |
| tar cJvf "release-bundle/postgrest-${GITHUB_REF_NAME}-ubuntu-aarch64.tar.xz" \ | |
| -C artifacts/postgrest-ubuntu-aarch64 postgrest | |
| zip "release-bundle/postgrest-${GITHUB_REF_NAME}-windows-x64.zip" \ | |
| artifacts/postgrest-windows-x64/postgrest.exe | |
| - name: Save release bundle | |
| uses: actions/upload-artifact@65462800fd760344b1a7b4382951275a0abb4808 # v4.3.3 | |
| with: | |
| name: release-bundle | |
| path: release-bundle | |
| if-no-files-found: error | |
| - name: Publish release on GitHub | |
| env: | |
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
| run: | | |
| echo "Releasing version ${GITHUB_REF_NAME} on GitHub..." | |
| if [ "${GITHUB_REF_NAME}" == "devel" ]; then | |
| gh release edit "${GITHUB_REF_NAME}" \ | |
| -t "${GITHUB_REF_NAME}" \ | |
| --verify-tag \ | |
| -F artifacts/release-changes/CHANGES.md \ | |
| --prerelease \ | |
| release-bundle/* | |
| else | |
| gh release create "${GITHUB_REF_NAME}" \ | |
| -t "${GITHUB_REF_NAME}" \ | |
| --verify-tag \ | |
| -F artifacts/release-changes/CHANGES.md \ | |
| release-bundle/* | |
| fi | |
| docker: | |
| name: Release / Docker Hub | |
| runs-on: ubuntu-22.04 | |
| needs: | |
| - prepare | |
| if: | | |
| vars.DOCKER_REPO && vars.DOCKER_USER && | |
| (success() || needs.prepare.result == 'success') | |
| env: | |
| DOCKER_REPO: ${{ vars.DOCKER_REPO }} | |
| DOCKER_USER: ${{ vars.DOCKER_USER }} | |
| DOCKER_PASS: ${{ secrets.DOCKER_PASS }} | |
| steps: | |
| - uses: actions/checkout@0ad4b8fadaa221de15dcec353f45205ec38ea70b # v4.1.4 | |
| - name: Setup Nix Environment | |
| uses: ./.github/actions/setup-nix | |
| with: | |
| authToken: '${{ secrets.CACHIX_AUTH_TOKEN }}' | |
| tools: release.dockerHubDescription.bin | |
| - name: Download Docker image | |
| uses: actions/download-artifact@65a9edc5881444af0b9093a5e628f2fe47ea3b2e # v4.1.7 | |
| with: | |
| name: postgrest-docker-x64 | |
| - name: Publish images on Docker Hub | |
| run: | | |
| docker login -u "$DOCKER_USER" -p "$DOCKER_PASS" | |
| docker load -i postgrest-docker.tar.gz | |
| docker tag postgrest:latest "$DOCKER_REPO/postgrest:${GITHUB_REF_NAME}" | |
| docker push "$DOCKER_REPO/postgrest:${GITHUB_REF_NAME}" | |
| # Only tag 'latest' for full releases | |
| if [ "${GITHUB_REF_NAME}" != "devel" ]; then | |
| echo "Pushing to 'latest' tag for full release of ${GITHUB_REF_NAME} ..." | |
| docker tag postgrest:latest "$DOCKER_REPO"/postgrest:latest | |
| docker push "$DOCKER_REPO"/postgrest:latest | |
| else | |
| echo "Skipping push to 'latest' tag for pre-release..." | |
| fi | |
| docker-description: | |
| name: Release / Docker Hub Description | |
| runs-on: ubuntu-22.04 | |
| if: | | |
| vars.DOCKER_REPO && vars.DOCKER_USER && | |
| github.ref == 'refs/tags/devel' | |
| steps: | |
| - uses: actions/checkout@0ad4b8fadaa221de15dcec353f45205ec38ea70b # v4.1.4 | |
| - uses: peter-evans/dockerhub-description@e98e4d1628a5f3be2be7c231e50981aee98723ae # v4.0.0 | |
| with: | |
| username: ${{ vars.DOCKER_USER }} | |
| password: ${{ secrets.DOCKER_PASS }} | |
| repository: ${{ vars.DOCKER_REPO }}/postgrest | |
| short-description: ${{ github.event.repository.description }} | |
| readme-filepath: ./nix/tools/release/docker-hub-full-description.md | |
| docker-arm: | |
| name: Release / Docker Hub Arm | |
| runs-on: ubuntu-22.04 | |
| needs: | |
| - arm | |
| - docker | |
| env: | |
| GITHUB_COMMIT: ${{ github.sha }} | |
| DOCKER_REPO: postgrest | |
| DOCKER_USER: stevechavez | |
| DOCKER_PASS: ${{ secrets.DOCKER_PASS }} | |
| steps: | |
| - uses: actions/checkout@0ad4b8fadaa221de15dcec353f45205ec38ea70b # v4.1.4 | |
| - name: Publish images for ARM builds on Docker Hub | |
| uses: appleboy/ssh-action@master | |
| env: | |
| REMOTE_DIR: ${{ needs.arm.outputs.remotepath }} | |
| with: | |
| host: ${{ secrets.SSH_ARM_HOST }} | |
| username: ubuntu | |
| key: ${{ secrets.SSH_ARM_PRIVATE_KEY }} | |
| fingerprint: ${{ secrets.SSH_ARM_FINGERPRINT }} | |
| script_stop: true | |
| envs: GITHUB_COMMIT,DOCKER_REPO,DOCKER_USER,DOCKER_PASS,REMOTE_DIR,GITHUB_REF_NAME | |
| script: bash ~/$REMOTE_DIR/docker-publish.sh "$GITHUB_COMMIT" "$DOCKER_REPO" "$DOCKER_USER" "$DOCKER_PASS" "$REMOTE_DIR" "$GITHUB_REF_NAME" | |
| clean-arm: | |
| name: Build / Cleanup | |
| needs: | |
| - arm | |
| - docker-arm | |
| if: ${{ always() && vars.SSH_ARM_ENABLED }} | |
| runs-on: ubuntu-22.04 | |
| env: | |
| REMOTE_DIR: ${{ needs.arm.outputs.remotepath }} | |
| steps: | |
| - uses: actions/checkout@0ad4b8fadaa221de15dcec353f45205ec38ea70b # v4.1.4 | |
| - name: Remove uploaded files from server | |
| uses: appleboy/ssh-action@master | |
| with: | |
| host: ${{ secrets.SSH_ARM_HOST }} | |
| username: ubuntu | |
| key: ${{ secrets.SSH_ARM_PRIVATE_KEY }} | |
| fingerprint: ${{ secrets.SSH_ARM_FINGERPRINT }} | |
| envs: REMOTE_DIR | |
| script: rm -rf $REMOTE_DIR |