fix(workflow): update fig autocomplete workflow (heroku#2679)

* WIP fix bugs * WIP Fix bugs part 2 * WIP Fix bugs part 3 * Add @fig/complete-oclif * WIP update fig workflow * WIP update fig workflow part 2 * WIP update fig workflow part 3 * WIP update fig workflow part 4 Add PR body property * WIP update fig workflow part 5 * Create separate job for fig workflow * Update pr-body property copy * Update acceptance test
usiegj00 · Mar 4, 2024 · 536b2ec · 536b2ec
1 parent 7105fb6
commit 536b2ec
Show file tree

Hide file tree

Showing 14 changed files with 62 additions and 16 deletions.
diff --git a/.github/workflows/promote-release.yml b/.github/workflows/promote-release.yml
@@ -58,8 +58,6 @@ jobs:
           sudo apt-get install -y awscli
           aws configure set preview.cloudfront true
       - run: ./scripts/postrelease/invalidate_cdn_cache
-      ## Calls publish-to-fig-autocomplete workflow during post release jobs
-      - uses: ./.github/workflows/publish-to-fig-autocomplete.yml
 
   release-homebrew:
     needs: [ invalidate-cdn-cache ]
@@ -82,3 +80,8 @@ jobs:
       - uses: actions/checkout@v3
       - run: yarn --immutable --network-timeout 1000000
       - run: ./scripts/postrelease/change_management
+
+  create-fig-autocomplete-pr:
+    if: fromJSON(inputs.isStableRelease)
+    ## Calls publish-to-fig-autocomplete workflow during post release jobs
+    uses: ./.github/workflows/publish-to-fig-autocomplete.yml
diff --git a/.github/workflows/publish-to-fig-autocomplete.yml b/.github/workflows/publish-to-fig-autocomplete.yml
@@ -6,19 +6,20 @@ on:
 
 jobs:
   push-to-fig-autocomplete:
-    runs-on: ubuntu-latest
+    runs-on: pub-hk-ubuntu-22.04-small
     steps:
+      - uses: actions/checkout@v3
       - name: Use Node.js 16.x
         uses: actions/setup-node@v3
         with:
           node-version: 16.x
           cache: yarn
       - run: yarn --immutable --network-timeout 1000000
-      - name: Install Fig Oclif Plugin
-        run: ./bin/run plugins:install @fig/oclif-complete@2
+      - name: Build Heroku CLI
+        run: yarn build
       - name: Generate Fig Spec
         run: ./bin/run generate-fig-spec > spec.ts
-      - name: Get heroku version
+      - name: Get Heroku Version
         id: cli-version
         run: echo "version=$(./bin/run --version | sed -rn 's/^heroku\/([0-9\.]+).*$/\1/p')"
       - name: Create Fig Autocomplete PR
@@ -30,3 +31,4 @@ jobs:
           integration: oclif
           diff-based-versioning: true
           new-spec-version: ${{ steps.cli-version.outputs.version }}
+          pr-body: Automated PR for latest Heroku CLI release
diff --git a/packages/addons-v5/package.json b/packages/addons-v5/package.json
@@ -50,7 +50,9 @@
     "reporter": "list",
     "recursive": true,
     "check-leaks": true,
-    "require": ["./test/init.js"],
+    "require": [
+      "./test/init.js"
+    ],
     "timeout": 180000
   },
   "repository": "heroku/cli",

diff --git a/packages/ci-v5/package.json b/packages/ci-v5/package.json
@@ -54,7 +54,9 @@
   "license": "MIT",
   "main": "index.js",
   "mocha": {
-    "require": ["test/test-setup.js"],
+    "require": [
+      "test/test-setup.js"
+    ],
     "recursive": true,
     "reporter": "dot",
     "timeout": 180000

diff --git a/packages/cli/package.json b/packages/cli/package.json
@@ -6,6 +6,7 @@
   "bin": "./bin/run",
   "bugs": "https://github.com/heroku/cli/issues",
   "dependencies": {
+    "@fig/complete-oclif": "^2.0.0",
     "@heroku-cli/color": "1.1.14",
     "@heroku-cli/command": "^10.0.0",
     "@heroku-cli/command-v9": "npm:@heroku-cli/command@^9.0.2",
@@ -155,6 +156,7 @@
     ],
     "commands": "./lib/commands",
     "plugins": [
+      "@fig/complete-oclif",
       "@oclif/plugin-legacy",
       "@heroku-cli/plugin-addons-v5",
       "@heroku-cli/plugin-apps-v5",

diff --git a/packages/cli/test/acceptance/commands-output.ts b/packages/cli/test/acceptance/commands-output.ts
@@ -124,6 +124,7 @@ export default `\u001B[1m Command                                        Summary
  features:disable                               disables an app feature                                                                                                                                 
  features:enable                                enables an app feature                                                                                                                                  
  features:info                                  display information about a feature                                                                                                                     
+ generate-fig-spec                              Generate a Fig completion spec
  git:clone                                      clones a heroku app to your local machine at DIRECTORY (defaults to app name)                                                                           
  git:remote                                     adds a git remote to an app repo                                                                                                                        
  help                                           Display help for heroku.                                                                                                                                

diff --git a/packages/container-registry-v5/package.json b/packages/container-registry-v5/package.json
@@ -51,7 +51,9 @@
   "license": "ISC",
   "main": "index.js",
   "mocha": {
-    "require": ["./test/helpers.js"],
+    "require": [
+      "./test/helpers.js"
+    ],
     "reporter": "list",
     "recursive": true,
     "timeout": 180000

diff --git a/packages/oauth-v5/package.json b/packages/oauth-v5/package.json
@@ -47,7 +47,9 @@
   ],
   "license": "ISC",
   "mocha": {
-    "require": ["./test/init.js"],
+    "require": [
+      "./test/init.js"
+    ],
     "recursive": true,
     "timeout": 180000
   },

diff --git a/packages/orgs-v5/package.json b/packages/orgs-v5/package.json
@@ -67,7 +67,9 @@
   "license": "ISC",
   "main": "index.js",
   "mocha": {
-    "require": ["./test/helpers.js"],
+    "require": [
+      "./test/helpers.js"
+    ],
     "recursive": true,
     "timeout": 180000
   },

diff --git a/packages/pg-v5/package.json b/packages/pg-v5/package.json
@@ -56,9 +56,11 @@
   ],
   "license": "ISC",
   "main": "index.js",
-  "mocha":{
+  "mocha": {
     "recursive": true,
-    "require": ["./test/init.js"],
+    "require": [
+      "./test/init.js"
+    ],
     "timeout": 180000
   },
   "repository": "heroku/cli",

diff --git a/packages/redis-v5/package.json b/packages/redis-v5/package.json
@@ -43,7 +43,9 @@
   "license": "ISC",
   "main": "index.js",
   "mocha": {
-    "require": ["./test/init.js"],
+    "require": [
+      "./test/init.js"
+    ],
     "reporter": "list",
     "recursive": true,
     "exit": true,

diff --git a/packages/run-v5/package.json b/packages/run-v5/package.json
@@ -53,7 +53,9 @@
   ],
   "license": "ISC",
   "mocha": {
-    "require": ["./test/init.js"],
+    "require": [
+      "./test/init.js"
+    ],
     "recursive": true,
     "timeout": 180000,
     "exit": true

diff --git a/packages/spaces/package.json b/packages/spaces/package.json
@@ -46,7 +46,9 @@
   "license": "ISC",
   "main": "index.js",
   "mocha": {
-    "require": ["./test/helpers.js"],
+    "require": [
+      "./test/helpers.js"
+    ],
     "reporter": "list",
     "recursive": true,
     "timeout": 180000

diff --git a/yarn.lock b/yarn.lock
@@ -1099,6 +1099,16 @@ __metadata:
   languageName: node
   linkType: hard
 
+"@fig/complete-oclif@npm:^2.0.0":
+  version: 2.0.0
+  resolution: "@fig/complete-oclif@npm:2.0.0"
+  dependencies:
+    "@oclif/core": ^2.8.11
+    prettier: ^3.1.1
+  checksum: c7b148073456723cd85baaab5179a667c8078fb317ea03e184523ac9164ac4ff8f80452006c527e9c4340b08467fe480a2046554a5e6ca75b2e3aa1f27cac8da
+  languageName: node
+  linkType: hard
+
 "@gar/promisify@npm:^1.0.1, @gar/promisify@npm:^1.1.3":
   version: 1.1.3
   resolution: "@gar/promisify@npm:1.1.3"
@@ -10886,6 +10896,7 @@ __metadata:
   version: 0.0.0-use.local
   resolution: "heroku@workspace:packages/cli"
   dependencies:
+    "@fig/complete-oclif": ^2.0.0
     "@heroku-cli/color": 1.1.14
     "@heroku-cli/command": ^10.0.0
     "@heroku-cli/command-v9": "npm:@heroku-cli/command@^9.0.2"
@@ -15547,6 +15558,15 @@ __metadata:
   languageName: node
   linkType: hard
 
+"prettier@npm:^3.1.1":
+  version: 3.2.5
+  resolution: "prettier@npm:3.2.5"
+  bin:
+    prettier: bin/prettier.cjs
+  checksum: 2ee4e1417572372afb7a13bb446b34f20f1bf1747db77cf6ccaf57a9be005f2f15c40f903d41a6b79eec3f57fff14d32a20fb6dee1f126da48908926fe43c311
+  languageName: node
+  linkType: hard
+
 "pretty-bytes@npm:^5.3.0":
   version: 5.6.0
   resolution: "pretty-bytes@npm:5.6.0"