Skip to content

Commit eeacb32

Browse files
UlisesGasconstep-security-bot
UlisesGascon
and
step-security-bot
authored
ci: apply security best practices (#578)
Co-authored-by: StepSecurity Bot <[email protected]>
1 parent 61cd83b commit eeacb32

9 files changed

+214
-18
lines changed

‎.github/workflows/ci.yml

+5-2
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,9 @@ on:
1111
branches:
1212
- '*'
1313

14+
permissions:
15+
contents: read
16+
1417
jobs:
1518
build:
1619
if: >-
@@ -24,8 +27,8 @@ jobs:
2427
os: [ubuntu-latest, windows-latest, macos-latest]
2528
node-version: [18, 20]
2629
steps:
27-
- uses: actions/checkout@v4
28-
- uses: actions/setup-node@v4
30+
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
31+
- uses: actions/setup-node@1d0ff469b7ec7b3cb9d8673fde0c81c44821de2a # v4.2.0
2932
with:
3033
node-version: ${{ matrix.node-version }}
3134
cache: 'npm'

‎.github/workflows/codeql.yml

+73
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
# For most projects, this workflow file will not need changing; you simply need
2+
# to commit it to your repository.
3+
#
4+
# You may wish to alter this file to override the set of languages analyzed,
5+
# or to provide custom queries or build logic.
6+
#
7+
# ******** NOTE ********
8+
# We have attempted to detect the languages in your repository. Please check
9+
# the `language` matrix defined below to confirm you have the correct set of
10+
# supported CodeQL languages.
11+
#
12+
name: "CodeQL"
13+
14+
on:
15+
push:
16+
branches: ["main"]
17+
pull_request:
18+
# The branches below must be a subset of the branches above
19+
branches: ["main"]
20+
schedule:
21+
- cron: "0 0 * * 1"
22+
23+
permissions:
24+
contents: read
25+
26+
jobs:
27+
analyze:
28+
name: Analyze
29+
runs-on: ubuntu-latest
30+
permissions:
31+
actions: read
32+
contents: read
33+
security-events: write
34+
35+
strategy:
36+
fail-fast: false
37+
matrix:
38+
language: ["javascript", "typescript"]
39+
# CodeQL supports [ $supported-codeql-languages ]
40+
# Learn more about CodeQL language support at https://aka.ms/codeql-docs/language-support
41+
42+
steps:
43+
- name: Checkout repository
44+
uses: actions/checkout@v4
45+
46+
# Initializes the CodeQL tools for scanning.
47+
- name: Initialize CodeQL
48+
uses: github/codeql-action/init@v3
49+
with:
50+
languages: ${{ matrix.language }}
51+
# If you wish to specify custom queries, you can do so here or in a config file.
52+
# By default, queries listed here will override any specified in a config file.
53+
# Prefix the list here with "+" to use these queries and those in the config file.
54+
55+
# Autobuild attempts to build any compiled languages (C/C++, C#, or Java).
56+
# If this step fails, then you should remove it and run the build manually (see below)
57+
- name: Autobuild
58+
uses: github/codeql-action/autobuild@v3
59+
60+
# ℹ️ Command-line programs to run using the OS shell.
61+
# 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
62+
63+
# If the Autobuild fails above, remove it and uncomment the following three lines.
64+
# modify them (or add more) to build your code if your project, please refer to the EXAMPLE below for guidance.
65+
66+
# - run: |
67+
# echo "Run, Build Application using script"
68+
# ./location_of_script_within_repo/buildscript.sh
69+
70+
- name: Perform CodeQL Analysis
71+
uses: github/codeql-action/analyze@v3
72+
with:
73+
category: "/language:${{matrix.language}}"

‎.github/workflows/dependency-review.yml

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# Dependency Review Action
2+
#
3+
# This Action will scan dependency manifest files that change as part of a Pull Request,
4+
# surfacing known-vulnerable versions of the packages declared or updated in the PR.
5+
# Once installed, if the workflow run is marked as required,
6+
# PRs introducing known-vulnerable packages will be blocked from merging.
7+
#
8+
# Source repository: https://github.com/actions/dependency-review-action
9+
name: 'Dependency Review'
10+
on: [pull_request]
11+
12+
permissions:
13+
contents: read
14+
15+
jobs:
16+
dependency-review:
17+
runs-on: ubuntu-latest
18+
steps:
19+
- name: 'Checkout Repository'
20+
uses: actions/checkout@v4
21+
- name: 'Dependency Review'
22+
uses: actions/dependency-review-action@v4

‎.github/workflows/gh_pages.yml

+13-6
Original file line numberDiff line numberDiff line change
@@ -11,22 +11,29 @@ on:
1111
description: 'Destination path to generate'
1212
required: false
1313

14+
permissions:
15+
contents: write # for peter-evans/create-pull-request to create branch
16+
pull-requests: write # for peter-evans/create-pull-request to create a PR
17+
1418
jobs:
1519
build:
20+
permissions:
21+
contents: write # for peter-evans/create-pull-request to create branch
22+
pull-requests: write # for peter-evans/create-pull-request to create a PR
1623
name: Update api docs
1724
runs-on: ubuntu-latest
1825
steps:
19-
- uses: actions/setup-node@v4
26+
- uses: actions/setup-node@1d0ff469b7ec7b3cb9d8673fde0c81c44821de2a # v4.2.0
2027
- run: npm install -g npm@latest
2128
continue-on-error: true
22-
- uses: actions/checkout@v4
29+
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
2330
with:
2431
path: source
25-
- uses: actions/checkout@v4
32+
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
2633
with:
2734
ref: gh-pages
2835
path: yeoman-environment-doc
29-
- uses: actions/cache@v4
36+
- uses: actions/cache@1bd1e32a3bdc45362d1e726936510720a7c30a57 # v4.2.0
3037
with:
3138
path: ~/.npm
3239
key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}-gh-pages
@@ -42,13 +49,13 @@ jobs:
4249
if: always()
4350
run: |
4451
git add .
45-
git config --local user.email ""
52+
git config --local user.email "github-actions[bot]@users.noreply.github.com"
4653
git config --local user.name "Github Actions"
4754
git commit -a -m "Update api for ${{github.event.release.name}}" || true
4855
- name: Create Pull Request
4956
if: always()
5057
id: cpr
51-
uses: peter-evans/[email protected]
58+
uses: peter-evans/create-pull-request@67ccf781d68cd99b580ae25a5c18a1cc84ffff1f # v7.0.6
5259
with:
5360
token: ${{ secrets.GITHUB_TOKEN }}
5461
commit-message: 'Update api for ${{github.event.release.name}}'

‎.github/workflows/integration.yml

+8-5
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,9 @@ on:
88
branches:
99
- 'ignore'
1010

11+
permissions:
12+
contents: read
13+
1114
jobs:
1215
build:
1316
runs-on: ${{ matrix.os }}
@@ -19,27 +22,27 @@ jobs:
1922

2023
steps:
2124
- name: Checkout yeoman-test
22-
uses: actions/checkout@v4
25+
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
2326
with:
2427
repository: yeoman/yeoman-test
2528
path: yeoman-test
2629

2730
- name: Checkout yeoman-generator
28-
uses: actions/checkout@v4
31+
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
2932
with:
3033
repository: yeoman/generator
3134
path: yeoman-generator
3235

3336
- name: Checkout yeoman-environment
34-
uses: actions/checkout@v4
37+
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
3538
with:
3639
path: yeoman-environment
3740

38-
- uses: actions/setup-node@v4
41+
- uses: actions/setup-node@1d0ff469b7ec7b3cb9d8673fde0c81c44821de2a # v4.2.0
3942
with:
4043
node-version: ${{ matrix.node-version }}
4144

42-
- uses: actions/cache@v4
45+
- uses: actions/cache@1bd1e32a3bdc45362d1e726936510720a7c30a57 # v4.2.0
4346
with:
4447
path: ~/.npm
4548
key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}-integration

‎.github/workflows/lock-maintenance.yml

+9-3
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,19 @@ name: Package lock maintenance
22
on:
33
workflow_dispatch:
44

5+
permissions:
6+
contents: read
7+
58
jobs:
69
build:
10+
permissions:
11+
contents: write # for peter-evans/create-pull-request to create branch
12+
pull-requests: write # for peter-evans/create-pull-request to create a PR
713
name: Bump transitional dependencies
814
runs-on: ubuntu-latest
915
steps:
10-
- uses: actions/checkout@v4
11-
- uses: actions/setup-node@v4
16+
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
17+
- uses: actions/setup-node@1d0ff469b7ec7b3cb9d8673fde0c81c44821de2a # v4.2.0
1218
with:
1319
node-version: '18'
1420
cache: 'npm'
@@ -18,7 +24,7 @@ jobs:
1824
npm install
1925
npm install # make sure package-lock.json is correct
2026
- name: Create Pull Request
21-
uses: peter-evans/[email protected]
27+
uses: peter-evans/create-pull-request@67ccf781d68cd99b580ae25a5c18a1cc84ffff1f # v7.0.6
2228
with:
2329
token: ${{ secrets.GITHUB_TOKEN }}
2430
commit-message: 'Bump transitional dependencies'

‎.github/workflows/scorecards.yml

+76
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
# This workflow uses actions that are not certified by GitHub. They are provided
2+
# by a third-party and are governed by separate terms of service, privacy
3+
# policy, and support documentation.
4+
5+
name: Scorecard supply-chain security
6+
on:
7+
# For Branch-Protection check. Only the default branch is supported. See
8+
# https://github.com/ossf/scorecard/blob/main/docs/checks.md#branch-protection
9+
branch_protection_rule:
10+
# To guarantee Maintained check is occasionally updated. See
11+
# https://github.com/ossf/scorecard/blob/main/docs/checks.md#maintained
12+
schedule:
13+
- cron: '20 7 * * 2'
14+
push:
15+
branches: ["main"]
16+
17+
# Declare default permissions as read only.
18+
permissions: read-all
19+
20+
jobs:
21+
analysis:
22+
name: Scorecard analysis
23+
runs-on: ubuntu-latest
24+
permissions:
25+
# Needed to upload the results to code-scanning dashboard.
26+
security-events: write
27+
# Needed to publish results and get a badge (see publish_results below).
28+
id-token: write
29+
contents: read
30+
actions: read
31+
# To allow GraphQL ListCommits to work
32+
issues: read
33+
pull-requests: read
34+
# To detect SAST tools
35+
checks: read
36+
37+
steps:
38+
- name: "Checkout code"
39+
uses: actions/checkout@v4
40+
with:
41+
persist-credentials: false
42+
43+
- name: "Run analysis"
44+
uses: ossf/scorecard-action@62b2cac7ed8198b15735ed49ab1e5cf35480ba46 # v2.4.0
45+
with:
46+
results_file: results.sarif
47+
results_format: sarif
48+
# (Optional) "write" PAT token. Uncomment the `repo_token` line below if:
49+
# - you want to enable the Branch-Protection check on a *public* repository, or
50+
# - you are installing Scorecards on a *private* repository
51+
# To create the PAT, follow the steps in https://github.com/ossf/scorecard-action#authentication-with-pat.
52+
# repo_token: ${{ secrets.SCORECARD_TOKEN }}
53+
54+
# Public repositories:
55+
# - Publish results to OpenSSF REST API for easy access by consumers
56+
# - Allows the repository to include the Scorecard badge.
57+
# - See https://github.com/ossf/scorecard-action#publishing-results.
58+
# For private repositories:
59+
# - `publish_results` will always be set to `false`, regardless
60+
# of the value entered here.
61+
publish_results: true
62+
63+
# Upload the results as artifacts (optional). Commenting out will disable uploads of run results in SARIF
64+
# format to the repository Actions tab.
65+
- name: "Upload artifact"
66+
uses: actions/upload-artifact@v4
67+
with:
68+
name: SARIF file
69+
path: results.sarif
70+
retention-days: 5
71+
72+
# Upload the results to GitHub's code scanning dashboard.
73+
- name: "Upload to code-scanning"
74+
uses: github/codeql-action/upload-sarif@v3
75+
with:
76+
sarif_file: results.sarif

‎.github/workflows/stale.yml

+7-1
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,17 @@ on:
33
schedule:
44
- cron: '0 0 * * *'
55

6+
permissions:
7+
contents: read
8+
69
jobs:
710
stale:
11+
permissions:
12+
issues: write # for actions/stale to close stale issues
13+
pull-requests: write # for actions/stale to close stale PRs
814
runs-on: ubuntu-latest
915
steps:
10-
- uses: actions/stale@v9
16+
- uses: actions/stale@5bef64f19d7facfb25b37b414482c7164d639639 # v9.1.0
1117
with:
1218
repo-token: ${{ secrets.GITHUB_TOKEN }}
1319
stale-issue-message: 'This issue is stale because it has been open with no activity. Remove stale label or comment or this will be closed'

‎.github/workflows/triage.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ jobs:
66
apply-label:
77
runs-on: ubuntu-latest
88
steps:
9-
- uses: actions/github-script@v7
9+
- uses: actions/github-script@60a0d83039c74a4aee543508d2ffcb1c3799cdea # v7.0.1
1010
with:
1111
github-token: ${{secrets.GITHUB_TOKEN}}
1212
script: |

0 commit comments

Comments
 (0)