From b3d5d9cf7fec9cc49de2e3abd73071a202eadb0a Mon Sep 17 00:00:00 2001 From: Fran Mulero Date: Thu, 27 Oct 2022 12:51:41 +0200 Subject: [PATCH 1/4] Add check-dist following the same approach as in https://github.com/actions/ Signed-off-by: Fran Mulero --- .github/workflows/check-dist.yaml | 53 +++++++++++++++++++++++++++++++ package.json | 1 + 2 files changed, 54 insertions(+) create mode 100644 .github/workflows/check-dist.yaml diff --git a/.github/workflows/check-dist.yaml b/.github/workflows/check-dist.yaml new file mode 100644 index 00000000..68b58b3f --- /dev/null +++ b/.github/workflows/check-dist.yaml @@ -0,0 +1,53 @@ +# `dist/index.js` is a special file in Actions. +# When you reference an action with `uses:` in a workflow, +# `index.js` is the code that will run. +# For our project, we generate this file through a build process +# from other source files. +# We need to make sure the checked-in `index.js` actually matches what we expect it to be. +name: Check dist/ + +on: + push: + branches: + - main + paths-ignore: + - '**.md' + pull_request: + paths-ignore: + - '**.md' + workflow_dispatch: +permissions: + +jobs: + check-dist: + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v3 + + - name: Set Node.js 16.x + uses: actions/setup-node@v1 + with: + node-version: 16.x + + - name: Install dependencies + run: npm ci + + - name: Rebuild the dist/ directory + run: npm run build-dist + + - name: Compare the expected and actual dist/ directories + run: | + if [ "$(git diff --ignore-space-at-eol dist/ | wc -l)" -gt "0" ]; then + echo "Detected uncommitted changes after build. See status below:" + git diff + exit 1 + fi + id: diff + + # If index.js was different than expected, upload the expected version as an artifact + - uses: actions/upload-artifact@v3 + if: ${{ failure() && steps.diff.conclusion == 'failure' }} + with: + name: dist + path: dist/ \ No newline at end of file diff --git a/package.json b/package.json index 3c71ee39..9e6b0666 100644 --- a/package.json +++ b/package.json @@ -11,6 +11,7 @@ "lint": "eslint src/**/*.ts", "package": "ncc build --source-map --license licenses.txt", "test": "jest --detectOpenHandles", + "build-dist": "npm run build && npm run package", "all": "npm run build && npm run format && npm run lint && npm run package && npm test" }, "repository": { From 244ecf731088ead27aaecfafc5c2dfbf35d70ebc Mon Sep 17 00:00:00 2001 From: Fran Mulero Date: Thu, 27 Oct 2022 13:05:57 +0200 Subject: [PATCH 2/4] Amend permissions Signed-off-by: Fran Mulero --- .github/workflows/check-dist.yaml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.github/workflows/check-dist.yaml b/.github/workflows/check-dist.yaml index 68b58b3f..fcefa7bb 100644 --- a/.github/workflows/check-dist.yaml +++ b/.github/workflows/check-dist.yaml @@ -16,7 +16,9 @@ on: paths-ignore: - '**.md' workflow_dispatch: + permissions: + contents: write jobs: check-dist: From b90d0cd0d51b0d7afddcd4c7c8e3e44046b54990 Mon Sep 17 00:00:00 2001 From: Fran Mulero Date: Thu, 27 Oct 2022 13:13:21 +0200 Subject: [PATCH 3/4] Update actions/setup-node action Signed-off-by: Fran Mulero --- .github/workflows/check-dist.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/check-dist.yaml b/.github/workflows/check-dist.yaml index fcefa7bb..9a91af5c 100644 --- a/.github/workflows/check-dist.yaml +++ b/.github/workflows/check-dist.yaml @@ -28,7 +28,7 @@ jobs: - uses: actions/checkout@v3 - name: Set Node.js 16.x - uses: actions/setup-node@v1 + uses: actions/setup-node@v3 with: node-version: 16.x From 90be591044a63abed42ae8c3c2b29730a0ed2094 Mon Sep 17 00:00:00 2001 From: Fran Mulero Date: Thu, 27 Oct 2022 13:21:29 +0200 Subject: [PATCH 4/4] Add cache Signed-off-by: Fran Mulero --- .github/workflows/check-dist.yaml | 7 +++++++ .github/workflows/validate.yaml | 15 +++++++++++---- 2 files changed, 18 insertions(+), 4 deletions(-) diff --git a/.github/workflows/check-dist.yaml b/.github/workflows/check-dist.yaml index 9a91af5c..d3b3dce1 100644 --- a/.github/workflows/check-dist.yaml +++ b/.github/workflows/check-dist.yaml @@ -32,6 +32,13 @@ jobs: with: node-version: 16.x + - name: Cache dependencies + uses: actions/cache@v3 + with: + path: ~/.npm + key: npm-${{ hashFiles('package-lock.json') }} + restore-keys: npm- + - name: Install dependencies run: npm ci diff --git a/.github/workflows/validate.yaml b/.github/workflows/validate.yaml index c9d3f3fb..6f7885c3 100644 --- a/.github/workflows/validate.yaml +++ b/.github/workflows/validate.yaml @@ -1,15 +1,15 @@ name: Validate on: - push: + push: branches: - main pull_request: branches: - main types: - - assigned - - opened - - synchronize + - assigned + - opened + - synchronize - reopened env: CSP_API_URL: https://console.cloud.vmware.com @@ -79,6 +79,13 @@ jobs: with: node-version: 16.x + - name: Cache dependencies + uses: actions/cache@v3 + with: + path: ~/.npm + key: npm-${{ hashFiles('package-lock.json') }} + restore-keys: npm- + - name: Install dependencies run: npm ci