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 1 commit
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
55 changes: 55 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,55 @@
name: Release

on:
push:
tags:
- 'v*'

jobs:
release:
if: github.repository == '@opentiny/tiny-engine'
chilingling marked this conversation as resolved.
Show resolved Hide resolved
runs-on: ubuntu-latest
permissions:
contents: write
id-token: write
steps:
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

Add concurrency control to prevent parallel releases

Consider adding concurrency control to prevent multiple release workflows from running simultaneously, which could lead to race conditions.

 jobs:
   release:
+    concurrency: release-${{ github.ref }}
     if: github.repository == 'opentiny/tiny-engine'
     runs-on: ubuntu-latest
     permissions:
       contents: write
       id-token: write
📝 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
jobs:
release:
if: github.repository == '@opentiny/tiny-engine'
runs-on: ubuntu-latest
permissions:
contents: write
id-token: write
steps:
jobs:
release:
concurrency: release-${{ github.ref }}
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

Comment on lines +35 to +37
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 build step error handling and logging

The build step has two potential improvements:

  1. The second build command will run even if the first fails
  2. The build log should be saved as an artifact for debugging
       - name: Run Build
-        run: pnpm run build:plugin && pnpm run build:alpha > build-alpha.log 2>&1
+        run: |
+          pnpm run build:plugin
+          pnpm run build:alpha > build-alpha.log 2>&1
+
+      - name: Upload build logs
+        if: always()
+        uses: actions/upload-artifact@v3
+        with:
+          name: build-logs
+          path: build-alpha.log
📝 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: Run Build
run: pnpm run build:plugin && pnpm run build:alpha > build-alpha.log 2>&1
- name: Run Build
run: |
pnpm run build:plugin
pnpm run build:alpha > build-alpha.log 2>&1
- name: Upload build logs
if: always()
uses: actions/upload-artifact@v3
with:
name: build-logs
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

chilingling marked this conversation as resolved.
Show resolved Hide resolved
- name: Publish package to npm
run: pnpm lerna publish from-package --pre-dist-tag ${{steps.parse_tag.outputs.dist_tag}} --yes
env:
NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}
chilingling marked this conversation as resolved.
Show resolved Hide resolved
Loading