-
-
Notifications
You must be signed in to change notification settings - Fork 677
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
base: main
Are you sure you want to change the base?
Conversation
WalkthroughThis 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 Changes
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
Poem
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this 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
📒 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. TheinitialVersions
object lists the versions for various components appropriately, and the emptychangesets
array indicates a proper initialization for upcoming changes.
🦋 Changeset detectedLatest 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 |
There was a problem hiding this 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 LinkLine 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
📒 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 DefinedThe 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.
There was a problem hiding this 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 ConventionsThe 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
📒 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 CorrectThe 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.
There was a problem hiding this 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
📒 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
TheinitialVersions
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.
Summary by CodeRabbit
Documentation
Chores