Skip to content

chore: workflow update, re-enable yarn hardened mode #1835

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 1 commit into from
Jan 14, 2025

Conversation

jaybuidl
Copy link
Member

@jaybuidl jaybuidl commented Jan 14, 2025

PR-Codex overview

This PR focuses on updating the GitHub Actions workflows for improved dependency management and security enhancements. Key modifications include version upgrades for tools and changes in dependency installation processes.

Detailed summary

  • Updated step-security/harden-runner version in .github/workflows/contracts-testing.yml and .github/workflows/sentry-release.yml.
  • Removed the temporary disabling of hardened mode for installing contracts dependencies.
  • Added corepack setup for Yarn in .github/workflows/sentry-release.yml.
  • Upgraded actions/checkout and actions/setup-node versions.
  • Changed cache action version in .github/workflows/sentry-release.yml.
  • Unified cache key formatting in .github/workflows/sentry-release.yml.
  • Combined installation and build steps for dependencies in .github/workflows/sentry-release.yml.

✨ Ask PR-Codex anything about this PR by commenting with /codex {your question}

Summary by CodeRabbit

  • Chores
    • Updated GitHub Actions workflows for improved security and dependency management
    • Enhanced workflow configurations with updated actions and permissions
    • Added new steps for Node.js and Yarn setup in release workflow

Copy link
Contributor

coderabbitai bot commented Jan 14, 2025

Walkthrough

This pull request updates two GitHub Actions workflow files: contracts-testing.yml and sentry-release.yml. The changes primarily involve adding permissions, updating action versions, and streamlining workflow configurations. The modifications include adding content read permissions, pinning specific action versions, and simplifying dependency installation commands. These updates aim to enhance the workflow's security, reproducibility, and maintainability.

Changes

File Changes
.github/workflows/contracts-testing.yml - Added permissions: contents: read
- Updated harden-runner action to specific commit hash
- Simplified dependency installation command by removing YARN_ENABLE_HARDENED_MODE
.github/workflows/sentry-release.yml - Added permissions: contents: read
- Updated multiple actions to latest versions
- Added actions/setup-node step
- Modified allowed endpoints
- Consolidated build and dependency installation steps

Possibly related PRs

Suggested labels

Type: Toolchain ⚒️

Poem

🐰 Workflows dancing, actions bright,
Permissions set, configurations tight,
Yarn spinning, dependencies clean,
GitHub's magic, a CI machine!
Hop, hop, workflow delight! 🚀


🪧 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. (Beta)
  • @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 or @coderabbitai title 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.

@jaybuidl jaybuidl added Type: Maintenance 🚧 Type: Toolchain ⚒️ Build tools configuration, CI/CD labels Jan 14, 2025
Copy link

netlify bot commented Jan 14, 2025

Deploy Preview for kleros-v2-university ready!

Name Link
🔨 Latest commit e65377f
🔍 Latest deploy log https://app.netlify.com/sites/kleros-v2-university/deploys/6786b1a478f3320008a9ef8a
😎 Deploy Preview https://deploy-preview-1835--kleros-v2-university.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link

netlify bot commented Jan 14, 2025

Deploy Preview for kleros-v2-neo ready!

Name Link
🔨 Latest commit e65377f
🔍 Latest deploy log https://app.netlify.com/sites/kleros-v2-neo/deploys/6786b1a4c68b1500083471db
😎 Deploy Preview https://deploy-preview-1835--kleros-v2-neo.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link

netlify bot commented Jan 14, 2025

Deploy Preview for kleros-v2-testnet ready!

Name Link
🔨 Latest commit e65377f
🔍 Latest deploy log https://app.netlify.com/sites/kleros-v2-testnet/deploys/6786b1a4aec4fd000842aa80
😎 Deploy Preview https://deploy-preview-1835--kleros-v2-testnet.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link

codeclimate bot commented Jan 14, 2025

Code Climate has analyzed commit e65377f and detected 0 issues on this pull request.

View more on Code Climate.

Copy link

@jaybuidl jaybuidl merged commit e65377f into dev Jan 14, 2025
16 of 22 checks passed
@jaybuidl jaybuidl deleted the chore/workflow-update branch January 14, 2025 18:51
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 (2)
.github/workflows/sentry-release.yml (2)

71-71: Optimize the version setting command.

The cat command can be simplified.

-echo "version=v$(cat package.json | jq -r .version)-$(git rev-parse --short HEAD)" >> "$GITHUB_OUTPUT"
+echo "version=v$(jq -r .version package.json)-$(git rev-parse --short HEAD)" >> "$GITHUB_OUTPUT"
🧰 Tools
🪛 actionlint (1.7.4)

71-71: shellcheck reported issue in this script: SC2002:style:1:22: Useless cat. Consider 'cmd < file | ..' or 'cmd file | ..' instead

(shellcheck)


45-45: Fix YAML formatting.

Remove trailing spaces from these lines to maintain consistent formatting.

Also applies to: 49-49, 51-51, 57-57

🧰 Tools
🪛 yamllint (1.35.1)

[error] 45-45: trailing spaces

(trailing-spaces)

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 1de725b and e65377f.

📒 Files selected for processing (2)
  • .github/workflows/contracts-testing.yml (2 hunks)
  • .github/workflows/sentry-release.yml (1 hunks)
🧰 Additional context used
🪛 actionlint (1.7.4)
.github/workflows/sentry-release.yml

71-71: shellcheck reported issue in this script: SC2002:style:1:22: Useless cat. Consider 'cmd < file | ..' or 'cmd file | ..' instead

(shellcheck)

🪛 yamllint (1.35.1)
.github/workflows/sentry-release.yml

[error] 45-45: trailing spaces

(trailing-spaces)


[error] 49-49: trailing spaces

(trailing-spaces)


[error] 51-51: trailing spaces

(trailing-spaces)


[error] 57-57: trailing spaces

(trailing-spaces)

⏰ Context from checks skipped due to timeout of 90000ms (15)
  • GitHub Check: Redirect rules - kleros-v2-testnet
  • GitHub Check: Redirect rules - kleros-v2-testnet
  • GitHub Check: Header rules - kleros-v2-testnet
  • GitHub Check: Header rules - kleros-v2-testnet
  • GitHub Check: Pages changed - kleros-v2-testnet
  • GitHub Check: Pages changed - kleros-v2-testnet
  • GitHub Check: Redirect rules - kleros-v2-neo
  • GitHub Check: Header rules - kleros-v2-neo
  • GitHub Check: Pages changed - kleros-v2-neo
  • GitHub Check: Redirect rules - kleros-v2-university
  • GitHub Check: Header rules - kleros-v2-university
  • GitHub Check: Pages changed - kleros-v2-university
  • GitHub Check: contracts-testing
  • GitHub Check: Analyze (javascript)
  • GitHub Check: dependency-review
🔇 Additional comments (6)
.github/workflows/contracts-testing.yml (3)

Line range hint 13-14: LGTM! Good security practice.

Adding explicit contents: read permission follows the principle of least privilege, which is a security best practice for GitHub Actions.

🧰 Tools
🪛 yamllint (1.35.1)

[warning] 26-26: wrong indentation: expected 6 but found 4

(indentation)


27-27: LGTM! Enhanced security with pinned commit.

Pinning to a specific commit hash instead of a version tag is a security best practice that prevents potential supply chain attacks.


71-71: LGTM! Re-enabled yarn hardened mode.

Removing YARN_ENABLE_HARDENED_MODE=0 effectively re-enables yarn's hardened mode, which is more secure and aligns with the PR objective.

.github/workflows/sentry-release.yml (3)

Line range hint 8-9: LGTM! Consistent security improvements.

Security changes are consistent with contracts-testing.yml and include:

  • Added explicit permissions following least privilege
  • Pinned harden-runner to specific commit
  • Updated allowed-endpoints list with legitimate yarn and GitHub endpoints

Also applies to: 20-34

🧰 Tools
🪛 actionlint (1.7.4)

71-71: shellcheck reported issue in this script: SC2002:style:1:22: Useless cat. Consider 'cmd < file | ..' or 'cmd file | ..' instead

(shellcheck)

🪛 yamllint (1.35.1)

[warning] 19-19: wrong indentation: expected 6 but found 4

(indentation)


[error] 45-45: trailing spaces

(trailing-spaces)


[error] 49-49: trailing spaces

(trailing-spaces)


[error] 51-51: trailing spaces

(trailing-spaces)


[error] 57-57: trailing spaces

(trailing-spaces)


40-50: LGTM! Improved build reproducibility.

Good improvements in the setup:

  • Pinned yarn to specific version (4.5.1)
  • Added Node.js 20.x with proper yarn caching
🧰 Tools
🪛 yamllint (1.35.1)

[error] 45-45: trailing spaces

(trailing-spaces)


[error] 49-49: trailing spaces

(trailing-spaces)


53-62: LGTM! Proper cache configuration.

Cache configuration is well structured with:

  • Correct paths for npm and node_modules
  • Proper cache key format including version and lockfiles
🧰 Tools
🪛 yamllint (1.35.1)

[error] 57-57: trailing spaces

(trailing-spaces)

Copy link

netlify bot commented Jan 14, 2025

Deploy Preview for kleros-v2-testnet-devtools failed. Why did it fail? →

Name Link
🔨 Latest commit e65377f
🔍 Latest deploy log https://app.netlify.com/sites/kleros-v2-testnet-devtools/deploys/6786b1a4c42d0600089154df

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Type: Maintenance 🚧 Type: Toolchain ⚒️ Build tools configuration, CI/CD
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant