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: disable auto release #1890

Merged
merged 1 commit into from
Mar 7, 2025
Merged

Conversation

claytonneal
Copy link
Member

@claytonneal claytonneal commented Mar 7, 2025

Description

Disables the on-tag release github workflows and instead they are changed to run manually

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • [] New feature (non-breaking change which adds functionality)
  • [] Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • [] This change requires a documentation update

Checklist:

  • My code follows the coding standards of this project
  • I have performed a self-review of my code
  • I have commented on my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • New and existing integration tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules
  • I have not added any vulnerable dependencies to my code

Summary by CodeRabbit

  • Chores
    • Modified our automation processes so that tasks are now manually initiated instead of automatically triggered. This change provides enhanced control over deployment and build activities.

@claytonneal claytonneal requested a review from a team as a code owner March 7, 2025 17:15
Copy link
Contributor

coderabbitai bot commented Mar 7, 2025

Walkthrough

This pull request updates three GitHub Actions workflow files to change their trigger mechanisms. The workflow in .../on-tag.yml is modified to trigger manually via workflow_dispatch instead of automatically on tag pushes. Similarly, both .../publish-sdk.yml and .../rpc-proxy.yml now use workflow_dispatch in place of workflow_call, requiring manual initiation rather than an automatic or caller-based trigger.

Changes

File(s) Modified Change Summary
.../on-tag.yml Replaced the push event trigger (with tag pattern *) with workflow_dispatch for manual workflow triggering.
.../publish-sdk.yml, .../rpc-proxy.yml Updated trigger from workflow_call to workflow_dispatch, changing the workflow initiation from automatic invocation to manual triggering by a user.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant GitHub
    participant Workflow
    User->>GitHub: Manually trigger workflow_dispatch event
    GitHub->>Workflow: Start workflow (on-tag / publish-sdk / rpc-proxy)
    Workflow-->>GitHub: Workflow execution completes
Loading

Suggested Reviewers

  • fabiorigam
  • leszek-vechain

Poem

In the realm of workflows, a change divine,
Manual triggers now align with design.
No longer automatic, a gentle command,
GitHub listens carefully at your hand.
Cheers to control, in code we shine!
🚀✨


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.

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)
.github/workflows/rpc-proxy.yml (1)

7-10: Review the Conditional Check
The job under test includes an if: github.ref != 'refs/tags/*' condition. Since the workflow is now manually triggered, verify if this condition is still necessary or if it might lead to unexpected behavior under certain manual trigger scenarios.

🧰 Tools
🪛 YAMLlint (1.35.1)

[warning] 7-7: wrong indentation: expected 2 but found 4

(indentation)

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 305fe2b and 394eed5.

📒 Files selected for processing (3)
  • .github/workflows/on-tag.yml (1 hunks)
  • .github/workflows/publish-sdk.yml (1 hunks)
  • .github/workflows/rpc-proxy.yml (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: Analyze (javascript-typescript)
🔇 Additional comments (3)
.github/workflows/rpc-proxy.yml (1)

3-5: Manual Trigger Configuration Updated
The workflow's trigger has been successfully updated to workflow_dispatch, which now requires a manual start rather than an automatic invocation. This change aligns well with the PR objective to disable auto releases.

.github/workflows/publish-sdk.yml (1)

3-5: Manual Trigger Enabled in Publish Workflow
The trigger has been switched to workflow_dispatch, which ensures that the publishing process will now only run when manually initiated. The permissions and steps remain intact, supporting the new workflow process.

.github/workflows/on-tag.yml (1)

3-5: Workflow Trigger Switched to Manual Execution
The transition from an automatic tag-based trigger to workflow_dispatch meets the objective to disable auto releases. The file cleanly delegates job execution to the corresponding workflows, ensuring a centralized manual release process.

@lucanicoladebiasi lucanicoladebiasi merged commit 1bc09e6 into main Mar 7, 2025
6 checks passed
@lucanicoladebiasi lucanicoladebiasi deleted the chore/disable-auto-release branch March 7, 2025 17:26
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.

2 participants