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.

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

Merged
merged 3 commits into from
Jan 13, 2025

Conversation

chilingling
Copy link
Member

@chilingling chilingling commented Jan 8, 2025

English | 简体中文

PR

PR Checklist

Please check if your PR fulfills the following requirements:

  • The commit message follows our Commit Message Guidelines
  • Tests for the changes have been added (for bug fixes / features)
  • Docs have been added / updated (for bug fixes / features)
  • Built its own designer, fully self-validated

PR Type

What kind of change does this PR introduce?

  • Bugfix
  • Feature
  • Code style update (formatting, local variables)
  • Refactoring (no functional changes, no api changes)
  • Build related changes
  • CI related changes
  • Documentation content changes
  • Other... Please describe:

Background and solution

What is the current behavior?

Issue Number: N/A

What is the new behavior?

Does this PR introduce a breaking change?

  • Yes
  • No

Other information

Summary by CodeRabbit

  • Chores
    • Added automated release workflow for the repository.
    • Configured GitHub Actions to streamline package publishing process.
    • Implemented automated tag-based release and npm publication mechanism.

Copy link
Contributor

coderabbitai bot commented Jan 8, 2025

Caution

Review failed

The head commit changed during the review from 99c6540 to ec512c1.

Walkthrough

A new GitHub Actions workflow Release.yml has been created to automate the release process for the repository. The workflow is triggered when tags matching 'v*' are pushed, specifically for the @opentiny/tiny-engine repository. It sets up a comprehensive release pipeline that includes checking out code, installing dependencies, building the project, and publishing the package to npm with dynamic distribution tag selection based on the tag name.

Changes

File Change Summary
.github/workflows/Release.yml New workflow file added to automate release process with steps for checkout, dependency installation, building, and npm package publishing

Suggested labels

ospp-2024

Suggested reviewers

  • hexqi

Possibly related PRs

  • feat: add pull request base branch release/* #954: The changes in the .github/workflows/push-check.yml file involve modifications to GitHub Actions workflows, similar to the introduction of the Release.yml workflow in the main PR, indicating a focus on automating processes within GitHub Actions.

Poem

🐰 A release workflow hops into view,
Tagging versions both stable and new,
With pnpm and Node, it builds with might,
Publishing packages, oh what a delight!
Automation's magic, a rabbit's sweet dream 🚀


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@github-actions github-actions bot added enhancement New feature or request refactor-main refactor/develop branch feature labels Jan 8, 2025
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 5

🧹 Nitpick comments (1)
.github/workflows/Release.yml (1)

1-55: Consider environment-specific workflow configurations

For a more robust release process, consider:

  1. Adding environment-specific configurations (e.g., different registries for staging/production)
  2. Implementing release notes generation
  3. Adding post-publish verification steps

Example implementation:

# .github/workflows/Release.yml
env:
  RELEASE_ENV: ${{ startsWith(github.ref, 'refs/tags/v') && 'production' || 'staging' }}

# Then use conditions like:
if: env.RELEASE_ENV == 'production'

Would you like me to provide a complete implementation of these improvements?

🧰 Tools
🪛 actionlint (1.7.4)

40-40: shellcheck reported issue in this script: SC1009:info:2:1: The mentioned syntax error was in this if expression

(shellcheck)


40-40: shellcheck reported issue in this script: SC1035:error:2:4: You need a space after the [[ and before the ]]

(shellcheck)


40-40: shellcheck reported issue in this script: SC1073:error:2:4: Couldn't parse this test expression. Fix to allow more checks

(shellcheck)


40-40: shellcheck reported issue in this script: SC1020:error:2:30: You need a space before the ]]

(shellcheck)


40-40: shellcheck reported issue in this script: SC1072:error:2:30: Missing space before ]. Fix any mentioned problems and try again

(shellcheck)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between a14a508 and d9a6c14.

📒 Files selected for processing (1)
  • .github/workflows/Release.yml (1 hunks)
🧰 Additional context used
🪛 actionlint (1.7.4)
.github/workflows/Release.yml

40-40: shellcheck reported issue in this script: SC1009:info:2:1: The mentioned syntax error was in this if expression

(shellcheck)


40-40: shellcheck reported issue in this script: SC1035:error:2:4: You need a space after the [[ and before the ]]

(shellcheck)


40-40: shellcheck reported issue in this script: SC1073:error:2:4: Couldn't parse this test expression. Fix to allow more checks

(shellcheck)


40-40: shellcheck reported issue in this script: SC1020:error:2:30: You need a space before the ]]

(shellcheck)


40-40: shellcheck reported issue in this script: SC1072:error:2:30: Missing space before ]. Fix any mentioned problems and try again

(shellcheck)

⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: push-check
🔇 Additional comments (1)
.github/workflows/Release.yml (1)

16-34: LGTM! Well-configured setup steps

The setup steps are using the latest action versions and properly configured caching for optimal performance.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🧹 Nitpick comments (2)
.github/workflows/Release.yml (2)

40-45: Configure artifact retention period

Consider setting a retention period for build logs to manage storage:

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

76-79: Add error handling for npm publish

Consider adding error handling and retries for the npm publish command:

       - name: Publish package to npm
-        run: pnpm lerna publish from-package --dist-tag ${{steps.parse_tag.outputs.dist_tag}} --yes
+        run: |
+          n=0
+          until [ $n -ge 3 ]; do
+            pnpm lerna publish from-package --dist-tag ${{steps.parse_tag.outputs.dist_tag}} --yes && break
+            n=$((n+1))
+            echo "Retry $n of 3"
+            sleep 15
+          done
         env:
           NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}
+          NPM_CONFIG_PROVENANCE: true

Also added NPM provenance setting to enhance supply chain security.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between d9a6c14 and 41d3a4b.

📒 Files selected for processing (1)
  • .github/workflows/Release.yml (1 hunks)
🧰 Additional context used
🪛 actionlint (1.7.4)
.github/workflows/Release.yml

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)

⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: push-check
🔇 Additional comments (2)
.github/workflows/Release.yml (2)

16-34: LGTM! Well-configured setup steps

The setup is properly configured with latest action versions, explicit version pinning, and correct caching configuration.


8-14: 🛠️ Refactor suggestion

Add concurrency control to prevent parallel releases

To prevent race conditions from multiple simultaneous releases, add concurrency control:

 jobs:
   release:
+    concurrency: release-${{ github.ref }}
     if: github.repository == 'opentiny/tiny-engine'
     runs-on: ubuntu-latest
     permissions:

Likely invalid or redundant comment.

@chilingling chilingling force-pushed the feat/releaseWorkFlow branch from 99c6540 to ec512c1 Compare January 8, 2025 12:09
@hexqi hexqi added this to the v2.2.0 milestone Jan 13, 2025
@hexqi hexqi merged commit 8295c3f into opentiny:refactor/develop Jan 13, 2025
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request refactor-main refactor/develop branch feature
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants