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

Chore: Release using changesets #60 #66

Merged
merged 3 commits into from
Aug 15, 2024
Merged

Chore: Release using changesets #60 #66

merged 3 commits into from
Aug 15, 2024

Conversation

black7375
Copy link
Contributor

@black7375 black7375 commented Aug 15, 2024

Description

Release using changesets.

Related Issue

Summary by CodeRabbit

  • New Features

    • Introduced a guide for the Changesets tool to assist users in managing versioning and publishing.
    • Added a new workflow for automated release processes triggered by updates to the main branch.
  • Enhancements

    • Streamlined package management with new scripts in package.json for efficient build and release processes.
    • Added structured configuration for publishing packages, specifying output directories.
  • Bug Fixes

    • Updated dependencies in GitHub Actions to improve performance and reliability.
  • Documentation

    • Created changelogs for initial releases of several packages, enhancing transparency of package updates.

Additional context

Checklist

Copy link

changeset-bot bot commented Aug 15, 2024

🦋 Changeset detected

Latest commit: 3db93f7

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 4 packages
Name Type
@mincho-js/css-additional-types Patch
@mincho-js/transform-to-vanilla Patch
@mincho-js/debug-log Patch
@mincho-js/css Patch

Not sure what this means? Click here to learn what changesets are.

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

Copy link

coderabbitai bot commented Aug 15, 2024

Walkthrough

This update enhances the project’s versioning and release processes through the integration of Changesets, improved GitHub Actions workflows, and structured package configurations. Key additions include a new release automation workflow, updated dependencies for caching and checkout actions, and organized publishing configurations across packages. Overall, these changes aim to streamline development and maintain an efficient package management system.

Changes

Files Change Summary
.changeset/README.md, .changeset/config.json, .changeset/proud-poets-turn.md Added a README for Changesets, introduced a config file for structured versioning and changelog generation, and documented the first release of several @mincho-js packages in a changelog.
.github/actions/node-setup/action.yml, .github/workflows/ci.yml, .github/workflows/release.yml Updated action versions in workflow files and introduced a new release workflow to automate package publishing on main branch pushes, enhancing CI/CD processes.
package.json Added new scripts for package management and versioning, including forallpackages, build:release, and changeset. Modified cleanup script and added new dependencies for managing changelogs and versioning.
packages/*/package.json Introduced publishConfig in multiple packages to specify a directory for release artifacts, improving the packaging process for css-additional-types, css, debug-log, and transform-to-vanilla.

Sequence Diagram(s)

sequenceDiagram
    participant Dev as Developer
    participant GH as GitHub
    participant CI as CI/CD Pipeline
    participant NPM as NPM Registry

    Dev->>GH: Push code to main branch
    GH->>CI: Trigger release workflow
    CI->>GH: Checkout code
    CI->>CI: Setup Node.js environment
    CI->>CI: Run Changesets to create release pull request or publish
    CI->>NPM: Publish package
    NPM-->>CI: Confirm publish
    CI->>GH: Create release
    GH-->>Dev: Notify release complete
Loading

🐰 "In a garden of code, we hop with delight,
New workflows and changes, all shining so bright.
With versions in order, and packages neat,
Our project now dances to a rhythmic beat!
Let's celebrate progress, with carrots and cheer,
For a bouncy new future is finally here!" 🥕


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 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 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 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 as 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 resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

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

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.

Copy link
Contributor

Triggered from #66 by @​black7375.

Checking if we can fast forward main (550e404) to publish/css (3db93f7).

Target branch (main):

commit 550e404cf7a55978b405ed67d5198cc2da5127bb (HEAD -> main, origin/main, origin/HEAD)
Author: alstjr7375 <[email protected]>
Date:   Thu Aug 15 18:49:54 2024 +0900

    Docs: README update #60

Pull request (publish/css):

commit 3db93f706ee39bd4365891e5c8fd25c66609a99f (pull_request/publish/css)
Author: alstjr7375 <[email protected]>
Date:   Thu Aug 15 23:40:10 2024 +0900

    Chore: Release workflow #60

It is possible to fast forward main (550e404) to publish/css (3db93f7). If you have write access to the target repository, you can add a comment with /fast-forward to fast forward main to publish/css.

Copy link

@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: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 550e404 and 3db93f7.

Files ignored due to path filters (1)
  • yarn.lock is excluded by !**/yarn.lock, !**/*.lock
Files selected for processing (11)
  • .changeset/README.md (1 hunks)
  • .changeset/config.json (1 hunks)
  • .changeset/proud-poets-turn.md (1 hunks)
  • .github/actions/node-setup/action.yml (1 hunks)
  • .github/workflows/ci.yml (2 hunks)
  • .github/workflows/release.yml (1 hunks)
  • package.json (2 hunks)
  • packages/css-additional-types/package.json (1 hunks)
  • packages/css/package.json (1 hunks)
  • packages/debug-log/package.json (1 hunks)
  • packages/transform-to-vanilla/package.json (1 hunks)
Files skipped from review due to trivial changes (4)
  • .changeset/README.md
  • .changeset/config.json
  • .changeset/proud-poets-turn.md
  • packages/transform-to-vanilla/package.json
Additional comments not posted (14)
.github/actions/node-setup/action.yml (1)

13-13: Verify compatibility with actions/cache@v4.

The update from actions/cache@v3 to v4 may introduce changes in behavior or features. Ensure that the new version is compatible with your workflow and that any new features or changes are appropriately handled.

Verification successful

No compatibility issues found with actions/cache@v4. The update includes a bug fix for fail-on-cache-miss without any breaking changes or new features that impact your workflow.

Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify compatibility and changes in `actions/cache@v4`.

# Test: Check for any breaking changes or new features in `actions/cache@v4`.
# Expect: No breaking changes that affect current usage.
gh api repos/actions/cache/releases/latest --jq '.tag_name'

Length of output: 66


Script:

#!/bin/bash
# Description: Retrieve release notes for `actions/cache@v4` to check for breaking changes or new features.

# Fetch the release notes for the latest v4 release.
gh api repos/actions/cache/releases/tags/v4.0.2 --jq '.body'

Length of output: 257

.github/workflows/ci.yml (1)

13-13: Verify compatibility with actions/checkout@v4.

The update from actions/checkout@v3 to v4 may introduce changes in behavior or features. Ensure that the new version is compatible with your workflow and that any new features or changes are appropriately handled.

Also applies to: 30-30

.github/workflows/release.yml (1)

1-37: Review the new release workflow configuration.

The new release workflow is set up to create release pull requests or publish to npm using changesets. Ensure that:

  • The permissions are correctly set for the required actions.
  • The GITHUB_TOKEN and NPM_TOKEN secrets are correctly configured in the repository settings.
  • The changesets/action@v1 is correctly configured to meet your release requirements.
packages/css-additional-types/package.json (1)

35-37: Approve the addition of publishConfig.

The publishConfig section specifying the directory for publishing enhances the package's release process by organizing the output directory. This change aligns with the PR's objective of improving release management.

packages/css/package.json (1)

46-48: Approve the addition of publishConfig.

The publishConfig section specifying the directory for publishing enhances the package's release process by organizing the output directory. This change aligns with the PR's objective of improving release management.

packages/debug-log/package.json (1)

42-44: Approve the addition of publishConfig.

The publishConfig section specifying the directory for publishing enhances the package's release process by organizing the output directory. This change aligns with the PR's objective of improving release management.

package.json (8)

24-24: LGTM! The forallpackages script is a useful addition.

This script enhances workspace management by executing commands across all packages efficiently.


25-25: LGTM! The build:release script effectively consolidates build and release steps.

This script simplifies the release workflow by automating build, clean, and package operations.


26-26: LGTM! The changeset script is a straightforward addition.

This script facilitates version control and changelog generation.


27-27: LGTM! The version script automates the versioning process.

This script ensures that package versions are updated based on changesets.


28-28: LGTM! The publish script effectively integrates build and release processes.

This script ensures a streamlined and documented release process by combining build and changeset publishing steps.


29-29: LGTM! The g:clean script modification helps maintain a clean workspace.

Including the _release directory in the cleanup process ensures a tidy build environment.


43-43: LGTM! The @changesets/changelog-github dependency is a valuable addition.

This dependency aids in generating changelogs with GitHub integration, enhancing release note clarity.


44-44: LGTM! The @changesets/cli dependency is essential for changeset management.

This dependency supports versioning and changelog generation, crucial for project maintenance.

@black7375
Copy link
Contributor Author

/fast-forward

Copy link
Contributor

Triggered from #66 (comment) by @​black7375.

Trying to fast forward main (550e404) to publish/css (3db93f7).

Target branch (main):

commit 550e404cf7a55978b405ed67d5198cc2da5127bb (HEAD -> main, origin/main, origin/HEAD)
Author: alstjr7375 <[email protected]>
Date:   Thu Aug 15 18:49:54 2024 +0900

    Docs: README update #60

Pull request (publish/css):

commit 3db93f706ee39bd4365891e5c8fd25c66609a99f (pull_request/publish/css)
Author: alstjr7375 <[email protected]>
Date:   Thu Aug 15 23:40:10 2024 +0900

    Chore: Release workflow #60

Fast forwarding main (550e404) to publish/css (3db93f7).

$ git push origin 3db93f706ee39bd4365891e5c8fd25c66609a99f:main
To https://github.com/mincho-js/mincho.git
   550e404..3db93f7  3db93f706ee39bd4365891e5c8fd25c66609a99f -> main

@github-actions github-actions bot merged commit 3db93f7 into main Aug 15, 2024
7 checks passed
@black7375 black7375 deleted the publish/css branch August 15, 2024 14:52
@github-actions github-actions bot mentioned this pull request Aug 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

1 participant