Skip to content

Fix prerelease script #1794

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

Merged
merged 2 commits into from
Mar 15, 2025
Merged

Fix prerelease script #1794

merged 2 commits into from
Mar 15, 2025

Conversation

nicktrn
Copy link
Collaborator

@nicktrn nicktrn commented Mar 15, 2025

Not cleaning up build artifacts before building for prerelease was causing trouble. For example, the build output could be missing newly added modules.

This PR also adds lefthook, a powerful git hook manager. For now it only adds a single pre-commit hook that prevents commits to main.

Summary by CodeRabbit

  • Chores
    • Updated caching configuration to improve performance.
    • Implemented a safeguard to prevent direct commits to the main branch.
    • Added a tool for enhanced Git hook management.
    • Enhanced the pre-release publishing process with an additional cleanup step before building packages.

Copy link

changeset-bot bot commented Mar 15, 2025

⚠️ No Changeset found

Latest commit: 63a05d5

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

Copy link
Contributor

coderabbitai bot commented Mar 15, 2025

Walkthrough

This pull request introduces new settings in configuration files and augments the project's build process. A new caching option is added in .npmrc, while the lefthook.yml file now contains a pre-commit hook that blocks direct commits to the main branch. Additionally, a new dependency for managing Git hooks is added in package.json. The scripts/publish-prerelease.sh script now performs a cleaning step before building by running a specific pnpm command.

Changes

File(s) Change Summary
.npmrc, lefthook.yml Added new configuration options: side-effects-cache=false in .npmrc and a pre-commit hook in lefthook.yml to prevent main branch commits.
package.json Added a new devDependency "lefthook": "^1.11.3" to manage Git hooks.
scripts/publish-prerelease.sh Inserted two new lines to output a message and execute a pnpm clean command on @trigger.dev/* and trigger.dev packages before the build command.

Sequence Diagram(s)

sequenceDiagram
    participant Dev as Developer
    participant Git as Git
    participant LH as Lefthook
    Dev->>Git: Attempt commit to main branch
    Git->>LH: Trigger pre-commit hook
    LH-->>Git: Exit with status 1 to block commit
    Note over Git,Dev: Commit is prevented on the main branch
Loading
sequenceDiagram
    participant Script as Publish Script
    participant PNPM as PNPM CLI
    participant Build as Build Process
    Script->>Script: Check for unreleased changesets
    Script->>Console: Output cleaning message
    Script->>PNPM: Execute clean command for @trigger.dev/* and trigger.dev
    PNPM-->>Script: Clean operation completes
    Script->>Build: Run build command
Loading

Suggested reviewers

  • ericallam
  • matt-aitken

Poem

I'm a rabbit with a codey beat,
Hopping through lines oh-so-sweet.
New hooks and cleans make the playground bright,
With caching tweaks to set things right.
In this burrow of code, we cheer with delight! 🐇✨

Tip

⚡🧪 Multi-step agentic review comment chat (experimental)
  • We're introducing multi-step agentic chat in review comments. This experimental feature enhances review discussions with the CodeRabbit agentic chat by enabling advanced interactions, including the ability to create pull requests directly from comments.
    - To enable this feature, set early_access to true under in the settings.
✨ Finishing Touches
  • 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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>, 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 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 (4)
.npmrc (1)

4-5: Clarify new configuration settings.
The additions of update-notifier=false and side-effects-cache=false appear intended to streamline the package installation process. Verify that disabling update notifications and side-effects caching aligns with the team's workflow and is well-documented for contributors.

scripts/publish-prerelease.sh (1)

51-52: Introduce cleanup before build.
The added commands output a message and invoke pnpm run clean with explicit filters for @trigger.dev/* and trigger.dev. This ensures that stale build artifacts are removed before initiating the build, which directly addresses the prerelease script issues. Please double-check that the filter patterns cover all intended modules and that the clean process does not remove any necessary files.

package.json (1)

56-56: New dependency for Lefthook integration.
The dependency "lefthook": "^1.11.3" has been added to devDependencies to support the new Git hook configurations. Ensure that its usage is documented, so contributors understand its role in enforcing branch policies.

lefthook.yml (1)

1-7: Implement pre-commit hook to prevent main branch commits.
This newly introduced pre-commit configuration applies only to commits on the main branch by running a job that immediately exits with a status of 1, effectively blocking such commits. Confirm that this behavior is clearly communicated in the contribution guidelines to avoid any surprises for contributors.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 7842e9d and 63a05d5.

⛔ Files ignored due to path filters (1)
  • pnpm-lock.yaml is excluded by !**/pnpm-lock.yaml
📒 Files selected for processing (4)
  • .npmrc (1 hunks)
  • lefthook.yml (1 hunks)
  • package.json (1 hunks)
  • scripts/publish-prerelease.sh (1 hunks)
⏰ 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)

@matt-aitken matt-aitken merged commit 4fda8a5 into main Mar 15, 2025
12 checks passed
@nicktrn nicktrn deleted the fix/prerelease branch March 15, 2025 12:25
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.

3 participants