promote to stable

.github/workflows/node-ci.yml

@@ -20,14 +20,13 @@ jobs:
     strategy:
       matrix:
         node:
-          - 18.17.0
-          - 20.6.1
-          - 22
+          - 20.19.0
+          - 22.14.0
           - 23
     steps:
       - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
       - name: Setup node
-        uses: actions/setup-node@cdca7365b2dadb8aad0a33bc7601856ffabcc48e # v4.3.0
+        uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4.4.0
         with:
           cache: npm
           node-version: ${{ matrix.node }}
@@ -38,15 +37,18 @@ jobs:
     steps:
       - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
       - name: Setup node
-        uses: actions/setup-node@cdca7365b2dadb8aad0a33bc7601856ffabcc48e # v4.3.0
+        uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4.4.0
         with:
           node-version-file: .nvmrc
           cache: npm
       - run: npm clean-install
       - run: npm install --global corepack@latest
       - run: corepack npm audit signatures
       - run: npm test
-      - uses: codecov/codecov-action@0565863a31f2c772f9f0395002a31e3f06189574 # v5.4.0
+      - run: npx @gravityci/cli ./lib/
+        env:
+          GRAVITY_TOKEN: ${{ secrets.GRAVITY_TOKEN }}
+      - uses: codecov/codecov-action@ad3126e916f78f00edff4ed0317cf185271ccc2d # v5.4.2
   release:
     needs:
       - verify

README.md

@@ -63,10 +63,8 @@ $ npm install @form8ion/github --save-prod
 
 ### Enabling actions against the GitHub API
 
-This plugin leverages the [.netrc strategy](https://github.com/travi/octokit-auth-netrc)
-for [octokit](https://github.com/octokit/rest.js/). Be sure to
-[add your personal access token](https://github.com/travi/octokit-auth-netrc#defining-your-token)
-to leverage the GitHub API integration benefits of this plugin.
+Provide an authenticated octokit instance as the `octokit` property in the
+options
 
 ### Enabling repository configuration with `repository-settings/app`
 
@@ -92,13 +90,21 @@ The settings file generated by this tool assumes that it is extending an
 
 ```javascript
 import any from '@travi/any';
+import {octokit} from '@form8ion/github-core';
 import {lift, promptConstants, scaffold, test} from '@form8ion/github';
 ```
 
 #### Execute
 
 ```javascript
 const projectRoot = process.cwd();
+const octokitInstance = octokit.getNetrcAuthenticatedInstance();
+const logger = {
+  info: message => console.error(message),
+  success: message => console.error(message),
+  warn: message => console.error(message),
+  error: message => console.error(message)
+};
 
 await scaffold(
   {
@@ -110,27 +116,51 @@ await scaffold(
   {
     prompt: async ({id}) => {
       const {questionNames, ids} = promptConstants;
-      const expectedPromptId = ids.GITHUB_DETAILS;
-
-      if (expectedPromptId === id) {
-        return {[questionNames[expectedPromptId].GITHUB_ACCOUNT]: any.word()};
+      const {
+        GITHUB_DETAILS: githubDetailsPromptId,
+        ADMIN_SETTINGS: repositorySettingsPromptId
+      } = ids;
+
+      switch (id) {
+        case githubDetailsPromptId:
+          return {[questionNames[githubDetailsPromptId].GITHUB_ACCOUNT]: any.word()};
+        case repositorySettingsPromptId:
+          return {[questionNames[repositorySettingsPromptId].SETTINGS_MANAGED_AS_CODE]: any.boolean()};
+        default:
+          throw new Error(`Unknown prompt with ID: ${id}`);
       }
-
-      throw new Error(`Unknown prompt with ID: ${id}`);
-    }
+    },
+    octokit: octokitInstance,
+    logger
   }
 );
 
 if (await test({projectRoot})) {
-  await lift({
-    projectRoot,
-    vcs: {owner: 'account-name', name: 'repository-name'},
-    results: {
-      projectDetails: {homepage: any.url()},
-      tags: any.listOf(any.word),
-      nextSteps: any.listOf(() => ({summary: any.sentence(), description: any.sentence()}))
+  await lift(
+    {
+      projectRoot,
+      vcs: {owner: 'account-name', name: 'repository-name'},
+      results: {
+        projectDetails: {homepage: any.url()},
+        tags: any.listOf(any.word),
+        nextSteps: any.listOf(() => ({summary: any.sentence(), description: any.sentence()}))
+      }
+    },
+    {
+      octokit: octokitInstance,
+      logger,
+      prompt: async ({id}) => {
+        const {questionNames, ids} = promptConstants;
+        const expectedPromptId = ids.REQUIRED_CHECK_BYPASS;
+
+        if (expectedPromptId === id) {
+          return {[questionNames[expectedPromptId].CHECK_BYPASS_TEAM]: any.integer()};
+        }
+
+        throw new Error(`Unknown prompt with ID: ${id}`);
+      }
     }
-  });
+  );
 }
 ```
 

example.js

@@ -1,16 +1,26 @@
 // #### Import
 // remark-usage-ignore-next 2
-import {resolve} from 'path';
+import {resolve} from 'node:path';
 import stubbedFs from 'mock-fs';
 import any from '@travi/any';
+import {octokit} from '@form8ion/github-core';
 import {lift, promptConstants, scaffold, test} from './lib/index.js';
 
 // remark-usage-ignore-next
 stubbedFs({node_modules: stubbedFs.load(resolve('node_modules'))});
 
 // #### Execute
 
+// remark-usage-ignore-next
+/* eslint-disable no-console */
 const projectRoot = process.cwd();
+const octokitInstance = octokit.getNetrcAuthenticatedInstance();
+const logger = {
+  info: message => console.error(message),
+  success: message => console.error(message),
+  warn: message => console.error(message),
+  error: message => console.error(message)
+};
 
 await scaffold(
   {
@@ -22,25 +32,52 @@ await scaffold(
   {
     prompt: async ({id}) => {
       const {questionNames, ids} = promptConstants;
-      const expectedPromptId = ids.GITHUB_DETAILS;
+      const {
+        GITHUB_DETAILS: githubDetailsPromptId,
+        ADMIN_SETTINGS: repositorySettingsPromptId
+      } = ids;
 
-      if (expectedPromptId === id) {
-        return {[questionNames[expectedPromptId].GITHUB_ACCOUNT]: any.word()};
+      switch (id) {
+        case githubDetailsPromptId:
+          return {[questionNames[githubDetailsPromptId].GITHUB_ACCOUNT]: any.word()};
+        case repositorySettingsPromptId:
+          return {[questionNames[repositorySettingsPromptId].SETTINGS_MANAGED_AS_CODE]: any.boolean()};
+        default:
+          throw new Error(`Unknown prompt with ID: ${id}`);
       }
-
-      throw new Error(`Unknown prompt with ID: ${id}`);
-    }
+    },
+    octokit: octokitInstance,
+    logger
   }
 );
 
 if (await test({projectRoot})) {
-  await lift({
-    projectRoot,
-    vcs: {owner: 'account-name', name: 'repository-name'},
-    results: {
-      projectDetails: {homepage: any.url()},
-      tags: any.listOf(any.word),
-      nextSteps: any.listOf(() => ({summary: any.sentence(), description: any.sentence()}))
+  await lift(
+    {
+      projectRoot,
+      vcs: {owner: 'account-name', name: 'repository-name'},
+      results: {
+        projectDetails: {homepage: any.url()},
+        tags: any.listOf(any.word),
+        nextSteps: any.listOf(() => ({summary: any.sentence(), description: any.sentence()}))
+      }
+    },
+    {
+      octokit: octokitInstance,
+      logger,
+      prompt: async ({id}) => {
+        const {questionNames, ids} = promptConstants;
+        const expectedPromptId = ids.REQUIRED_CHECK_BYPASS;
+
+        if (expectedPromptId === id) {
+          return {[questionNames[expectedPromptId].CHECK_BYPASS_TEAM]: any.integer()};
+        }
+
+        throw new Error(`Unknown prompt with ID: ${id}`);
+      }
     }
-  });
+  );
 }
+
+// remark-usage-ignore-next
+/* eslint-enable no-console */