release-publish #1
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
| # When a release tag is pushed, create and publish operator images on GitHub | |
| # Registry. Then generate a release on GitHub. | |
| name: release-publish | |
| on: | |
| push: | |
| tags: | |
| - v* | |
| env: | |
| GOLANG_VERSION: "1.21.x" | |
| CNPG_IMAGE_NAME: "ghcr.io/${{ github.repository }}" | |
| permissions: | |
| contents: write | |
| packages: write | |
| jobs: | |
| release: | |
| name: Create Github release | |
| runs-on: ubuntu-22.04 | |
| steps: | |
| - | |
| name: Checkout | |
| uses: actions/checkout@v4 | |
| - | |
| name: Get tag | |
| run: | | |
| tag="${GITHUB_REF#refs/tags/v}" | |
| version="${tag#v}" | |
| file=$(echo ${version} | awk -F '[.]' '{print "release_notes/v"$1"."$2".md"}') | |
| echo "TAG=${tag}" >> $GITHUB_ENV | |
| echo "VERSION=${version}" >> $GITHUB_ENV | |
| echo "FILE=${file}" >> $GITHUB_ENV | |
| - | |
| name: Generate release notes | |
| run: | | |
| docker run --rm -v $(pwd):/src mist/submark \ | |
| submark -O --h2 "Version ${{ env.TAG }}" \ | |
| --out-file /src/release_notes.md \ | |
| /src/docs/src/${{ env.FILE }} | |
| - | |
| name: Release | |
| uses: softprops/action-gh-release@v1 | |
| with: | |
| body_path: release_notes.md | |
| draft: false | |
| name: Release ${{ env.TAG }} | |
| files: releases/cnpg-${{ env.VERSION }}.yaml | |
| env: | |
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
| release-binaries: | |
| name: Build containers | |
| runs-on: ubuntu-22.04 | |
| outputs: | |
| version: ${{ steps.build-meta.outputs.version }} | |
| digest: ${{ steps.build.outputs.digest }} | |
| platforms: ${{ env.PLATFORMS }} | |
| steps: | |
| - | |
| name: Checkout | |
| uses: actions/checkout@v4 | |
| with: | |
| # To identify the commit we need the history and all the tags. | |
| fetch-depth: 0 | |
| - | |
| name: Install Go | |
| uses: actions/setup-go@v5 | |
| with: | |
| go-version: ${{ env.GOLANG_VERSION }} | |
| check-latest: true | |
| - | |
| name: Build meta | |
| id: build-meta | |
| run: | | |
| images='ghcr.io/cloudnative-pg/cloudnative-pg' | |
| images="${images},ghcr.io/cloudnative-pg/cloudnative-pg-testing" | |
| commit_sha=${{ github.sha }} | |
| commit_date=$(git log -1 --pretty=format:'%ad' --date short "${commit_sha}") | |
| tag="${GITHUB_REF#refs/tags/v}" | |
| skip_krew="false" | |
| latest_release_branch=$(git branch -rl 'origin/release-*' | sort -r | head -n1 | sed -e 's/^.*\(release-.*\)/\1/') | |
| current_release_branch=$(echo "${tag}" | sed -e 's/\([0-9]\+.[0-9]\+\).*/release-\1/') | |
| if [[ "$latest_release_branch" != "$current_release_branch" ]]; then | |
| skip_krew="true" | |
| fi | |
| # use git describe to get the nearest tag and use that to build the version (e.g. 1.4.0-dev24 or 1.4.0) | |
| commit_version=$(git describe --tags --match 'v*' "${commit_sha}"| sed -e 's/^v//; s/-g[0-9a-f]\+$//; s/-\([0-9]\+\)$/-dev\1/') | |
| commit_short=$(git rev-parse --short "${commit_sha}") | |
| echo "IMAGES=${images}" >> $GITHUB_ENV | |
| echo "DATE=${commit_date}" >> $GITHUB_ENV | |
| echo "version=${commit_version}" >> $GITHUB_OUTPUT | |
| echo "COMMIT=${commit_short}" >> $GITHUB_ENV | |
| echo "SKIP_KREW=${skip_krew}" >> $GITHUB_ENV | |
| - | |
| name: Import GPG key | |
| id: import_gpg | |
| uses: crazy-max/ghaction-import-gpg@v6 | |
| with: | |
| gpg_private_key: ${{ secrets.GPG_PRIVATE_KEY }} | |
| passphrase: ${{ secrets.GPG_PASSPHRASE }} | |
| - | |
| name: Set GoReleaser environment | |
| run: | | |
| echo GOPATH=$(go env GOPATH) >> $GITHUB_ENV | |
| echo PWD=$(pwd) >> $GITHUB_ENV | |
| - | |
| name: Run GoReleaser | |
| uses: goreleaser/goreleaser-action@v5 | |
| with: | |
| distribution: goreleaser | |
| version: latest | |
| args: release --rm-dist --timeout 60m | |
| env: | |
| DATE: ${{ env.DATE }} | |
| COMMIT: ${{ env.COMMIT }} | |
| VERSION: ${{ steps.build-meta.outputs.version }} | |
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
| GPG_FINGERPRINT: ${{ steps.import_gpg.outputs.fingerprint }} | |
| - | |
| name: Publish Krew | |
| if: ${{ env.SKIP_KREW == 'false' }} | |
| uses: rajatjindal/[email protected] | |
| with: | |
| krew_template_file: dist/krew/cnpg.yaml | |
| - | |
| name: Docker meta | |
| id: docker-meta | |
| uses: docker/metadata-action@v5 | |
| with: | |
| images: ${{ env.IMAGES }} | |
| tags: | | |
| type=semver,pattern={{version}} | |
| - | |
| name: Docker meta UBI8 | |
| id: docker-meta-ubi8 | |
| uses: docker/metadata-action@v5 | |
| with: | |
| images: ${{ env.IMAGES }} | |
| flavor: | | |
| suffix=-ubi8 | |
| tags: | | |
| type=semver,pattern={{version}} | |
| - | |
| name: Detect platforms | |
| run: | | |
| # Keep in mind that adding more platforms (architectures) will increase the building | |
| # time even if we use the ghcache for the building process. | |
| platforms="linux/amd64,linux/arm64" | |
| echo "PLATFORMS=${platforms}" >> $GITHUB_ENV | |
| - | |
| name: Set up QEMU | |
| uses: docker/setup-qemu-action@v3 | |
| with: | |
| platforms: ${{ env.PLATFORMS }} | |
| - | |
| name: Set up Docker Buildx | |
| uses: docker/setup-buildx-action@v3 | |
| - | |
| name: Login to ghcr.io | |
| uses: docker/login-action@v3 | |
| with: | |
| registry: ghcr.io | |
| username: ${{ github.actor }} | |
| password: ${{ secrets.GITHUB_TOKEN }} | |
| - | |
| name: Build and push | |
| uses: docker/build-push-action@v5 | |
| with: | |
| platforms: ${{ env.PLATFORMS }} | |
| context: . | |
| push: true | |
| build-args: | | |
| VERSION=${{ steps.build-meta.outputs.version }} | |
| tags: ${{ steps.docker-meta.outputs.tags }} | |
| - | |
| name: Build and push UBI8 | |
| uses: docker/build-push-action@v5 | |
| with: | |
| platforms: ${{ env.PLATFORMS }} | |
| context: . | |
| file: Dockerfile-ubi8 | |
| push: true | |
| build-args: | | |
| VERSION=${{ steps.build-meta.outputs.version }} | |
| tags: ${{ steps.docker-meta-ubi8.outputs.tags }} | |
| olm-bundle: | |
| name: Create OLM bundle and catalog | |
| runs-on: ubuntu-22.04 | |
| needs: | |
| - release-binaries | |
| if: | | |
| (always() && !cancelled()) && | |
| needs.release-binaries.result == 'success' | |
| steps: | |
| - name: Checkout code | |
| uses: actions/checkout@v4 | |
| with: | |
| fetch-depth: 0 | |
| - name: Set up QEMU | |
| uses: docker/setup-qemu-action@v3 | |
| with: | |
| platforms: ${{ needs.release-binaries.outputs.platforms }} | |
| - name: Install Go | |
| uses: actions/setup-go@v5 | |
| with: | |
| go-version: ${{ env.GOLANG_VERSION }} | |
| check-latest: true | |
| - name: Set up Docker Buildx | |
| uses: docker/setup-buildx-action@v3 | |
| - name: Login to ghcr.io | |
| uses: docker/login-action@v3 | |
| with: | |
| registry: ghcr.io | |
| username: ${{ github.actor }} | |
| password: ${{ secrets.GITHUB_TOKEN }} | |
| - name: Set bundle variables | |
| run: | | |
| tag="${GITHUB_REF#refs/tags/v}" | |
| version="${tag#v}" | |
| LOWERCASE_CNPG_IMAGE_NAME=${CNPG_IMAGE_NAME,,} | |
| echo "IMAGE_NAME=${LOWERCASE_CNPG_IMAGE_NAME}" >> $GITHUB_ENV | |
| echo "CONTROLLER_IMG=${LOWERCASE_CNPG_IMAGE_NAME}:${version}-ubi8" >> $GITHUB_ENV | |
| echo "BUNDLE_IMG=${LOWERCASE_CNPG_IMAGE_NAME}:bundle-${version}" >> $GITHUB_ENV | |
| - name: Create bundle | |
| env: | |
| IMAGE_NAME: ${{ env.IMAGE_NAME }} | |
| CONTROLLER_IMG: ${{ env.CONTROLLER_IMG }} | |
| BUNDLE_IMG: ${{ env.BUNDLE_IMG }} | |
| run: | | |
| make olm-catalog | |
| - name: Archive the bundle manifests | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| name: bundle | |
| path: | | |
| bundle.Dockerfile | |
| bundle/ | |
| cloudnative-pg-catalog.yaml | |
| operatorhub_pr: | |
| name: Create remote PR for OperatorHub | |
| runs-on: ubuntu-22.04 | |
| needs: | |
| - release-binaries | |
| - olm-bundle | |
| if: | | |
| (always() && !cancelled()) && | |
| needs.olm-bundle.result == 'success' | |
| env: | |
| VERSION: ${{ needs.release-binaries.outputs.version }} | |
| steps: | |
| - name: Checkout community-operators | |
| uses: actions/checkout@v4 | |
| with: | |
| repository: k8s-operatorhub/community-operators | |
| fetch-depth: 0 | |
| persist-credentials: false | |
| - name: Download the bundle | |
| uses: actions/download-artifact@v4 | |
| with: | |
| name: bundle | |
| - name: Copy bundle in the community-operators | |
| run: | | |
| mkdir -p "operators/cloudnative-pg/${{ env.VERSION }}" | |
| cp -R bundle/* "operators/cloudnative-pg/${{ env.VERSION }}" | |
| rm -fr cloudnative-pg-catalog.yaml bundle.Dockerfile *.zip bundle/ | |
| - name: Create Remote Pull Request | |
| uses: peter-evans/create-pull-request@v5 | |
| with: | |
| token: ${{ secrets.REPO_GHA_PAT }} | |
| commit-message: "operator cloudnative-pg (${{ env.VERSION }})" | |
| title: "operator cloudnative-pg (${{ env.VERSION }})" | |
| signoff: true | |
| branch: release-cloudnativepg-${{ env.VERSION }} | |
| delete-branch: true | |
| push-to-fork: cloudnative-pg/community-operators | |
| body: | | |
| Thanks submitting your Operator. Please check below list before you create your Pull Request. | |
| ### Updates to existing Operators | |
| * [x] Did you create a `ci.yaml` file according to the [update instructions](https://github.com/operator-framework/community-operators/blob/master/docs/operator-ci-yaml.md)? | |
| * [x] Is your new CSV pointing to the previous version with the `replaces` property if you chose `replaces-mode` via the `updateGraph` property in `ci.yaml`? | |
| * [x] Is your new CSV referenced in the [appropriate channel](https://github.com/operator-framework/community-operators/blob/master/docs/packaging-operator.md#channels) defined in the `package.yaml` or `annotations.yaml` ? | |
| * [x] Have you tested an update to your Operator when deployed via OLM? | |
| * [x] Is your submission [signed](https://github.com/operator-framework/community-operators/blob/master/docs/contributing-prerequisites.md#sign-your-work)? | |
| ### Your submission should not | |
| * [x] Modify more than one operator | |
| * [x] Modify an Operator you don't own | |
| * [x] Rename an operator - please remove and add with a different name instead | |
| * [x] Modify any files outside the above mentioned folders | |
| * [x] Contain more than one commit. **Please squash your commits.** | |
| ### Operator Description must contain (in order) | |
| 1. [x] Description about the managed Application and where to find more information | |
| 2. [x] Features and capabilities of your Operator and how to use it | |
| 3. [x] Any manual steps about potential pre-requisites for using your Operator | |
| ### Operator Metadata should contain | |
| * [x] Human readable name and 1-liner description about your Operator | |
| * [x] Valid [category name](https://github.com/operator-framework/community-operators/blob/master/docs/packaging-operator.md#categories)<sup>1</sup> | |
| * [x] One of the pre-defined [capability levels](https://github.com/operator-framework/operator-courier/blob/4d1a25d2c8d52f7de6297ec18d8afd6521236aa2/operatorcourier/validate.py#L556)<sup>2</sup> | |
| * [x] Links to the maintainer, source code and documentation | |
| * [x] Example templates for all Custom Resource Definitions intended to be used | |
| * [x] A quadratic logo | |
| Remember that you can preview your CSV [here](https://operatorhub.io/preview). | |
| -- | |
| <sup>1</sup> If you feel your Operator does not fit any of the pre-defined categories, file an issue against this repo and explain your need | |
| <sup>2</sup> For more information see [here](https://sdk.operatorframework.io/docs/overview/#operator-capability-level) |