Deploy Release Artifact #48
This file contains hidden or 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
| ## | |
| # Copyright (C) 2023-2024 Hedera Hashgraph, LLC | |
| # | |
| # Licensed under the Apache License, Version 2.0 (the "License"); | |
| # you may not use this file except in compliance with the License. | |
| # You may obtain a copy of the License at | |
| # | |
| # http://www.apache.org/licenses/LICENSE-2.0 | |
| # | |
| # Unless required by applicable law or agreed to in writing, software | |
| # distributed under the License is distributed on an "AS IS" BASIS, | |
| # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | |
| # See the License for the specific language governing permissions and | |
| # limitations under the License. | |
| ## | |
| name: 'Deploy Release Artifact' | |
| on: | |
| workflow_dispatch: | |
| inputs: | |
| dry-run-enabled: | |
| description: 'Perform Dry Run' | |
| type: boolean | |
| required: false | |
| default: true | |
| defaults: | |
| run: | |
| shell: bash | |
| permissions: | |
| id-token: write | |
| checks: write | |
| statuses: write | |
| pull-requests: write | |
| contents: write | |
| issues: write | |
| actions: read | |
| jobs: | |
| prepare-release: | |
| name: Release / Prepare | |
| runs-on: hiero-cli-linux-medium | |
| outputs: | |
| version: ${{ steps.set-outputs.outputs.version }} | |
| need-release: ${{ steps.set-outputs.outputs.need-release }} | |
| steps: | |
| - name: Prepare Job | |
| uses: pandaswhocode/initialize-github-job@ffb7446339e8e6007b942312ac95457d1a20b6cf # 1.0.4 | |
| with: | |
| checkout: 'true' | |
| checkout-ref: '${{ github.ref }}' | |
| checkout-token: '${{ secrets.GH_ACCESS_TOKEN }}' | |
| setup-node: 'true' | |
| node-version: '22' | |
| node-registry: 'https://registry.npmjs.org/' | |
| - name: Setup JQ | |
| uses: dcarbone/install-jq-action@b7ef57d46ece78760b4019dbc4080a1ba2a40b45 # v3.2.0 | |
| with: | |
| version: 1.7 | |
| - name: Install Semantic Release | |
| run: | | |
| npm install -g semantic-release@25.0.2 @semantic-release/git@10.0.1 @semantic-release/github@12.0.2 @semantic-release/exec@7.1.0 gradle-semantic-release-plugin@1.7.6 | |
| npm install -g conventional-changelog-conventionalcommits@9.1.0 @commitlint/cli@18.6.0 @commitlint/config-conventional@18.6.0 | |
| npm install -g marked-mangle@1.1.6 marked-gfm-heading-id@3.1.2 semantic-release-conventional-commits@3.0.0 | |
| - name: Calculate Next Version (default branch) | |
| id: calculate-version | |
| env: | |
| GITHUB_TOKEN: ${{ secrets.GH_ACCESS_TOKEN }} | |
| GIT_AUTHOR_NAME: ${{ secrets.GIT_USER_NAME }} | |
| GIT_AUTHOR_EMAIL: ${{ secrets.GIT_USER_EMAIL }} | |
| GIT_COMMITTER_NAME: ${{ secrets.GIT_USER_NAME }} | |
| GIT_COMMITTER_EMAIL: ${{ secrets.GIT_USER_EMAIL }} | |
| run: | | |
| PROCEED="true" | |
| if [[ "${{ github.event.repository.default_branch }}" == "${{ github.ref_name }}" ]]; then | |
| if SEMREL_OUTPUT=$(npx semantic-release --dry-run 2>&1); then | |
| if echo "${SEMREL_OUTPUT}" | grep -q "The next release version is"; then | |
| echo "::notice file=flow-deploy-release-artifact.yaml::Semantic Release detected a new version" | |
| else | |
| echo "::notice file=flow-deploy-release-artifact.yaml::Semantic Release detected NO new version" | |
| PROCEED="false" | |
| fi | |
| else | |
| echo "::notice file=flow-deploy-release-artifact.yaml::Semantic Release did NOT run successfully" | |
| PROCEED="false" | |
| fi | |
| echo "::group::SemVer output" | |
| echo "${SEMREL_OUTPUT}" | |
| echo "::endgroup::" | |
| else | |
| if [[ "${{ inputs.dry-run-enabled }}" == "true" ]]; then | |
| jq -r '.version' './package.json' > VERSION | |
| PROCEED="true" | |
| else | |
| PROCEED="false" | |
| fi | |
| fi | |
| echo "need-release=${PROCEED}" >> "${GITHUB_OUTPUT}" | |
| - name: Extract Version | |
| id: set-outputs | |
| if: ${{ !cancelled() && always() }} | |
| run: | | |
| PROCEED="true" | |
| OUTVER="" | |
| if [[ "${{ steps.calculate-version.outputs.need-release }}" == "true" ]] && [[ -f VERSION ]]; then | |
| cat VERSION | |
| TRIMMED_VERSION=$(cat VERSION | tr -d '[:space:]') | |
| OUTVER="${TRIMMED_VERSION}" | |
| echo "version=${TRIMMED_VERSION}" | |
| elif [[ "${{ steps.calculate-version.outputs.need-release }}" == "true" ]] && [[ "${{ inputs.dry-run-enabled }}" == "true" ]] && [[ ! -f VERSION ]]; then | |
| VER=$(jq -r '.version' './package.json') | |
| OUTVER="${VER}" | |
| echo "Dry run enabled and VERSION file not found, using package.json version: ${VER}" | |
| else | |
| PROCEED="false" | |
| fi | |
| echo "version=${OUTVER}" >> "${GITHUB_OUTPUT}" | |
| echo "need-release=${PROCEED}" >> "${GITHUB_OUTPUT}" | |
| safety-checks: | |
| name: Release | |
| uses: ./.github/workflows/zxc-compile-code.yaml | |
| with: | |
| custom-job-label: 'Safety Checks' | |
| enable-unit-tests: true | |
| enable-integration-tests: true | |
| enable-code-style-check: true | |
| secrets: | |
| integration-tests-network: ${{ secrets.INTEGRATION_TESTS_NETWORK }} | |
| integration-tests-operator-id: ${{ secrets.INTEGRATION_TESTS_OPERATOR_ID }} | |
| integration-tests-operator-key: ${{ secrets.INTEGRATION_TESTS_OPERATOR_KEY }} | |
| create-github-release: | |
| name: Github / Release | |
| if: ${{ needs.prepare-release.outputs.need-release == 'true' }} | |
| runs-on: hiero-cli-linux-medium | |
| needs: | |
| - prepare-release | |
| - safety-checks | |
| outputs: | |
| npm-artifact-name: ${{ steps.set-publish-data.outputs.artifact-name }} | |
| steps: | |
| - name: Prepare Job | |
| uses: pandaswhocode/initialize-github-job@ffb7446339e8e6007b942312ac95457d1a20b6cf # 1.0.4 | |
| with: | |
| checkout: 'true' | |
| checkout-ref: '${{ github.ref }}' | |
| checkout-token: '${{ secrets.GH_ACCESS_TOKEN }}' | |
| setup-node: 'true' | |
| node-version: '22' | |
| node-registry: 'https://registry.npmjs.org/' | |
| - name: Install GnuPG Tools | |
| run: | | |
| if ! command -v gpg2 >/dev/null 2>&1; then | |
| echo "::group::Updating APT Repository Indices" | |
| sudo apt update | |
| echo "::endgroup::" | |
| echo "::group::Installing GnuPG Tools" | |
| sudo apt install -y gnupg2 | |
| echo "::endgroup::" | |
| fi | |
| - name: Import GPG key | |
| id: gpg_key | |
| uses: step-security/ghaction-import-gpg@69c854a83c7f79463f8bdf46772ab09826c560cd # v6.3.1 | |
| with: | |
| gpg_private_key: ${{ secrets.GPG_KEY_CONTENTS }} | |
| passphrase: ${{ secrets.GPG_KEY_PASSPHRASE }} | |
| git_config_global: true | |
| git_user_signingkey: true | |
| git_commit_gpgsign: true | |
| git_tag_gpgsign: false | |
| - name: Setup JQ | |
| uses: dcarbone/install-jq-action@b7ef57d46ece78760b4019dbc4080a1ba2a40b45 # v3.2.0 | |
| with: | |
| version: 1.7 | |
| - name: Setup JFrog CLI | |
| uses: jfrog/setup-jfrog-cli@c32bf10843e4071112c4ea3abf622d3b27cd8c17 # v4.7.0 | |
| env: | |
| JF_URL: ${{ vars.JF_URL }} | |
| with: | |
| oidc-provider-name: hiero-ledger | |
| - name: Show JFrog Config | |
| run: jfrog config show | |
| - name: Verify JFrog Connectivity | |
| run: jfrog rt ping | |
| - name: Setup JFrog NPM Repository | |
| run: | | |
| jf npmc --server-id-resolve setup-jfrog-cli-server --server-id-deploy setup-jfrog-cli-server --repo-resolve hiero-cli-npm-release --repo-deploy hiero-cli-npm-release | |
| echo "::group::JFrog NPM Repository Configuration" | |
| cat .jfrog/projects/npm.yaml | |
| echo "::endgroup::" | |
| - name: Install Semantic Release | |
| run: | | |
| npm install -g semantic-release@25.0.2 @semantic-release/git@10.0.1 @semantic-release/github@12.0.2 @semantic-release/exec@7.1.0 gradle-semantic-release-plugin@1.7.6 | |
| npm install -g conventional-changelog-conventionalcommits@9.1.0 @commitlint/cli@18.6.0 @commitlint/config-conventional@18.6.0 | |
| npm install -g marked-mangle@1.1.6 marked-gfm-heading-id@3.1.2 semantic-release-conventional-commits@3.0.0 | |
| - name: Install Dependencies | |
| run: jf npm ci | |
| - name: Publish Semantic Release | |
| env: | |
| GITHUB_TOKEN: ${{ secrets.GH_ACCESS_TOKEN }} | |
| GIT_AUTHOR_NAME: ${{ secrets.GIT_USER_NAME }} | |
| GIT_AUTHOR_EMAIL: ${{ secrets.GIT_USER_EMAIL }} | |
| GIT_COMMITTER_NAME: ${{ secrets.GIT_USER_NAME }} | |
| GIT_COMMITTER_EMAIL: ${{ secrets.GIT_USER_EMAIL }} | |
| if: ${{ !cancelled() && !failure() }} | |
| run: | | |
| FLAGS="" | |
| if [[ "${{ inputs.dry-run-enabled }}" == "true" ]]; then | |
| FLAGS="--dry-run" | |
| fi | |
| npx semantic-release --no-sign ${FLAGS} | |
| if [[ -d "dist" ]]; then | |
| echo "Dist dir has the following contents:" | |
| ls dist | |
| fi | |
| - name: Update Version for Dry Run | |
| if: ${{ inputs.dry-run-enabled == 'true' }} | |
| run: | | |
| npm version ${{ needs.prepare-release.outputs.version }} --no-git-tag-version | |
| - name: Compile Code | |
| run: npm run build | |
| - name: Set Publish Data | |
| id: set-publish-data | |
| run: | | |
| VERSION=$(jq -r '.version' './package.json') | |
| CLI_NPM_PACKAGE_NAME="hiero-ledger-hiero-cli-${VERSION}.tgz" | |
| echo "artifact-name=${CLI_NPM_PACKAGE_NAME}" >> $GITHUB_OUTPUT | |
| - name: Pack Tarball | |
| run: | | |
| npm pack --pack-destination ./dist | |
| - name: Verify Package | |
| run: | | |
| EXPECTED="./dist/${{ steps.set-publish-data.outputs.artifact-name }}" | |
| if [[ ! -f "${EXPECTED}" ]]; then | |
| echo "::error::Expected package not found: ${EXPECTED}" | |
| ls -la ./dist/ | |
| exit 1 | |
| fi | |
| echo "Package verified: ${EXPECTED} ($(du -h "${EXPECTED}" | cut -f1))" | |
| # Upload the artifact | |
| - name: Upload Hiero CLI Package Artifact | |
| uses: actions/upload-artifact@b7c566a772e6b6bfb58ed0dc250532a479d7789f # v6.0.0 | |
| with: | |
| name: cli-npm-package | |
| path: ./dist/${{ steps.set-publish-data.outputs.artifact-name }} | |
| if-no-files-found: error | |
| - name: Deploy to JFrog Registry | |
| if: ${{ inputs.dry-run-enabled != 'true' && !cancelled() && !failure() }} | |
| run: jf npm publish | |
| # Add a publishing job for Hiero CLI to npmjs | |
| publish-npm-package: | |
| name: Publish Hiero CLI NPM Package | |
| if: ${{ needs.prepare-release.outputs.need-release == 'true' }} | |
| runs-on: ubuntu-latest | |
| needs: | |
| - create-github-release | |
| - prepare-release | |
| - safety-checks | |
| steps: | |
| - name: Prepare Release | |
| uses: pandaswhocode/initialize-github-job@ffb7446339e8e6007b942312ac95457d1a20b6cf # 1.0.4 | |
| with: | |
| checkout: 'true' | |
| checkout-ref: '${{ github.ref }}' | |
| checkout-token: '${{ secrets.GH_ACCESS_TOKEN }}' | |
| setup-node: 'true' | |
| node-version: '22' | |
| node-registry: 'https://registry.npmjs.org/' | |
| - name: Install NPM latest | |
| run: npm install -g npm@11.7.0 | |
| - name: Download Hiero CLI NPM Package Artifact | |
| uses: actions/download-artifact@37930b1c2abaa49bbe596cd826c3c89aef350131 # v7.0.0 | |
| with: | |
| name: cli-npm-package | |
| - name: Publish Hiero CLI NPM Package | |
| run: | | |
| args="--access=public" | |
| if [[ "${{ inputs.dry-run-enabled }}" == "true" ]]; then | |
| args="${args} --dry-run" | |
| else | |
| args="${args} --provenance" | |
| fi | |
| package="${{ needs.create-github-release.outputs.npm-artifact-name }}" | |
| echo "::group::Publishing package: ${package} with args: ${args}" | |
| npm publish ${package} ${args} | |
| echo "::endgroup::" |