Add Snapshot release workflows

kamiazya commented 2 months ago

This pull request includes updates to the GitHub Actions setup, specifically adding an optional skip-checkout input. It also introduces a new Snapshot Release Action that allows for creating and publishing snapshot releases.

Summary by CodeRabbit

New Features
- Introduced snapshot release workflows for pull requests using GitHub Actions, enhancing automation for version releases.
- Added a GitHub Actions workflow for creating snapshot releases triggered by specific comments on pull requests.
Chores
- Added configuration for prerelease templates and calculated versions.
- Added parameters and conditions to control the checkout step in the setup action.
- Defined inputs, outputs, and steps for a composite snapshot release action.

changeset-bot[bot] commented 2 months ago

🦋 Changeset detected

Latest commit: e9322426bc0440ec2388647e6bf91bc88a3e44bd

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

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

coderabbitai[bot] commented 2 months ago

Walkthrough

The changes introduce automated snapshot release workflows and configurations using GitHub Actions. Enhancements include updating .changeset/config.json for prerelease templates, adding new composite actions for setting up and performing snapshot releases, and implementing new workflows triggered by pull request comments. These updates streamline version management, improve performance, and enhance automation in the CI/CD pipeline.

Changes

Files/Groups	Change Summary
`.changeset/config.json`	Added snapshot configuration for prerelease template and calculated version.
`.changeset/tame-flowers-pay.md`	Introduced snapshot release workflows, enhancing automation and performance.
`.github/actions/setup/action.yaml`	Added `inputs` section with `skip-checkout` parameter and conditional checkout step.
`.github/actions/snapshot-release/action.yaml`	Introduced a composite release action with steps for creating `.npmrc` and running release commands.
`.github/workflows/cicd.yaml`	Added `prerelease` job to run on specific conditions for `next` version snapshot releases.
`.github/workflows/pr-snapshot-release-command.yaml`	Added a workflow for automating snapshot releases triggered by specific pull request comments.

Sequence Diagram(s)

sequenceDiagram
    participant Developer
    participant GitHub
    participant GitHubActions
    participant CI/CDPipeline
    participant NPM

    Developer->>GitHub: Open Pull Request
    GitHub-->>GitHubActions: Trigger Workflow
    GitHubActions-->>CI/CDPipeline: Run Tests and Build
    Note over GitHubActions: New Workflow: PR Snapshot Release
    Developer->>GitHub: Comment "/snapshot"
    GitHub-->>GitHubActions: Trigger Snapshot Workflow
    GitHubActions-->>NPM: Publish Snapshot Release
    NPM-->>GitHubActions: Return Publish Result
    GitHubActions-->>GitHub: Update PR Comment with Result
    GitHub-->>Developer: Notification with Publish Result

Poem

Amid the fields where codes entwine, A rabbit hops with joyful sign. "Release the snapshots!" it decrees, Automate with ease, oh get degrees. Actions flow like rivers swift, Onward through the changes, lift! To future's edge, we nimbly go, With every line, the systems grow! 🌸🐇🚀

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

- [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)

Tips

### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `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 Configration 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.

kamiazya commented 2 months ago

/snapshot-release

kamiazya commented 2 months ago

/snapshot-release

kamiazya commented 2 months ago

/snapshot-release

kamiazya commented 2 months ago

/snapshot-release Edited: Snapshot release @develop: ✅

🦋  info npm info typedoc-plugin-mermaid
🦋  info typedoc-plugin-mermaid is being published because our local version (1.11.0-pr853-493864e339f1814d0f2cc4a761b48e84764299a5) has not been published on npm
🦋  info Publishing "typedoc-plugin-mermaid" at "1.11.0-pr853-493864e339f1814d0f2cc4a761b48e84764299a5"
🦋  success packages published successfully:
🦋  typedoc-plugin-mermaid@1.11.0-pr853-493864e339f1814d0f2cc4a761b48e84764299a5

kamiazya commented 2 months ago

@coderabbitai review

coderabbitai[bot] commented 2 months ago

Actions performed

Review triggered. > Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

kamiazya / typedoc-plugin-mermaid