Update documentation to include references to docs layers. #14
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: Release with Platform builds | |
| on: | |
| workflow_dispatch: | |
| inputs: | |
| skip_signing: | |
| description: 'Skip code signing' | |
| required: true | |
| default: false | |
| type: boolean | |
| release_tag: | |
| description: 'Release tag' | |
| required: true | |
| type: string | |
| push: | |
| tags: | |
| - 'v*' | |
| permissions: | |
| contents: write | |
| pull-requests: write | |
| jobs: | |
| build-macos: | |
| runs-on: macos-latest | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7 | |
| ## install build dependencies for frontend generation | |
| - name: Install Node.js | |
| uses: actions/setup-node@60edb5dd545a775178f52524783378180af0d1f8 # v4.0.2 | |
| with: | |
| node-version-file: './frontend/dev-mode/.nvmrc' | |
| - name: Install pnpm | |
| uses: pnpm/action-setup@fe02b34f77f8bc703788d5817da081398fad5dd2 # v4.0.0 | |
| with: | |
| version: 8.0.0 | |
| - name: Setup Go | |
| uses: actions/setup-go@cdcb36043654635271a94b9a6d1392de5bb323a7 # v5.0.1 | |
| with: | |
| go-version-file: 'go.mod' | |
| - name: Import Apple Code Signing Certificates | |
| if: ${{ github.event_name != 'workflow_dispatch' || !inputs.skip_signing }} | |
| uses: Apple-Actions/import-codesign-certs@63fff01cd422d4b7b855d40ca1e9d34d2de9427d # v3.0.0 | |
| with: | |
| p12-file-base64: ${{ secrets.APPLE_CERTIFICATE_BASE64 }} | |
| p12-password: ${{ secrets.APPLE_CERTIFICATE_PASSWORD }} | |
| - name: Run GoReleaser | |
| uses: goreleaser/goreleaser-action@5742e2a039330cbb23ebf35f046f814d4c6ff811 # v5.0.0 | |
| with: | |
| version: latest | |
| distribution: goreleaser | |
| args: release --clean --snapshot --config ./.goreleaser.darwin.yaml | |
| env: | |
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
| APPLE_DEVELOPER_ID: ${{ secrets.APPLICATION_IDENTITY}} | |
| APPLE_ID: ${{ vars.APPLE_ID }} | |
| APPLE_ID_PASSWORD: ${{ secrets.APPLE_ID_PASSWORD}} | |
| APPLE_TEAM_ID: ${{ secrets.APPLE_TEAM_ID}} | |
| - name: Notarize the macOS binary | |
| env: | |
| APPLE_DEVELOPER_ID: ${{ secrets.APPLICATION_IDENTITY}} | |
| APPLE_ID: ${{ vars.APPLE_ID }} | |
| APPLE_ID_PASSWORD: ${{ secrets.APPLE_ID_PASSWORD}} | |
| APPLE_TEAM_ID: ${{ secrets.APPLE_TEAM_ID}} | |
| shell: bash | |
| run: | | |
| ./build/scripts/sign ./dist/kitops-darwin-arm64.zip | |
| ./build/scripts/sign ./dist/kitops-darwin-x86_64.zip | |
| - name: Upload macOS artifacts | |
| uses: actions/upload-artifact@0b2256b8c012f0828dc542b3febcab082c67f72b # v4.3.4 | |
| with: | |
| name: dist-macos | |
| if-no-files-found: error | |
| retention-days: 7 | |
| path: | | |
| ./dist/*.zip | |
| build-windows: | |
| runs-on: windows-latest | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7 | |
| - name: Setup Go | |
| uses: actions/setup-go@cdcb36043654635271a94b9a6d1392de5bb323a7 # v5.0.1 | |
| with: | |
| go-version-file: 'go.mod' | |
| - name: Run GoReleaser | |
| uses: goreleaser/goreleaser-action@5742e2a039330cbb23ebf35f046f814d4c6ff811 # v5.0.0 | |
| with: | |
| version: latest | |
| distribution: goreleaser | |
| args: release --clean --snapshot --config ./.goreleaser.windows.yaml | |
| env: | |
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
| - name: Upload Windows artifacts | |
| uses: actions/upload-artifact@0b2256b8c012f0828dc542b3febcab082c67f72b # v4.3.4 | |
| with: | |
| name: dist-windows | |
| if-no-files-found: error | |
| retention-days: 7 | |
| path: | | |
| ./dist/*.zip | |
| build-linux: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7 | |
| - name: Setup Go | |
| uses: actions/setup-go@cdcb36043654635271a94b9a6d1392de5bb323a7 # v5.0.1 | |
| with: | |
| go-version-file: 'go.mod' | |
| - name: Run GoReleaser | |
| uses: goreleaser/goreleaser-action@5742e2a039330cbb23ebf35f046f814d4c6ff811 # v5.0.0 | |
| with: | |
| version: latest | |
| distribution: goreleaser | |
| args: release --clean --snapshot --config ./.goreleaser.linux.yaml | |
| env: | |
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
| - name: Upload Linux artifacts | |
| uses: actions/upload-artifact@0b2256b8c012f0828dc542b3febcab082c67f72b # v4.3.4 | |
| with: | |
| name: dist-linux | |
| if-no-files-found: error | |
| retention-days: 7 | |
| path: | | |
| ./dist/*.tar.gz | |
| # Creates a release with the artifacts from the previous steps. | |
| # workflow_dispatch triggered versions will be draft releases. | |
| # CLI docs are not updated for workflow_dispatch triggered versions. | |
| release: | |
| runs-on: ubuntu-latest | |
| needs: [build-linux, build-macos, build-windows] | |
| steps: | |
| - name: Merge built artifacts | |
| uses: actions/download-artifact@fa0a91b85d4f404e444e00e005971372dc801d16 # v4.1.3 | |
| with: | |
| path: dist | |
| pattern: dist-* | |
| merge-multiple: true | |
| - name: Create Checksums | |
| env: | |
| TAG_NAME: ${{ github.ref_name}} | |
| run: | | |
| shopt -s failglob | |
| pushd dist | |
| shasum -a 256 kitops-* > checksums.txt | |
| mv checksums.txt kitops_${TAG_NAME}_checksums.txt | |
| popd | |
| - name: Create Release | |
| env: | |
| GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
| TAG_NAME: ${{ inputs.release_tag || github.ref_name}} | |
| REPO: ${{ github.repository }} | |
| DRAFT_RELEASE: ${{ github.event_name == 'workflow_dispatch' }} | |
| run: | | |
| echo "Creating release for ${TAG_NAME}" | |
| release_args=( | |
| ${TAG_NAME} | |
| ./dist/*.* | |
| --title "Release ${TAG_NAME}" | |
| --generate-notes | |
| --repo ${REPO} | |
| ) | |
| if [[ "${DRAFT_RELEASE}" == "false" ]]; then | |
| previous_release="$(gh release list --repo $REPO --limit 1 --json tagName --jq '.[] | .tagName ')" | |
| echo "Previous release: ${previous_release}" | |
| release_args+=( --latest ) | |
| release_args+=( --verify-tag ) | |
| release_args+=( --notes-start-tag "${previous_release}" ) | |
| else | |
| release_args+=( --draft ) | |
| fi | |
| gh release create "${release_args[@]}" | |
| - name: Checkout | |
| uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7 | |
| - name: Generate CLI documentation | |
| shell: bash | |
| env: | |
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
| TAG_NAME: ${{ inputs.release_tag || github.ref_name}} | |
| run: | | |
| CURRENT_BRANCH=$(git rev-parse --abbrev-ref HEAD) | |
| PR_BRANCH="${{ github.ref_name }}-docs-update" | |
| git fetch origin main | |
| git branch "$PR_BRANCH" | |
| git checkout "$PR_BRANCH" | |
| git pull origin --ff-only "${PR_BRANCH}" || true | |
| git config --global user.name "${GITHUB_ACTOR}" | |
| git config --global user.email "${GITHUB_ACTOR_ID}+${GITHUB_ACTOR}@users.noreply.github.com" | |
| (cd docs; npm pkg set version=$TAG_NAME) | |
| ./docs/src/docs/cli/generate.sh > /dev/null | |
| git add --all | |
| git commit -m "docs: update CLI documentation for ${{ github.ref_name }}" | |
| git push origin "${PR_BRANCH}" | |
| gh pr create --fill --base main --head "${PR_BRANCH}" | |
| git checkout "${CURRENT_BRANCH}" |