From fcadeff4048d3e3f1faef6bf963cbc9dcfeded2a Mon Sep 17 00:00:00 2001
From: Aaron Dewes <aaron@runcitadel.space>
Date: Wed, 3 Apr 2024 21:05:33 +0200
Subject: [PATCH] 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>
---
 .github/workflows/release.yml                 | 7 +++++++
 package.json                                  | 4 +---
 packages/openapi-types-ghec/package.json      | 3 ++-
 packages/openapi-types-ghes-3.10/package.json | 3 ++-
 packages/openapi-types-ghes-3.11/package.json | 3 ++-
 packages/openapi-types-ghes-3.12/package.json | 3 ++-
 packages/openapi-types-ghes-3.9/package.json  | 3 ++-
 packages/openapi-types-github.ae/package.json | 3 ++-
 packages/openapi-types/package.json           | 3 ++-
 scripts/generate-types.js                     | 1 +
 10 files changed, 23 insertions(+), 10 deletions(-)

diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
index 0ef365bfb..fd4838f4e 100644
--- 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
index 5b48b19cc..496dc6aa5 100644
--- 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
index 22150625d..096fb2bc2 100644
--- 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
index 0e69c2fac..9fb9448b9 100644
--- 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
index 50ca727eb..3a14d64b4 100644
--- 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
index 80227e182..001b47f5c 100644
--- 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
index 24499cca4..005b173aa 100644
--- 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
index 5e1ae47ab..e02eb4616 100644
--- 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
index 7ed60dcfa..b23bcee4e 100644
--- 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
index 5dae44bf2..98d5c7164 100644
--- 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: "",