@peterhauge/apiops-cli 0.3.0-alpha.0 → 0.4.0-alpha.0

package/dist/templates/github-actions/publish-workflow.js

@@ -2,54 +2,99 @@
 // Licensed under the MIT license.
 /**
  * GitHub Actions publish workflow template
- * Push-to-main trigger with commit ID choice, environment selection, and multi-env stages
+ * Push-to-main trigger with commit ID choice and a single parameterized publish
+ * job driven by a workflow-level environment variable (TARGET_ENV)
  */
 export function generatePublishWorkflow(config) {
+    const defaultEnvironment = config.environments[0] ?? 'dev';
     const envChoices = config.environments.map((env) => `          - ${env}`).join('\n');
-    const envJobs = config.environments.map((env, idx) => {
-        const envUpper = env.toUpperCase();
-        const autoDeployComment = idx === 0
-            ? `    # To enable automatic deployment on push to main, uncomment the condition below:
-    # if: github.event.inputs.ENVIRONMENT == '${env}' || github.event_name == 'push'`
-            : `    # To enable automatic deployment on push to main, uncomment the condition below:
-    # if: github.event.inputs.ENVIRONMENT == '${env}' || github.event_name == 'push'
-    # And change needs to: needs: [get-commit, publish-${config.environments[idx - 1]}]`;
-        return `  publish-${env}:
-${autoDeployComment}
-    if: github.event.inputs.ENVIRONMENT == '${env}'
+    return `name: Run APIM Publisher
+
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - '${config.artifactDir}/**'
+      - 'configuration.*.yaml'
+  workflow_dispatch:
+    inputs:
+      COMMIT_ID_CHOICE:
+        description: 'Choose "publish-all-artifacts-in-repo" only when you want to force republishing all artifacts (e.g. after build failure). Otherwise stick with the default behavior of "publish-artifacts-in-last-commit"'
+        required: true
+        type: choice
+        default: publish-artifacts-in-last-commit
+        options:
+          - publish-artifacts-in-last-commit
+          - publish-all-artifacts-in-repo
+      ENVIRONMENT:
+        description: 'Choose which environment to publish to'
+        required: true
+        type: choice
+        default: ${defaultEnvironment}
+        options:
+${envChoices}
+
+permissions:
+  id-token: write
+  contents: read
+
+# A single workflow-level variable selects the target environment. On manual runs
+# it comes from the ENVIRONMENT input; on push to main it defaults to '${defaultEnvironment}'.
+env:
+  TARGET_ENV: \${{ github.event.inputs.ENVIRONMENT || '${defaultEnvironment}' }}
+
+jobs:
+  get-commit:
     runs-on: ubuntu-latest
-    environment: ${env}
+    outputs:
+      commit_id: \${{ steps.commit.outputs.commit_id }}
+    steps:
+      - name: Set the Commit Id
+        id: commit
+        run: echo "commit_id=\${GITHUB_SHA}" >> $GITHUB_OUTPUT
+
+  publish:
+    runs-on: ubuntu-latest
+    environment: \${{ github.event.inputs.ENVIRONMENT || '${defaultEnvironment}' }}
     needs: get-commit
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5
         with:
           fetch-depth: 2
 
       - name: Setup Node.js
-        uses: actions/setup-node@v4
+        uses: actions/setup-node@v5
         with:
           node-version: '22'
 
       - name: Install dependencies
         run: npm install
 
+      - name: Resolve target environment
+        id: env
+        run: |
+          echo "name=\${TARGET_ENV}" >> "$GITHUB_OUTPUT"
+          echo "upper=$(echo "\${TARGET_ENV}" | tr '[:lower:]' '[:upper:]')" >> "$GITHUB_OUTPUT"
+
       - name: Azure Login (Federated Credential)
-        uses: azure/login@v2
+        uses: azure/login@v3
         with:
           client-id: \${{ secrets.AZURE_CLIENT_ID }}
           tenant-id: \${{ secrets.AZURE_TENANT_ID }}
           subscription-id: \${{ secrets.AZURE_SUBSCRIPTION_ID }}
 
-      - name: Validate token source values (${env})
+      - name: Validate token source values
         env:
           AVAILABLE_SECRETS_JSON: \${{ toJSON(secrets) }}
         run: |
           missing=0
-          tokens=$(grep -o '{#\\[[^]]*\\]#}' configuration.${env}.yaml | sed -E 's/^\\{#\\[([^]]+)\\]#\\}$/\\1/' | sort -u || true)
+          config_file="configuration.\${TARGET_ENV}.yaml"
+          tokens=$(grep -o '{#\\[[^]]*\\]#}' "$config_file" | sed -E 's/^\\{#\\[([^]]+)\\]#\\}$/\\1/' | sort -u || true)
 
           if [ -z "$tokens" ]; then
-            echo "No tokens found in configuration.${env}.yaml"
+            echo "No tokens found in $config_file"
             exit 0
           fi
 
@@ -78,87 +123,67 @@ ${autoDeployComment}
             exit 1
           fi
 
-      - name: Substitute tokens in configuration.${env}.yaml
-        uses: cschleiden/replace-tokens@v1.3
+      - name: Substitute tokens in configuration file
+        uses: cschleiden/replace-tokens@v1.4
         with:
           tokenPrefix: '{#['
           tokenSuffix: ']#}'
-          files: '["configuration.${env}.yaml"]'
+          files: '["configuration.\${{ env.TARGET_ENV }}.yaml"]'
           # Token values are injected in the previous step based on token names.
-          # Ensure tokens in configuration.${env}.yaml match secret names exactly.
+          # Ensure tokens in the configuration file match secret names exactly.
 
-      - name: Validate token substitution (${env})
+      - name: Validate token substitution
         run: |
-          if grep -q '{#\\[' configuration.${env}.yaml; then
-            echo "Unresolved tokens remain in configuration.${env}.yaml"
-            grep -o '{#\\[[^]]*\\]#}' configuration.${env}.yaml | sort -u
+          config_file="configuration.\${TARGET_ENV}.yaml"
+          if grep -q '{#\\[' "$config_file"; then
+            echo "Unresolved tokens remain in $config_file"
+            grep -o '{#\\[[^]]*\\]#}' "$config_file" | sort -u
             exit 1
           fi
 
-      - name: Publish to ${env} (incremental - last commit only)
+      - name: Dry-run validation (incremental)
         if: \${{ github.event.inputs.COMMIT_ID_CHOICE != 'publish-all-artifacts-in-repo' }}
         run: |
           npx apiops publish \\
             --subscription-id \${{ secrets.AZURE_SUBSCRIPTION_ID }} \\
-            --resource-group \${{ secrets.APIM_RESOURCE_GROUP_${envUpper} }} \\
-            --service-name \${{ secrets.APIM_SERVICE_NAME_${envUpper} }} \\
+            --resource-group \${{ secrets[format('APIM_RESOURCE_GROUP_{0}', steps.env.outputs.upper)] }} \\
+            --service-name \${{ secrets[format('APIM_SERVICE_NAME_{0}', steps.env.outputs.upper)] }} \\
             --source ${config.artifactDir} \\
-            --overrides configuration.${env}.yaml \\
-            --commit-id \${{ needs.get-commit.outputs.commit_id }}
+            --overrides configuration.\${{ env.TARGET_ENV }}.yaml \\
+            --commit-id \${{ needs.get-commit.outputs.commit_id }} \\
+            --dry-run
 
-      - name: Publish to ${env} (all artifacts)
+      - name: Dry-run validation (all artifacts)
         if: \${{ github.event.inputs.COMMIT_ID_CHOICE == 'publish-all-artifacts-in-repo' }}
         run: |
           npx apiops publish \\
             --subscription-id \${{ secrets.AZURE_SUBSCRIPTION_ID }} \\
-            --resource-group \${{ secrets.APIM_RESOURCE_GROUP_${envUpper} }} \\
-            --service-name \${{ secrets.APIM_SERVICE_NAME_${envUpper} }} \\
+            --resource-group \${{ secrets[format('APIM_RESOURCE_GROUP_{0}', steps.env.outputs.upper)] }} \\
+            --service-name \${{ secrets[format('APIM_SERVICE_NAME_{0}', steps.env.outputs.upper)] }} \\
             --source ${config.artifactDir} \\
-            --overrides configuration.${env}.yaml
-`;
-    }).join('\n');
-    return `name: Run APIM Publisher
-
-on:
-  push:
-    branches:
-      - main
-    paths:
-      - '${config.artifactDir}/**'
-      - 'configuration.*.yaml'
-  workflow_dispatch:
-    inputs:
-      COMMIT_ID_CHOICE:
-        description: 'Choose "publish-all-artifacts-in-repo" only when you want to force republishing all artifacts (e.g. after build failure). Otherwise stick with the default behavior of "publish-artifacts-in-last-commit"'
-        required: true
-        type: choice
-        default: publish-artifacts-in-last-commit
-        options:
-          - publish-artifacts-in-last-commit
-          - publish-all-artifacts-in-repo
-      ENVIRONMENT:
-        description: 'Choose which environment to publish to'
-        required: true
-        type: choice
-        default: ${config.environments[0]}
-        options:
-${envChoices}
+            --overrides configuration.\${{ env.TARGET_ENV }}.yaml \\
+            --dry-run
 
-permissions:
-  id-token: write
-  contents: read
-
-jobs:
-  get-commit:
-    runs-on: ubuntu-latest
-    outputs:
-      commit_id: \${{ steps.commit.outputs.commit_id }}
-    steps:
-      - name: Set the Commit Id
-        id: commit
-        run: echo "commit_id=\${GITHUB_SHA}" >> $GITHUB_OUTPUT
+      - name: Publish (incremental - last commit only)
+        if: \${{ github.event.inputs.COMMIT_ID_CHOICE != 'publish-all-artifacts-in-repo' }}
+        run: |
+          npx apiops publish \\
+            --subscription-id \${{ secrets.AZURE_SUBSCRIPTION_ID }} \\
+            --resource-group \${{ secrets[format('APIM_RESOURCE_GROUP_{0}', steps.env.outputs.upper)] }} \\
+            --service-name \${{ secrets[format('APIM_SERVICE_NAME_{0}', steps.env.outputs.upper)] }} \\
+            --source ${config.artifactDir} \\
+            --overrides configuration.\${{ env.TARGET_ENV }}.yaml \\
+            --commit-id \${{ needs.get-commit.outputs.commit_id }}
 
-${envJobs}
+      - name: Publish (all artifacts)
+        if: \${{ github.event.inputs.COMMIT_ID_CHOICE == 'publish-all-artifacts-in-repo' }}
+        run: |
+          npx apiops publish \\
+            --subscription-id \${{ secrets.AZURE_SUBSCRIPTION_ID }} \\
+            --resource-group \${{ secrets[format('APIM_RESOURCE_GROUP_{0}', steps.env.outputs.upper)] }} \\
+            --service-name \${{ secrets[format('APIM_SERVICE_NAME_{0}', steps.env.outputs.upper)] }} \\
+            --source ${config.artifactDir} \\
+            --overrides configuration.\${{ env.TARGET_ENV }}.yaml
 `;
 }
 //# sourceMappingURL=publish-workflow.js.map

package/dist/templates/github-actions/publish-workflow.js.map

@@ -1 +1 @@
-{"version":3,"file":"publish-workflow.js","sourceRoot":"","sources":["../../../src/templates/github-actions/publish-workflow.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAClC;;;GAGG;AAOH,MAAM,UAAU,uBAAuB,CAAC,MAA6B;IACnE,MAAM,UAAU,GAAG,MAAM,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,eAAe,GAAG,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAErF,MAAM,OAAO,GAAG,MAAM,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE;QACnD,MAAM,QAAQ,GAAG,GAAG,CAAC,WAAW,EAAE,CAAC;QACnC,MAAM,iBAAiB,GAAG,GAAG,KAAK,CAAC;YACjC,CAAC,CAAC;gDACwC,GAAG,kCAAkC;YAC/E,CAAC,CAAC;gDACwC,GAAG;yDACM,MAAM,CAAC,YAAY,CAAC,GAAG,GAAG,CAAC,CAAC,GAAG,CAAC;QAErF,OAAO,aAAa,GAAG;EACzB,iBAAiB;8CAC2B,GAAG;;mBAE9B,GAAG;;;;;;;;;;;;;;;;;;;;;;;8CAuBwB,GAAG;;;;;6DAKY,GAAG;;;qDAGX,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;mDA6BL,GAAG;;;;;oCAKlB,GAAG;;6CAEM,GAAG;;6CAEH,GAAG;;6CAEH,GAAG;8DACc,GAAG;sDACX,GAAG;;;;2BAI9B,GAAG;;;;;gEAKkC,QAAQ;4DACZ,QAAQ;uBAC7C,MAAM,CAAC,WAAW;wCACD,GAAG;;;2BAGhB,GAAG;;;;;gEAKkC,QAAQ;4DACZ,QAAQ;uBAC7C,MAAM,CAAC,WAAW;wCACD,GAAG;CAC1C,CAAC;IACA,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAEd,OAAO;;;;;;;WAOE,MAAM,CAAC,WAAW;;;;;;;;;;;;;;;;mBAgBV,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC;;EAEvC,UAAU;;;;;;;;;;;;;;;;EAgBV,OAAO;CACR,CAAC;AACF,CAAC"}
+{"version":3,"file":"publish-workflow.js","sourceRoot":"","sources":["../../../src/templates/github-actions/publish-workflow.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAClC;;;;GAIG;AAOH,MAAM,UAAU,uBAAuB,CAAC,MAA6B;IACnE,MAAM,kBAAkB,GAAG,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC;IAC3D,MAAM,UAAU,GAAG,MAAM,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,eAAe,GAAG,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAErF,OAAO;;;;;;;WAOE,MAAM,CAAC,WAAW;;;;;;;;;;;;;;;;mBAgBV,kBAAkB;;EAEnC,UAAU;;;;;;;yEAO6D,kBAAkB;;yDAElC,kBAAkB;;;;;;;;;;;;;;4DAcf,kBAAkB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;uBA4FvD,MAAM,CAAC,WAAW;;;;;;;;;;;;uBAYlB,MAAM,CAAC,WAAW;;;;;;;;;;;uBAWlB,MAAM,CAAC,WAAW;;;;;;;;;;;uBAWlB,MAAM,CAAC,WAAW;;CAExC,CAAC;AACF,CAAC"}

package/package.json

@@ -1,6 +1,7 @@
 {
   "name": "@peterhauge/apiops-cli",
-  "version": "0.3.0-alpha.0",
+  "version": "0.4.0-alpha.0",
+  "schemaVersion": "1",
   "description": "CLI tool for Azure API Management configuration-as-code",
   "type": "module",
   "private": false,
@@ -10,13 +11,14 @@
     "apiops": "dist/cli/index.js"
   },
   "files": [
-    "dist"
+    "dist",
+    "CHANGELOG.md"
   ],
   "readme": "README.md",
   "scripts": {
-    "prelint": "node scripts/embed-markdown-templates.mjs",
-    "prebuild": "node scripts/embed-markdown-templates.mjs",
-    "pretest": "node scripts/embed-markdown-templates.mjs",
+    "prelint": "node scripts/embed-markdown-templates.mjs && node scripts/generate-schemas.mjs",
+    "prebuild": "node scripts/embed-markdown-templates.mjs && node scripts/generate-schemas.mjs",
+    "pretest": "node scripts/embed-markdown-templates.mjs && node scripts/generate-schemas.mjs",
     "build": "tsc",
     "test": "vitest run",
     "test:watch": "vitest",
@@ -44,6 +46,7 @@
     "url": "https://github.com/Azure/apiops-cli/issues"
   },
   "homepage": "https://github.com/Azure/apiops-cli#readme",
+  "changelog": "https://github.com/Azure/apiops-cli/blob/main/CHANGELOG.md",
   "dependencies": {
     "@azure/identity": "^4.13.1",
     "any-ascii": "^0.3.3",