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: configure changesets to enter prerelease mode on v4 tag #1869

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

ericallam
Copy link
Member

@ericallam ericallam commented Apr 2, 2025

Summary by CodeRabbit

  • Documentation

    • Added new release notes outlining major version updates for multiple packages, along with an upgrade guide link for version 4.
  • Chores

    • Refined the release process command to support the new v4 workflow.
    • Introduced initial version settings for various system components.

Copy link
Contributor

coderabbitai bot commented Apr 2, 2025

Walkthrough

This pull request introduces a new markdown file documenting major version updates for several Trigger.dev packages and a new JSON file defining a "pre" mode with a "v4-beta" tag and initial version numbers for various components. Additionally, the package.json script command is updated to reflect the transition from a beta workflow to a version 4 workflow, aligning the command with the new release process.

Changes

File(s) Change Summary
.changeset/four-needles-add.md, .changeset/pre.json Added new changeset documentation and configuration files: the markdown file records major version updates and release notes; the JSON file sets up a "pre" mode with tag "v4-beta" and initial component versions.
package.json Updated the changeset script command from "changeset:beta": "changeset pre enter beta" to "changeset:v4": "changeset pre enter v4", modifying the release workflow command.

Sequence Diagram(s)

sequenceDiagram
    participant Dev as Developer
    participant PKG as Package.json
    participant CS as Changeset Tool
    participant CONF as Config Files (.changeset)
    
    Dev->>PKG: Run "npm run changeset:v4"
    PKG->>CS: Execute "changeset pre enter v4"
    CS->>CONF: Read pre.json & version docs
    CONF-->>CS: Return configuration data
    CS->>Dev: Process and output release workflow updates
Loading

Poem

I'm a rabbit, hopping with glee,
Skipping along into shiny v4, you see.
Carrot updates and docs in a row,
Leaping through code as changes flow.
With each command, my heart beats fast—
Cheers to v4, a hop built to last!


🪧 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.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai plan to trigger planning for file edits and PR creation.
  • @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.

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

🧹 Nitpick comments (1)
.changeset/four-needles-add.md (1)

12-12: Improve Markdown URL Formatting
The bare URL on this line (https://trigger.dev/docs/upgrade-to-v4) triggers markdownlint (MD034). Consider using proper markdown link syntax or enclosing the URL in angle brackets. For example:

-Trigger.dev v4 release. Please see our upgrade to v4 docs to view the full changelog: https://trigger.dev/docs/upgrade-to-v4
+Trigger.dev v4 release. Please see our [upgrade to v4 docs](https://trigger.dev/docs/upgrade-to-v4) to view the full changelog.
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)

12-12: Bare URL used
null

(MD034, no-bare-urls)

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 6d819c6 and b55c764.

📒 Files selected for processing (3)
  • .changeset/four-needles-add.md (1 hunks)
  • .changeset/pre.json (1 hunks)
  • package.json (1 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
.changeset/four-needles-add.md

12-12: Bare URL used
null

(MD034, no-bare-urls)

⏰ Context from checks skipped due to timeout of 90000ms (4)
  • GitHub Check: e2e / 🧪 CLI v3 tests (windows-latest - pnpm)
  • GitHub Check: e2e / 🧪 CLI v3 tests (windows-latest - npm)
  • GitHub Check: units / 🧪 Unit Tests
  • GitHub Check: typecheck / typecheck
🔇 Additional comments (2)
package.json (1)

47-47: Updated Changeset Script for v4 Pre-release
The new script "changeset:v4": "changeset pre enter v4" correctly replaces the old beta workflow and aligns with the intended version 4 release process. Please ensure that any related documentation or subsequent automation steps are updated accordingly.

.changeset/pre.json (1)

1-21: New Pre-release Configuration File
This new JSON file is well structured and clearly defines a "pre" mode with a "v4" tag. The initialVersions object lists the versions for various components appropriately, and the empty changesets array indicates a proper initialization for upcoming changes.

Copy link

changeset-bot bot commented Apr 2, 2025

🦋 Changeset detected

Latest commit: 03bb704

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

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

🧹 Nitpick comments (1)
.changeset/four-needles-add.md (1)

12-12: Convert Bare URL to Markdown Link

Line 12 uses a bare URL, which triggers a markdownlint MD034 warning (no-bare-urls). For better readability and to adhere to style guidelines, consider converting the URL into a clickable markdown link. For example:

-Trigger.dev v4 release. Please see our upgrade to v4 docs to view the full changelog: https://trigger.dev/docs/upgrade-to-v4
+Trigger.dev v4 release. Please see our [upgrade to v4 docs](https://trigger.dev/docs/upgrade-to-v4) to view the full changelog.
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)

12-12: Bare URL used
null

(MD034, no-bare-urls)

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between b55c764 and 40d7f0b.

📒 Files selected for processing (3)
  • .changeset/four-needles-add.md (1 hunks)
  • .changeset/pre.json (1 hunks)
  • package.json (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (2)
  • package.json
  • .changeset/pre.json
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
.changeset/four-needles-add.md

12-12: Bare URL used
null

(MD034, no-bare-urls)

⏰ Context from checks skipped due to timeout of 90000ms (5)
  • GitHub Check: e2e / 🧪 CLI v3 tests (windows-latest - pnpm)
  • GitHub Check: e2e / 🧪 CLI v3 tests (windows-latest - npm)
  • GitHub Check: units / 🧪 Unit Tests
  • GitHub Check: typecheck / typecheck
  • GitHub Check: Analyze (javascript-typescript)
🔇 Additional comments (1)
.changeset/four-needles-add.md (1)

1-10: Front Matter Version Updates are Correctly Defined

The front matter block correctly lists the packages with their respective major version updates. The format aligns with the changesets convention, and the keys are properly quoted.

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

🧹 Nitpick comments (1)
.changeset/four-needles-add.md (1)

12-12: Format the URL to Meet Markdown Conventions

The release note contains a bare URL which triggers markdown lint warning MD034. Converting this URL into a proper markdown link improves readability and adherence to markdown best practices.

Proposed change:

-Trigger.dev v4 release. Please see our upgrade to v4 docs to view the full changelog: https://trigger.dev/docs/upgrade-to-v4
+Trigger.dev v4 release. Please see our [upgrade to v4 docs](https://trigger.dev/docs/upgrade-to-v4) to view the full changelog.
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)

12-12: Bare URL used
null

(MD034, no-bare-urls)

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 40d7f0b and 0d6573d.

📒 Files selected for processing (3)
  • .changeset/four-needles-add.md (1 hunks)
  • .changeset/pre.json (1 hunks)
  • package.json (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (2)
  • package.json
  • .changeset/pre.json
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
.changeset/four-needles-add.md

12-12: Bare URL used
null

(MD034, no-bare-urls)

⏰ Context from checks skipped due to timeout of 90000ms (4)
  • GitHub Check: e2e / 🧪 CLI v3 tests (windows-latest - pnpm)
  • GitHub Check: units / 🧪 Unit Tests
  • GitHub Check: e2e / 🧪 CLI v3 tests (windows-latest - npm)
  • GitHub Check: typecheck / typecheck
🔇 Additional comments (1)
.changeset/four-needles-add.md (1)

1-10: Version Bump Declarations are Correct

The metadata header is correctly formatted with the expected package entries and "major" version updates for each package. This follows the changesets convention for declaring version bumps in a release.

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

🧹 Nitpick comments (1)
.changeset/four-needles-add.md (1)

12-12: Markdown Body: Address Bare URL Warning
The release note contains a bare URL, which may trigger markdown lint warnings (MD034). Please consider wrapping the URL in proper markdown link syntax for better readability and compliance. For example, you might change the line as follows:

-Trigger.dev v4 release. Please see our upgrade to v4 docs to view the full changelog: https://trigger.dev/docs/upgrade-to-v4
+Trigger.dev v4 release. Please see our [upgrade to v4 docs](https://trigger.dev/docs/upgrade-to-v4) to view the full changelog.
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)

12-12: Bare URL used
null

(MD034, no-bare-urls)

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 0d6573d and 03bb704.

📒 Files selected for processing (3)
  • .changeset/four-needles-add.md (1 hunks)
  • .changeset/pre.json (1 hunks)
  • package.json (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • package.json
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
.changeset/four-needles-add.md

12-12: Bare URL used
null

(MD034, no-bare-urls)

⏰ Context from checks skipped due to timeout of 90000ms (3)
  • GitHub Check: e2e / 🧪 CLI v3 tests (windows-latest - pnpm)
  • GitHub Check: e2e / 🧪 CLI v3 tests (windows-latest - npm)
  • GitHub Check: units / 🧪 Unit Tests
🔇 Additional comments (4)
.changeset/pre.json (3)

1-3: Header: Prerelease Mode and Tag Configuration
The JSON header correctly sets the prerelease mode with "mode": "pre" and assigns the tag "v4-beta", which aligns with the intended prerelease configuration.


4-18: Initial Versions Declaration
The initialVersions object lists all necessary components with their designated starting versions. Please verify that these version numbers (e.g., "0.0.1", "1.0.0", and "3.3.17") align with your release strategy for v4 prereleases.


19-20: Empty Changesets Array
The "changesets" array is correctly initialized as empty. This is expected for a new file serving as a baseline for upcoming changesets.

.changeset/four-needles-add.md (1)

1-10: YAML Front Matter: Major Version Declarations
The front matter correctly declares major version updates for the listed Trigger.dev packages. The structure is clear and aligns with the intended upgrade to v4.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant