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

ci: add release workflow #1324

Merged
merged 3 commits into from
Mar 29, 2024
Merged

ci: add release workflow #1324

merged 3 commits into from
Mar 29, 2024

Conversation

SutuSebastian
Copy link
Collaborator

@SutuSebastian SutuSebastian commented Mar 29, 2024

This will allow us to easily release packages in a more elegant manner by just merging a PR, when ready.

Changes

  • add github release workflow

Summary by CodeRabbit

  • Chores
    • Implemented a workflow for automating the release process, including building and publishing releases or NPM packages.

Copy link

stackblitz bot commented Mar 29, 2024

Review PR in StackBlitz Codeflow Run & review this pull request in StackBlitz Codeflow.

Copy link

changeset-bot bot commented Mar 29, 2024

⚠️ No Changeset found

Latest commit: 0657cb3

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@SutuSebastian SutuSebastian self-assigned this Mar 29, 2024
Copy link
Contributor

coderabbitai bot commented Mar 29, 2024

Walkthrough

This update introduces a new GitHub Actions workflow specifically designed for automating the release process. It activates upon code pushes to the main branch, streamlining tasks such as building the codebase and publishing releases or NPM packages. This enhancement aims to simplify and accelerate the deployment of new versions, ensuring that updates are efficiently rolled out.

Changes

File Change Summary
.github/workflows/release.yml Introduced a workflow for automating releases and NPM publishing.

🐰✨
In the realm of code, beneath the digital sky,
A new path unfolds, where our releases fly.
Upon each push to main, our changes gleam,
Crafting versions anew, as if in a dream.
Let's hop along, with joy in our quest,
For in this automation, we find our best.
🚀🌟

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>.
    • Generate unit-tests 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 tests 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit tests.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

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 as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • The JSON schema for the configuration file is available here.
  • 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

Copy link

vercel bot commented Mar 29, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
flowbite-react ✅ Ready (Inspect) Visit Preview 💬 Add feedback Mar 29, 2024 0:57am
flowbite-react-storybook ✅ Ready (Inspect) Visit Preview 💬 Add feedback Mar 29, 2024 0:57am

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

Review Status

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between c2fb19a and 0657cb3.
Files selected for processing (1)
  • .github/workflows/release.yml (1 hunks)
Additional Context Used
Additional comments not posted (5)
.github/workflows/release.yml (5)

3-6: The workflow is correctly configured to trigger on pushes to the main branch. This is a common practice for release workflows, ensuring that releases are tied to the most stable version of the code.


8-8: Using concurrency with ${{ github.workflow }}-${{ github.ref }} is a good practice to avoid conflicts by ensuring that only one instance of the workflow runs for a given branch at a time.


15-16: The use of actions/checkout@v4 for checking out the branch is standard and ensures that the latest code is used for the build and release process.


21-22: The build command bun run build suggests the use of Bun (a JavaScript runtime like Node.js). Ensure that Bun is installed and configured correctly in the setup step, as it's not a standard tool included in GitHub's ubuntu-latest runners.

Verification successful

The verification process has successfully identified the setup for Bun within the .github/actions/setup directory. The output confirms that there is a specific step named "Setup Bun" that utilizes oven-sh/setup-bun@v1 for setting up Bun, specifying a Bun version (bun-version: 1.0.31), and running bun install. This confirms that Bun is indeed installed and configured correctly in the setup step of the GitHub Actions workflow, as required for the build command bun run build to function properly.

Scripts Executed

The following scripts were executed for the analysis:


Script:

#!/bin/bash
# Verify the setup action script for Bun installation
fd 'setup' .github/actions | xargs cat | grep -i 'bun'

Length of output: 96



Script:

#!/bin/bash
# List and inspect all files within the .github/actions/setup directory for Bun installation
fd . .github/actions/setup --exec cat {} \; | grep -i 'bun'

Length of output: 218


24-31: The use of changesets/action@v1 for creating release pull requests or publishing to NPM is a solid choice for managing versioning and changelogs. However, ensure that the bun run release command in the publish option is compatible with your project's release process. Additionally, the inclusion of GITHUB_TOKEN and NPM_TOKEN as secrets is necessary for authentication purposes.

.github/workflows/release.yml Show resolved Hide resolved
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🚀 enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant