Separate jobs with tagpr and others #98

5ouma · 2024-10-27T02:19:03Z

⚠️ Issue

close #

🔄 Type of the Change

✏️ Description

Skip the release job entirely.

I agree to follow the
Code of Conduct.

Skip the release job entirely.

coderabbitai · 2024-10-27T02:19:10Z

Walkthrough

The pull request introduces significant changes to the workflow configuration in .github/workflows/release.yml. The existing job Release has been renamed to tagpr, which now includes an output for the generated tag. A new job, publish, has been added, dependent on tagpr, and will execute only if the tag output is not empty. Both jobs have defined permissions and utilize the same checkout action, with the publishing step moved to the publish job while retaining its conditional execution.

Changes

File Path	Change Summary
.github/workflows/release.yml	- Job renamed from `Release` to `tagpr`. - New job `publish` added. - Output `tag` added to `tagpr` job. - Permissions defined for both jobs. - Publishing step moved to `publish` job.

Possibly related PRs

Use tagpr to prepare releasing #91: Modifications to the .github/workflows/release.yml file, specifically related to the tagpr job and its output, closely align with the changes made in this PR.
Support labeling for tagpr #93: Focuses on labeling related to the tagpr process, relevant to the enhancements in workflow modularity and clarity regarding tagging and publishing.

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 204f475 and 11b8216.

📒 Files selected for processing (1)

.github/workflows/release.yml (2 hunks)

🔇 Additional comments (2)

.github/workflows/release.yml (2)
10-14: LGTM! Well-defined job name and permissions.

The job rename to 'tagpr' better reflects its specific responsibility, and the explicit permissions follow security best practices by clearly defining required access scopes.

16-17: Verify the tag output usage in other workflows.

The tag output configuration looks good and enables proper job orchestration.

Let's verify if this output is referenced correctly across the codebase:

✅ Verification successful

Let me search for any other potential references to this output using different patterns.

Tag output configuration is correctly used within the workflow

The tag output is properly referenced only within the same workflow file (release.yml) where:

It's defined as a job output: tag: ${{ steps.tagpr.outputs.tag }}

Used as a condition in a dependent job: if: ${{ needs.tagpr.outputs.tag != '' }}

The dependency is correctly declared: needs: tagpr

No other workflows are depending on this output, which is the expected behavior for this release automation setup.
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:
#!/bin/bash
# Search for any other workflows that might be depending on this output
rg -t yaml "needs.tagpr.outputs.tag" .github/workflows/
Length of output: 130

Script:
#!/bin/bash
# Search for any references to tagpr outputs in workflows
rg -t yaml "tagpr.outputs" .github/workflows/

# Search for any job dependencies on tagpr job
rg -t yaml "needs:\s+.*tagpr" .github/workflows/
Length of output: 290

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>, 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 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.

coderabbitai

Caution

Inline review comments failed to post. This is likely due to GitHub's limits when posting large numbers of comments.

Actionable comments posted: 1

🛑 Comments failed to post (1)

.github/workflows/release.yml (1)

29-41: ⚠️ Potential issue

Several improvements needed for the publish job.

The runs-on value should be lowercase 'ubuntu-latest'
Missing Node.js setup step required for npx
Consider adding error handling for the publish step

Apply these changes to improve reliability:

  publish:
    name: 📦 Publish to JSR
    permissions:
      contents: read
      id-token: write
    needs: tagpr
    if: ${{ needs.tagpr.outputs.tag != '' }}
-   runs-on: Ubuntu-Latest
+   runs-on: ubuntu-latest

    steps:
      - name: 🚚 Checkout Repository
        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2

+     - name: 📥 Setup Node.js
+       uses: actions/setup-node@v4
+       with:
+         node-version: 'lts/*'

      - name: 📦 Publish to JSR
+       id: publish
        run: npx jsr publish
+       continue-on-error: true

+     - name: 🚨 Check publish status
+       if: steps.publish.outcome == 'failure'
+       run: |
+         echo "::error::Failed to publish to JSR"
+         exit 1

📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

  publish:
    name: 📦 Publish to JSR
    permissions:
      contents: read
      id-token: write
    needs: tagpr
    if: ${{ needs.tagpr.outputs.tag != '' }}
    runs-on: ubuntu-latest

    steps:
      - name: 🚚 Checkout Repository
        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2

      - name: 📥 Setup Node.js
        uses: actions/setup-node@v4
        with:
          node-version: 'lts/*'

      - name: 📦 Publish to JSR
        id: publish
        run: npx jsr publish
        continue-on-error: true

      - name: 🚨 Check publish status
        if: steps.publish.outcome == 'failure'
        run: |
          echo "::error::Failed to publish to JSR"
          exit 1

ci(release): Separate jobs with tagpr and others

11b8216

Skip the release job entirely.

auto-assign bot assigned 5ouma Oct 27, 2024

prlabeler bot added the 🎽 CI Changes to CI configuration files and scripts label Oct 27, 2024

coderabbitai bot reviewed Oct 27, 2024

View reviewed changes

5ouma merged commit 3243610 into main Oct 27, 2024
6 checks passed

5ouma deleted the ci-release-jobs branch October 27, 2024 02:32

github-actions bot mentioned this pull request Oct 27, 2024

Release: v1.4.0 #92

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Separate jobs with tagpr and others #98

Separate jobs with tagpr and others #98

5ouma commented Oct 27, 2024

coderabbitai bot commented Oct 27, 2024 •

edited

Loading

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

coderabbitai bot left a comment

Separate jobs with tagpr and others #98

Separate jobs with tagpr and others #98

Conversation

5ouma commented Oct 27, 2024

⚠️ Issue

🔄 Type of the Change

✏️ Description

coderabbitai bot commented Oct 27, 2024 • edited Loading

Walkthrough

Changes

Possibly related PRs

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

coderabbitai bot left a comment

Choose a reason for hiding this comment

coderabbitai bot commented Oct 27, 2024 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)