diff --git a/.github/dependabot.yml b/.github/dependabot.yml index 84da8d0..3276bbb 100644 --- a/.github/dependabot.yml +++ b/.github/dependabot.yml @@ -1,11 +1,36 @@ version: 2 updates: - - package-ecosystem: github-actions - directory: / - schedule: - interval: weekly - - package-ecosystem: docker directory: / schedule: interval: weekly + groups: + docker-minor: + update-types: + - minor + - patch + + - package-ecosystem: github-actions + directory: / + schedule: + interval: weekly + groups: + actions-minor: + update-types: + - minor + - patch + + - package-ecosystem: npm + directory: / + schedule: + interval: weekly + groups: + npm-development: + dependency-type: development + update-types: + - minor + - patch + npm-production: + dependency-type: production + update-types: + - patch diff --git a/.github/workflows/check-dist.yml b/.github/workflows/check-dist.yml index 74c8dca..f849ed3 100644 --- a/.github/workflows/check-dist.yml +++ b/.github/workflows/check-dist.yml @@ -1,42 +1,38 @@ -# In TypeScript actions, `dist/index.js` is a special file. When you reference -# an action with `uses:`, `dist/index.js` is the code that will be run. For this -# project, the `dist/index.js` file is generated from other source files through -# the build process. We need to make sure that the checked-in `dist/index.js` -# file matches what is expected from the build. +# In TypeScript actions, `dist/` is a special directory. When you reference +# an action with the `uses:` property, `dist/index.js` is the code that will be +# run. For this project, the `dist/index.js` file is transpiled from other +# source files. This workflow ensures the `dist/` directory contains the +# expected transpiled code. # -# This workflow will fail if the checked-in `dist/index.js` file does not match -# what is expected from the build. -name: Check dist/ +# If this workflow is run from a feature branch, it will act as an additional CI +# check and fail if the checked-in `dist/` directory does not match what is +# expected from the build. +name: Check Transpiled JavaScript on: push: branches: - main - paths-ignore: - - '**.md' pull_request: - paths-ignore: - - '**.md' - workflow_dispatch: + +permissions: + contents: read jobs: check-dist: name: Check dist/ runs-on: ubuntu-latest - permissions: - contents: read - statuses: write - steps: - name: Checkout id: checkout uses: actions/checkout@v4 - name: Setup Node.js + id: setup-node uses: actions/setup-node@v4 with: - node-version: 20 + node-version-file: .node-version cache: npm - name: Install Dependencies @@ -47,7 +43,8 @@ jobs: id: build run: npm run bundle - - name: Compare Expected and Actual Directories + # This will fail the workflow if the PR wasn't created by Dependabot. + - name: Compare Directories id: diff run: | if [ "$(git diff --ignore-space-at-eol --text dist/ | wc -l)" -gt "0" ]; then @@ -56,10 +53,12 @@ jobs: exit 1 fi - # If index.js was different than expected, upload the expected version as - # a workflow artifact. - - uses: actions/upload-artifact@v3 - if: ${{ failure() && steps.diff.conclusion == 'failure' }} + # If `dist/` was different than expected, and this was not a Dependabot + # PR, upload the expected version as a workflow artifact. + - if: ${{ failure() && steps.diff.outcome == 'failure' }} + name: Upload Artifact + id: upload + uses: actions/upload-artifact@v3 with: name: dist path: dist/ diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index ea44f8f..70d5273 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -2,12 +2,13 @@ name: Continuous Integration on: pull_request: - branches: - - main push: branches: - main +permissions: + contents: read + jobs: test-typescript: name: TypeScript Tests @@ -22,7 +23,7 @@ jobs: id: setup-node uses: actions/setup-node@v4 with: - node-version: 20 + node-version-file: .node-version cache: npm - name: Install Dependencies diff --git a/.github/workflows/linter.yml b/.github/workflows/linter.yml index 29131a5..dafff7b 100644 --- a/.github/workflows/linter.yml +++ b/.github/workflows/linter.yml @@ -1,23 +1,21 @@ -name: Lint Code Base +name: Lint Codebase on: pull_request: - branches: - - main push: branches: - main +permissions: + contents: read + packages: read + statuses: write + jobs: lint: - name: Lint Code Base + name: Lint Codebase runs-on: ubuntu-latest - permissions: - contents: read - packages: read - statuses: write - steps: - name: Checkout id: checkout @@ -27,14 +25,14 @@ jobs: id: setup-node uses: actions/setup-node@v4 with: - node-version: 20 + node-version-file: .node-version cache: npm - name: Install Dependencies id: install run: npm ci - - name: Lint Code Base + - name: Lint Codebase id: super-linter uses: super-linter/super-linter/slim@v5 env: diff --git a/.node-version b/.node-version new file mode 100644 index 0000000..1cc433a --- /dev/null +++ b/.node-version @@ -0,0 +1 @@ +20.6.0