Skip to content

Conversation

@Addausi
Copy link

@Addausi Addausi commented Dec 26, 2025

Description

Issue(s) fixed

Fixes #

Preview

Checklist

  • If this PR updates or adds documentation content that changes or adds technical meaning, it has received an approval from an engineer or DevRel from the relevant team.
  • If this PR updates or adds documentation content, it has received an approval from a technical writer.

External contributor checklist

  • I've read the contribution guidelines.
  • I've created a new issue (or assigned myself to an existing issue) describing what this PR addresses.

Note

Introduces CI/CD and project metadata setup.

  • CI: Adds GitHub Actions workflows: npm-grunt.yml to build with Grunt across Node 18.x/20.x/22.x, and npm-publish-github-packages.yml to run tests on release and publish to GitHub Packages
  • Dev environment: Adds .devcontainer/devcontainer.json using mcr.microsoft.com/devcontainers/universal:2
  • Docs/Security: Adds SECURITY.md with supported versions and vulnerability reporting guidance

Written by Cursor Bugbot for commit c890c76. This will update automatically on new commits. Configure here.

@Addausi Addausi requested review from a team as code owners December 26, 2025 02:12
@vercel
Copy link

vercel bot commented Dec 26, 2025

@Addausi is attempting to deploy a commit to the Consensys Team on Vercel.

A member of the Team first needs to authorize it.

- run: npm ci
- run: npm publish
env:
NODE_AUTH_TOKEN: ${{secrets.GITHUB_TOKEN}}
Copy link

Choose a reason for hiding this comment

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

Workflow publishes private package that cannot be published

This workflow attempts to run npm publish to publish the package to GitHub Packages, but package.json has "private": true which prevents npm publishing. This documentation repository is not intended to be published as an npm package. The npm publish command would fail with an error on every release. This appears to be a copy-pasted GitHub workflow template that doesn't apply to this project.

Fix in Cursor Fix in Web

with:
node-version: 20
- run: npm ci
- run: npm test
Copy link

Choose a reason for hiding this comment

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

Workflow calls npm test but no test script exists

The build job runs npm test, but package.json has no test script defined in the scripts section. This would cause the workflow to fail with "missing script: test" error. This further confirms the workflow is a copy-pasted template that wasn't adapted for this project.

Fix in Cursor Fix in Web

- name: Build
run: |
npm install
grunt
Copy link

Choose a reason for hiding this comment

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

Workflow uses Grunt but project doesn't have Grunt

The workflow runs grunt as a build step, but the project is a Docusaurus site with no Grunt dependency. The package.json shows this project uses npm run build (docusaurus build) and has no grunt or grunt-cli packages installed. This workflow will fail immediately when triggered with "command not found: grunt".

Fix in Cursor Fix in Web


strategy:
matrix:
node-version: [18.x, 20.x, 22.x]
Copy link

Choose a reason for hiding this comment

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

Node version matrix conflicts with project's engine requirement

The workflow matrix tests Node versions 18.x, 20.x, and 22.x, but the project's package.json specifies "engines": { "node": "20.x" }. This means 2 out of 3 matrix configurations (18.x and 22.x) run against unsupported Node versions, which could produce misleading CI results - either false passes on unsupported runtimes or failures that aren't actual bugs.

Fix in Cursor Fix in Web

@Addausi
Copy link
Author

Addausi commented Dec 26, 2025

Description

Issue(s) fixed

Fixes #

Preview

Checklist

  • If this PR updates or adds documentation content that changes or adds technical meaning, it has received an approval from an engineer or DevRel from the relevant team.
  • If this PR updates or adds documentation content, it has received an approval from a technical writer.

External contributor checklist

  • I've read the contribution guidelines.
  • I've created a new issue (or assigned myself to an existing issue) describing what this PR addresses.

Note

Introduces CI and release automation plus a basic security policy.

  • Adds npm-grunt GitHub Actions workflow to build with Grunt on push/PR to main using a Node.js matrix (18.x, 20.x, 22.x)
  • Adds npm-publish-github-packages workflow to run build/tests on release creation and publish to GitHub Packages with GITHUB_TOKEN
  • Adds SECURITY.md outlining supported versions and vulnerability reporting guidance

Written by Cursor Bugbot for commit 8d2011e. This will update automatically on new commits. Configure here.


Tell them where to go, how often they can expect to get an update on a
reported vulnerability, what to expect if the vulnerability is accepted or
declined, etc.
Copy link

Choose a reason for hiding this comment

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

SECURITY.md contains unmodified template with wrong versions

This file appears to be a GitHub template that wasn't customized. It references versions 5.1.x, 5.0.x, and 4.0.x, but the actual package version is 1.0.0. The placeholder instructions ("Use this section to tell people...") were left unchanged, which could confuse users trying to report security vulnerabilities.

Fix in Cursor Fix in Web

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.

1 participant