Skip to content

fix: contracts testing workflow failure due to kleros-app resolution in yarn hardened mode #1832

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
Jan 14, 2025

Conversation

jaybuidl
Copy link
Member

@jaybuidl jaybuidl commented Jan 13, 2025

PR-Codex overview

This PR updates the GitHub Actions workflow for a Node.js project, changing the Node.js version, adding corepack setup for Yarn, and modifying the installation command for contract dependencies.

Detailed summary

  • Deleted .github/workflows/pr-labels.yml and .github/workflows/contracts-testing.yml.
  • Added steps to set up corepack for Yarn.
  • Updated Node.js version from 18.x to 20.x.
  • Changed cache strategy to include yarn.
  • Modified the command for installing contract dependencies to disable hardened mode.

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

Summary by CodeRabbit

  • Chores
    • Updated GitHub Actions workflow configuration
    • Set specific Yarn version for dependency installation
    • Added read permissions for workflow contents
    • Updated Node.js version to 20.x for the environment setup
    • Modified installation command to include an environment variable for hardened mode
    • Introduced a new step for setting up Corepack
    • Removed the workflow for automating PR label management

Copy link
Contributor

coderabbitai bot commented Jan 13, 2025

Caution

Review failed

The pull request is closed.

Walkthrough

The pull request modifies the GitHub Actions workflows by adding a permissions section for content read access and updating the dependency installation process. The workflow for contracts testing now explicitly sets the Yarn version to 4.5.1 before installing dependencies for the Kleros V2 contracts workspace. Additionally, the Node.js version has been updated to 20.x, and a new step for setting up Corepack has been introduced. The .github/workflows/pr-labels.yml file has been deleted, which previously automated the labeling of pull requests.

Changes

File Change Summary
.github/workflows/contracts-testing.yml - Added permissions: contents: read section
- Introduced setup step for Corepack and Yarn version 4.5.1
- Updated Node.js version from 18.x to 20.x
- Modified installation command to include YARN_ENABLE_HARDENED_MODE=0
.github/workflows/pr-labels.yml - Deleted file that defined a workflow for automatically adding labels to PRs

Possibly related PRs

  • [StepSecurity] ci: Harden GitHub Actions #1735: The changes in this PR also involve adding a permissions section in a GitHub Actions workflow, similar to the main PR's modifications in the .github/workflows/contracts-testing.yml file.

Suggested labels

Type: Maintenance :construction:

Poem

🐰 Yarn's version, now precise and neat,
In workflows where contracts compete,
Four-point-five-one, a rabbit's delight,
Permissions granted, testing set right!
GitHub Actions, hopping with glee 🚀


📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between e6a3f23 and b371250.

📒 Files selected for processing (2)
  • .github/workflows/contracts-testing.yml (2 hunks)
  • .github/workflows/pr-labels.yml (0 hunks)

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

Copy link

netlify bot commented Jan 13, 2025

Deploy Preview for kleros-v2-testnet ready!

Name Link
🔨 Latest commit ab20ca0
🔍 Latest deploy log https://app.netlify.com/sites/kleros-v2-testnet/deploys/67866461c68b150008310359
😎 Deploy Preview https://deploy-preview-1832--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

netlify bot commented Jan 13, 2025

Deploy Preview for kleros-v2-testnet-devtools ready!

Name Link
🔨 Latest commit ab20ca0
🔍 Latest deploy log https://app.netlify.com/sites/kleros-v2-testnet-devtools/deploys/67866461dcc8c50008a9adc0
😎 Deploy Preview https://deploy-preview-1832--kleros-v2-testnet-devtools.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 13, 2025

Deploy Preview for kleros-v2-university ready!

Name Link
🔨 Latest commit ab20ca0
🔍 Latest deploy log https://app.netlify.com/sites/kleros-v2-university/deploys/678664616275f0000858d0fd
😎 Deploy Preview https://deploy-preview-1832--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.

coderabbitai[bot]
coderabbitai bot previously approved these changes Jan 13, 2025
Copy link

netlify bot commented Jan 13, 2025

Deploy Preview for kleros-v2-neo ready!

Name Link
🔨 Latest commit ab20ca0
🔍 Latest deploy log https://app.netlify.com/sites/kleros-v2-neo/deploys/67866461a3d0810008ec6ab2
😎 Deploy Preview https://deploy-preview-1832--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.

coderabbitai[bot]
coderabbitai bot previously approved these changes Jan 13, 2025
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/contracts-testing.yml (2)

46-50: LGTM! Good package manager configuration.

Explicitly setting up Corepack and pinning the Yarn version to 4.5.1 ensures consistent and reproducible builds.

Remove trailing spaces at line 51 to satisfy the linter.


52-56: LGTM! Good Node.js configuration.

Upgrading to Node.js 20.x (LTS) and enabling Yarn caching will improve workflow performance.

Remove trailing spaces at lines 55 and 57 to satisfy the linter.

🧰 Tools
🪛 yamllint (1.35.1)

[error] 55-55: 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 4eafbbb and e6a3f23.

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

[error] 51-51: trailing spaces

(trailing-spaces)


[error] 55-55: trailing spaces

(trailing-spaces)


[error] 57-57: trailing spaces

(trailing-spaces)

⏰ Context from checks skipped due to timeout of 90000ms (16)
  • 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: Redirect rules - kleros-v2-testnet
  • GitHub Check: Redirect rules - kleros-v2-testnet
  • GitHub Check: Header rules - kleros-v2-university
  • GitHub Check: Header rules - kleros-v2-testnet
  • GitHub Check: Header rules - kleros-v2-testnet
  • GitHub Check: Pages changed - kleros-v2-university
  • GitHub Check: Pages changed - kleros-v2-testnet
  • GitHub Check: Pages changed - kleros-v2-testnet
  • GitHub Check: Copy labels from linked issues
  • GitHub Check: contracts-testing
  • GitHub Check: dependency-review
  • GitHub Check: Analyze (javascript)
🔇 Additional comments (3)
.github/workflows/contracts-testing.yml (3)

Line range hint 19-20: LGTM! Good security practice.

Adding explicit read-only permissions follows the principle of least privilege, which is a security best practice for GitHub Actions workflows.

🧰 Tools
🪛 yamllint (1.35.1)

[error] 41-41: trailing spaces

(trailing-spaces)


[error] 51-51: trailing spaces

(trailing-spaces)


[error] 55-55: trailing spaces

(trailing-spaces)


[error] 57-57: trailing spaces

(trailing-spaces)


71-73: Track the temporary hardened mode disable.

Disabling Yarn's hardened mode is a temporary workaround. While this fixes the immediate issue, it's important to:

  1. Create a tracking issue for re-enabling hardened mode
  2. Investigate and fix the underlying kleros-app resolution issue

Would you like me to:

  1. Create a GitHub issue to track re-enabling hardened mode?
  2. Help investigate the kleros-app resolution issue?

Line range hint 1-93: Verify the complete workflow execution.

The changes look good overall, but let's verify the workflow runs successfully with these updates:

  1. Node.js 20.x compatibility with all dependencies
  2. Yarn 4.5.1 compatibility with the workspace setup
  3. Impact of disabled hardened mode on security

Run this workflow with workflow_dispatch to validate the changes:

✅ Verification successful

Workflow configuration verified successfully

The workflow configuration is correct and compatible with all dependencies:

  • Node.js 20.x meets the contracts requirement of >=16.0.0
  • Yarn 4.5.1 is properly set up with workspace support
  • Temporary hardened mode disable is scoped only to contracts workspace for dependency resolution
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

gh workflow run contracts-testing.yml

Length of output: 216


Script:

#!/bin/bash
# Check workspace and dependency configuration
echo "=== Package.json and Yarn Configuration ==="
fd -t f "package.json|.yarnrc.yml" -x cat {}

echo -e "\n=== Contracts Workspace Configuration ==="
fd -t f "package.json" -p "contracts" -x cat {}

Length of output: 35417

🧰 Tools
🪛 yamllint (1.35.1)

[error] 41-41: trailing spaces

(trailing-spaces)


[error] 51-51: trailing spaces

(trailing-spaces)


[error] 55-55: trailing spaces

(trailing-spaces)


[error] 57-57: trailing spaces

(trailing-spaces)

coderabbitai[bot]
coderabbitai bot previously approved these changes Jan 14, 2025
@jaybuidl jaybuidl added Type: Bug 🐛 Type: Toolchain ⚒️ Build tools configuration, CI/CD labels Jan 14, 2025
@jaybuidl jaybuidl changed the title fix: contracts testing workflow fix: contracts testing workflow failure due to kleros-app resolution in yarn hardened mode Jan 14, 2025
@jaybuidl jaybuidl force-pushed the fix/contract-testing-workflow branch from 64759c4 to ab20ca0 Compare January 14, 2025 13:19
Copy link

codeclimate bot commented Jan 14, 2025

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

View more on Code Climate.

@jaybuidl jaybuidl changed the base branch from dev to fix/kleros-app-resolution January 14, 2025 16:47
@jaybuidl jaybuidl marked this pull request as ready for review January 14, 2025 16:47
@jaybuidl jaybuidl force-pushed the fix/contract-testing-workflow branch from ab20ca0 to b371250 Compare January 14, 2025 16:48
@jaybuidl jaybuidl merged commit b371250 into fix/kleros-app-resolution Jan 14, 2025
4 of 5 checks passed
@jaybuidl jaybuidl deleted the fix/contract-testing-workflow branch January 14, 2025 16:49
Copy link

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

Successfully merging this pull request may close these issues.

1 participant