feat(security): Add provenance (#408)

* Enable provenance in package.json * Add necessary permissions to the release workflow * Adapt for sub-packages * style: prettier --------- Co-authored-by: wolfy1339 <webmaster@wolfy1339.com>
octokit · Apr 3, 2024 · fcadeff · fcadeff
1 parent f2fe6f7
commit fcadeff
Show file tree

Hide file tree

Showing 10 changed files with 23 additions and 10 deletions.
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -6,6 +6,13 @@ name: Release
       - next
       - beta
       - "*.x"
+# These are recommended by the semantic-release docs: https://github.com/semantic-release/npm#npm-provenance
+permissions:
+    contents: write # to be able to publish a GitHub release
+    issues: write # to be able to comment on released issues
+    pull-requests: write # to be able to comment on released pull requests
+    id-token: write # to enable use of OIDC for npm provenance
+
 jobs:
   release:
     name: release

diff --git a/package.json b/package.json
@@ -1,8 +1,6 @@
 {
   "name": "@octokit/openapi-types",
-  "publishConfig": {
-    "access": "public"
-  },
+  "private": true,
   "version": "0.0.0-development",
   "description": "Generated TypeScript definitions based on GitHub's OpenAPI spec for https://api.github.com",
   "repository": "github:octokit/openapi-types.ts",

diff --git a/packages/openapi-types-ghec/package.json b/packages/openapi-types-ghec/package.json
@@ -7,7 +7,8 @@
     "directory": "packages/openapi-types-ghec"
   },
   "publishConfig": {
-    "access": "public"
+    "access": "public",
+    "provenance": true
   },
   "version": "0.0.0-development",
   "main": "",

diff --git a/packages/openapi-types-ghes-3.10/package.json b/packages/openapi-types-ghes-3.10/package.json
@@ -7,7 +7,8 @@
     "directory": "packages/openapi-types-ghes-3.10"
   },
   "publishConfig": {
-    "access": "public"
+    "access": "public",
+    "provenance": true
   },
   "version": "0.0.0-development",
   "main": "",

diff --git a/packages/openapi-types-ghes-3.11/package.json b/packages/openapi-types-ghes-3.11/package.json
@@ -7,7 +7,8 @@
     "directory": "packages/openapi-types-ghes-3.11"
   },
   "publishConfig": {
-    "access": "public"
+    "access": "public",
+    "provenance": true
   },
   "version": "0.0.0-development",
   "main": "",

diff --git a/packages/openapi-types-ghes-3.12/package.json b/packages/openapi-types-ghes-3.12/package.json
@@ -7,7 +7,8 @@
     "directory": "packages/openapi-types-ghes-3.12"
   },
   "publishConfig": {
-    "access": "public"
+    "access": "public",
+    "provenance": true
   },
   "version": "0.0.0-development",
   "main": "",

diff --git a/packages/openapi-types-ghes-3.9/package.json b/packages/openapi-types-ghes-3.9/package.json
@@ -7,7 +7,8 @@
     "directory": "packages/openapi-types-ghes-3.9"
   },
   "publishConfig": {
-    "access": "public"
+    "access": "public",
+    "provenance": true
   },
   "version": "0.0.0-development",
   "main": "",

diff --git a/packages/openapi-types-github.ae/package.json b/packages/openapi-types-github.ae/package.json
@@ -7,7 +7,8 @@
     "directory": "packages/openapi-types-github.ae"
   },
   "publishConfig": {
-    "access": "public"
+    "access": "public",
+    "provenance": true
   },
   "version": "0.0.0-development",
   "main": "",

diff --git a/packages/openapi-types/package.json b/packages/openapi-types/package.json
@@ -7,7 +7,8 @@
     "directory": "packages/openapi-types"
   },
   "publishConfig": {
-    "access": "public"
+    "access": "public",
+    "provenance": true
   },
   "version": "0.0.0-development",
   "main": "",

diff --git a/scripts/generate-types.js b/scripts/generate-types.js
@@ -13,6 +13,7 @@ run();
 const packageDefaults = {
   publishConfig: {
     access: "public",
+    provenance: true,
   },
   version: "0.0.0-development",
   main: "",