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

add a rule to force GH Actions to use same node version as package.json #231

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions rule-types/github/force_package_json_for_node_version.test.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
tests:
- name: "Should have node version file configured"
def: {}
params: {}
expect: "pass"
git:
repo_base: correct
- name: "Should fail when the user manually specified node version in GH Actions"
def: {}
params: {}
expect: "fail"
git:
repo_base: misconfigured
- name: "Should pass when there are no GH Actions at all"
def: {}
params: {}
expect: "pass"
git: {}
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
name: NodeJS with Gulp
'on':
push:
branches:
- master
pull_request:
branches:
- master
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Use Node.js
uses: actions/setup-node@v3
with:
node-version-file: package.json
- name: Build
run: |
npm install
gulp

Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
name: NodeJS with Gulp
'on':
push:
branches:
- master
pull_request:
branches:
- master
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Use Node.js
uses: actions/setup-node@v3
with:
node-version: 22
- name: Build
run: |
npm install
gulp

77 changes: 77 additions & 0 deletions rule-types/github/force_package_json_for_node_version.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@
---
version: v1
release_phase: alpha
type: rule-type
name: force_package_json_for_node_version
display_name: Force GitHub Actions to use the node version specified in package.json
short_failure_message: GitHub Actions need to specify node version using `node-version-file`
severity:
value: medium
context: {}
description: |
Verifies that the Node version used in GitHub Actions workflow files is the same as the one specified
in `package.json`. This ensures that the application is tested with the same Node version in GitHub Actions
that it is meant to be locally developed with.
guidance: |
To make sure you are running GitHub Actions with the same Node version that your application is meant
to be developed and deploy with, one step you can take is manage your Node version through `package.json`.

In the `actions/setup-node` GitHub Action, you can use the `node-version-file` input set to `package.json`.
This helps establish a single source of truth for the Node version.

For more information, check out `actions/setup-node`'s [documentation](https://github.com/actions/setup-node/blob/main/docs/advanced-usage.md#node-version-file).

This approach is recommended for Node applications that are meant to be deployed in the cloud directly,
but might not be as well suited for libraries that need to be tested against various different versions of Node.
def:
in_entity: repository
rule_schema:
type: object
properties: {}
ingest:
type: git
git: {}
eval:
type: rego
rego:
type: deny-by-default
def: |
package minder
import future.keywords.if
import future.keywords.every

default message := "For GitHub Actions workflows, Node version has to be specified through the `node-version-file` argument."
default allow := false

workflows := file.ls(".github/workflows/")

all_args[args] {
some w

file.read(workflows[w])
workflowstr := file.read(workflows[w])
workflow := parse_yaml(workflowstr)

some job_id
job := workflow.jobs[job_id]

some step_id
step := job.steps[step_id]

startswith(step.uses, "actions/setup-node@")

args := step["with"]
}

allow if {
every args in all_args {
print(args)
args["node-version-file"] == "package.json"
not args["node-version"]
}
}

message := "" if allow
alert:
type: security_advisory
security_advisory: {}
Loading