Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add auto publish workflow #1005

Open
wants to merge 3 commits into
base: refactor/develop
Choose a base branch
from
Open

feat: add auto publish workflow #1005

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d9a6c14
feat: add auto publish workflow
chilingling Jan 8, 2025
41d3a4b
fix: add verify steps
chilingling Jan 8, 2025
ec512c1
fix: shell syntax issue
chilingling Jan 8, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
79 changes: 79 additions & 0 deletions .github/workflows/Release.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,79 @@
name: Release

on:
push:
tags:
- 'v*'

jobs:
release:
if: github.repository == 'opentiny/tiny-engine'
runs-on: ubuntu-latest
permissions:
contents: write
id-token: write
steps:
- name: Checkout
uses: actions/checkout@v4

- name: Install pnpm
uses: pnpm/action-setup@v4
with:
version: 9
run_install: false

- name: Install Node.js
uses: actions/setup-node@v4
with:
node-version: 18
cache: 'pnpm'
registry-url: 'https://registry.npmjs.org'

- name: Install dependencies
run: pnpm install

- name: Run Build
run: |
pnpm run build:plugin
pnpm run build:alpha > build-alpha.log 2>&1

- name: Upload build logs
uses: actions/upload-artifact@v4
with:
name: build-alpha-log
path: build-alpha.log

- name: Parse Publish tag
id: parse_tag
run: |
tag_name="${GITHUB_REF#refs/tags/}"
if [[ "$tag_name" == *alpha* ]]; then
echo "dist_tag=alpha" >> $GITHUB_OUTPUT
elif [[ "$tag_name" == *beta* ]]; then
echo "dist_tag=beta" >> $GITHUB_OUTPUT
elif [[ "$tag_name" == *rc* ]]; then
echo "dist_tag=rc" >> $GITHUB_OUTPUT
else
echo "dist_tag=latest" >> $GITHUB_OUTPUT
fi

- name: Verify clean working directory
run: |
if [[ -n $(git status --porcelain) ]]; then
echo "Working directory is not clean"
exit 1
fi

- name: Verify package version match tag
run: |
tag_name="${GITHUB_REF#refs/tags/}"
package_version=$(pnpm lerna list --scope=@opentiny/tiny-engine --json | jq -r '.[0].version')
if [[ "$tag_name" != "v$package_version" ]]; then
echo "Tag name $tag_name does not match package version $package_version"
exit 1
fi
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

Improve shell script safety and tag validation

The shell scripts need proper quoting and additional validation:

       - name: Parse Publish tag
         id: parse_tag
         run: |
+          if [[ ! "$GITHUB_REF" =~ ^refs/tags/v ]]; then
+            echo "Error: Invalid tag format. Must start with 'v'" >&2
+            exit 1
+          fi
           tag_name="${GITHUB_REF#refs/tags/}"
           if [[ "$tag_name" == *alpha* ]]; then
-            echo "dist_tag=alpha" >> $GITHUB_OUTPUT
+            echo "dist_tag=alpha" >> "$GITHUB_OUTPUT"
           elif [[ "$tag_name" == *beta* ]]; then
-            echo "dist_tag=beta" >> $GITHUB_OUTPUT
+            echo "dist_tag=beta" >> "$GITHUB_OUTPUT"
           elif [[ "$tag_name" == *rc* ]]; then
-            echo "dist_tag=rc" >> $GITHUB_OUTPUT
+            echo "dist_tag=rc" >> "$GITHUB_OUTPUT"
           else
-            echo "dist_tag=latest" >> $GITHUB_OUTPUT
+            echo "dist_tag=latest" >> "$GITHUB_OUTPUT"
           fi
+          echo "Selected dist_tag: $(cat "$GITHUB_OUTPUT")" >&2

       - name: Verify clean working directory
         run: |
-          if [[ -n $(git status --porcelain) ]]; then
+          if [[ -n "$(git status --porcelain)" ]]; then
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
- name: Parse Publish tag
id: parse_tag
run: |
tag_name="${GITHUB_REF#refs/tags/}"
if [[ "$tag_name" == *alpha* ]]; then
echo "dist_tag=alpha" >> $GITHUB_OUTPUT
elif [[ "$tag_name" == *beta* ]]; then
echo "dist_tag=beta" >> $GITHUB_OUTPUT
elif [[ "$tag_name" == *rc* ]]; then
echo "dist_tag=rc" >> $GITHUB_OUTPUT
else
echo "dist_tag=latest" >> $GITHUB_OUTPUT
fi
- name: Verify clean working directory
run: |
if [[ -n $(git status --porcelain) ]]; then
echo "Working directory is not clean"
exit 1
fi
- name: Verify package version match tag
run: |
tag_name="${GITHUB_REF#refs/tags/}"
package_version=$(pnpm lerna list --scope=@opentiny/tiny-engine --json | jq -r '.[0].version')
if [[ "$tag_name" != "v$package_version" ]]; then
echo "Tag name $tag_name does not match package version $package_version"
exit 1
fi
- name: Parse Publish tag
id: parse_tag
run: |
if [[ ! "$GITHUB_REF" =~ ^refs/tags/v ]]; then
echo "Error: Invalid tag format. Must start with 'v'" >&2
exit 1
fi
tag_name="${GITHUB_REF#refs/tags/}"
if [[ "$tag_name" == *alpha* ]]; then
echo "dist_tag=alpha" >> "$GITHUB_OUTPUT"
elif [[ "$tag_name" == *beta* ]]; then
echo "dist_tag=beta" >> "$GITHUB_OUTPUT"
elif [[ "$tag_name" == *rc* ]]; then
echo "dist_tag=rc" >> "$GITHUB_OUTPUT"
else
echo "dist_tag=latest" >> "$GITHUB_OUTPUT"
fi
echo "Selected dist_tag: $(cat "$GITHUB_OUTPUT")" >&2
- name: Verify clean working directory
run: |
if [[ -n "$(git status --porcelain)" ]]; then
echo "Working directory is not clean"
exit 1
fi
- name: Verify package version match tag
run: |
tag_name="${GITHUB_REF#refs/tags/}"
package_version=$(pnpm lerna list --scope=@opentiny/tiny-engine --json | jq -r '.[0].version')
if [[ "$tag_name" != "v$package_version" ]]; then
echo "Tag name $tag_name does not match package version $package_version"
exit 1
fi
🧰 Tools
🪛 actionlint (1.7.4)

48-48: shellcheck reported issue in this script: SC2086:info:3:28: Double quote to prevent globbing and word splitting

(shellcheck)

48-48: shellcheck reported issue in this script: SC2086:info:5:27: Double quote to prevent globbing and word splitting

(shellcheck)

48-48: shellcheck reported issue in this script: SC2086:info:7:25: Double quote to prevent globbing and word splitting

(shellcheck)

48-48: shellcheck reported issue in this script: SC2086:info:9:29: Double quote to prevent globbing and word splitting

(shellcheck)


- name: Publish package to npm
run: pnpm lerna publish from-package --dist-tag ${{steps.parse_tag.outputs.dist_tag}} --yes
env:
NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}
Loading