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

Use release env for release github workflow #2608

Merged
merged 1 commit into from
Nov 25, 2024
Merged

Conversation

ttl33
Copy link
Contributor

@ttl33 ttl33 commented Nov 25, 2024

Changelist

Created a separate env for github release workflow. Only applicable to python

Test Plan

[Describe how this PR was tested (if applicable)]

Author/Reviewer Checklist

  • If this PR has changes that result in a different app state given the same prior state and transaction list, manually add the state-breaking label.
  • If the PR has breaking postgres changes to the indexer add the indexer-postgres-breaking label.
  • If this PR isn't state-breaking but has changes that modify behavior in PrepareProposal or ProcessProposal, manually add the label proposal-breaking.
  • If this PR is one of many that implement a specific feature, manually label them all feature:[feature-name].
  • If you wish to for mergify-bot to automatically create a PR to backport your change to a release branch, manually add the label backport/[branch-name].
  • Manually add any of the following labels: refactor, chore, bug.

Summary by CodeRabbit

  • New Features
    • Enhanced release workflow for both Python and JavaScript components, improving version handling and environment configuration.
  • Improvements
    • Updated version formatting to comply with semantic versioning standards.
    • Added debugging support by echoing the VERSION variable during updates.

@ttl33 ttl33 requested a review from a team as a code owner November 25, 2024 17:21
Copy link
Contributor

coderabbitai bot commented Nov 25, 2024

Walkthrough

The pull request modifies the workflow file .github/workflows/protocol-release.yml to enhance the release process for Python and JavaScript components. Key updates include the addition of an ENVIRONMENT: release configuration and a secrets: inherit directive in the v4-proto-py-release job. The VERSION environment variable setting has been refined for both jobs, with the Python job removing the 'v' prefix and the JavaScript job adopting a more complex regex for semantic versioning. Echoing the VERSION variable before substitutions has also been added for debugging purposes.

Changes

File Path Change Summary
.github/workflows/protocol-release.yml - Updated v4-proto-py-release job: added with: ENVIRONMENT: release, secrets: inherit.
- Updated v4-proto-js-release job: modified regex for semantic versioning in Set Env from Tag to follow semver.
- Echoed VERSION variable in Update version in setup.py and Update version in package.json steps.

Poem

🐇 In the meadow where code does play,
A rabbit hops with joy today!
Versions refined, secrets kept tight,
Python and JavaScript take flight!
With each new tag, a dance we see,
Celebrating change, oh what glee! 🌼


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.

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

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 4eaca4a and 390e909.

📒 Files selected for processing (1)
  • .github/workflows/protocol-release.yml (1 hunks)
🧰 Additional context used
🪛 actionlint (1.7.3)
.github/workflows/protocol-release.yml

123-123: this step is for running shell command since it contains at least one of "run", "shell" keys, but also contains "with" key which is used for running action

(syntax-check)


125-125: unexpected key "secrets" for "step" section. expected one of "continue-on-error", "env", "id", "if", "name", "run", "shell", "timeout-minutes", "uses", "with", "working-directory"

(syntax-check)

🔇 Additional comments (1)
.github/workflows/protocol-release.yml (1)

Line range hint 182-183: LGTM: Version formatting follows semantic versioning

The sed command correctly transforms the version format to comply with semantic versioning specification for pre-release versions (e.g., 1.0.1-rc11.0.1-rc.1).

🧰 Tools
🪛 actionlint (1.7.3)

123-123: this step is for running shell command since it contains at least one of "run", "shell" keys, but also contains "with" key which is used for running action

(syntax-check)


125-125: unexpected key "secrets" for "step" section. expected one of "continue-on-error", "env", "id", "if", "name", "run", "shell", "timeout-minutes", "uses", "with", "working-directory"

(syntax-check)

Comment on lines +123 to +125
with:
ENVIRONMENT: release
secrets: inherit
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue

Fix incorrect workflow syntax for environment configuration

The current syntax is invalid and will cause the workflow to fail. The with and secrets keys are incorrectly placed at the step level without a corresponding action or command. These configurations should be at the job level.

Apply this fix:

  v4-proto-py-release:
    runs-on: ubuntu-latest
+   environment: release
+   secrets: inherit
    defaults:
      run:
        working-directory: ./v4-proto-py
-   with:
-     ENVIRONMENT: release
-   secrets: inherit
📝 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.

Suggested change
with:
ENVIRONMENT: release
secrets: inherit
v4-proto-py-release:
runs-on: ubuntu-latest
environment: release
secrets: inherit
defaults:
run:
working-directory: ./v4-proto-py
🧰 Tools
🪛 actionlint (1.7.3)

123-123: this step is for running shell command since it contains at least one of "run", "shell" keys, but also contains "with" key which is used for running action

(syntax-check)


125-125: unexpected key "secrets" for "step" section. expected one of "continue-on-error", "env", "id", "if", "name", "run", "shell", "timeout-minutes", "uses", "with", "working-directory"

(syntax-check)

@ttl33 ttl33 merged commit 744a58b into main Nov 25, 2024
6 checks passed
@ttl33 ttl33 deleted the tl/git-workflow-use-env branch November 25, 2024 19:16
jayy04 added a commit that referenced this pull request Dec 6, 2024
mergify bot pushed a commit that referenced this pull request Dec 6, 2024
@coderabbitai coderabbitai bot mentioned this pull request Dec 16, 2024
6 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

2 participants