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

package/dist/templates/configs/override-config.js

@@ -1,98 +1,101 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT license.
 /**
- * T047: Sample override configuration template per environment
+ * Sample override configuration template per environment
  * Generates environment-specific configuration.{env}.yaml files
  */
 export function generateOverrideConfig(environment) {
-    return `# APIM Override Configuration for ${environment} environment
-# Customize resource properties for this specific environment
-# All APIOps Toolkit override sections are supported.
-
-# Override named values (e.g., API keys, connection strings)
-# namedValues:
-#   - name: api-key
-#     properties:
-#       value: "${environment}-api-key-value"
-#   - name: connection-string
-#     properties:
-#       value: "Server=${environment}-db.example.com;Database=mydb"
-#   - name: secret-from-keyvault
-#     properties:
-#       keyVault:
-#         secretIdentifier: "https://${environment}-kv.vault.azure.net/secrets/my-secret"
-#         identityClientId: "00000000-0000-0000-0000-000000000000"
-
-# Override backend URLs per environment
-# backends:
-#   - name: backend-api
-#     properties:
-#       url: "https://${environment}-api.example.com"
-#   - name: legacy-backend
-#     properties:
-#       url: "https://${environment}-legacy.example.com"
-#       resourceId: "/subscriptions/.../sites/${environment}-backend"
-
-# Override API service URLs (with optional nested sub-resource overrides)
-# apis:
-#   - name: echo-api
-#     properties:
-#       serviceUrl: "https://${environment}-echo.example.com"
-#   - name: petstore-api
-#     properties:
-#       serviceUrl: "https://${environment}-petstore.example.com"
-#       displayName: "Petstore API (${environment})"
-#     diagnostics:
-#       - name: applicationinsights
-#         properties:
-#           loggerId: "appinsights-logger-${environment}"
-#           verbosity: Error
-#     policies:
-#       - name: policy
-#         properties:
-#           format: rawxml
-
-# Override diagnostic logger references
-# diagnostics:
-#   - name: applicationinsights
-#     properties:
-#       loggerId: "appinsights-logger-${environment}"
-#       verbosity: Error
-
-# Override logger credentials or resource IDs
-# loggers:
-#   - name: appinsights-logger
-#     properties:
-#       loggerType: applicationInsights
-#       resourceId: "/subscriptions/xxxxx/resourceGroups/${environment}-rg/providers/microsoft.insights/components/${environment}-appinsights"
-#       isBuffered: true
-
-# Override service-level policies
-# policies:
-#   - name: policy
-#     properties:
-#       format: rawxml
-
-# Override gateway properties
-# gateways:
-#   - name: on-prem-gateway
-#     properties:
-#       locationData:
-#         name: "${environment} datacenter"
-
-# Override version sets, groups, subscriptions, products, tags, policy fragments
-# versionSets:
-#   - name: my-version-set
-#     properties:
-#       displayName: "My Version Set (${environment})"
-# products:
-#   - name: starter
-#     properties:
-#       displayName: "Starter Plan (${environment})"
-# tags:
-#   - name: env-tag
-#     properties:
-#       displayName: "${environment}"
+    return `# APIM Override Configuration for ${environment} environment
+# Customize resource properties for this specific environment
+# For full format details and examples, see:
+# https://github.com/Azure/apiops-cli/blob/main/docs/guides/environment-overrides.md
+
+# Override named values (e.g., API keys, connection strings)
+# namedValues:
+#   - name: api-key
+#     properties:
+#       value: "${environment}-api-key-value"
+#   - name: connection-string
+#     properties:
+#       value: "{#[DB_Connection_String]#}"
+#   - name: secret-from-keyvault
+#     properties:
+#       keyVault:
+#         secretIdentifier: "https://${environment}-kv.vault.azure.net/secrets/my-secret"
+#         identityClientId: "00000000-0000-0000-0000-000000000000"
+
+# Override backend URLs per environment
+# backends:
+#   - name: backend-api
+#     properties:
+#       url: "https://${environment}-api.example.com"
+#   - name: legacy-backend
+#     properties:
+#       url: "https://${environment}-legacy.example.com"
+#       resourceId: "/subscriptions/.../sites/${environment}-backend"
+
+# Override API service URLs (with optional nested sub-resource overrides)
+# apis:
+#   - name: echo-api
+#     properties:
+#       serviceUrl: "https://${environment}-echo.example.com"
+#   - name: petstore-api
+#     properties:
+#       serviceUrl: "https://${environment}-petstore.example.com"
+#       displayName: "Petstore API (${environment})"
+#     diagnostics:
+#       - name: applicationinsights
+#         properties:
+#           loggerId: "appinsights-logger-${environment}"
+#           verbosity: Error
+#     policies:
+#       - name: policy
+#         properties:
+#           format: rawxml
+
+# Override diagnostic logger references
+# diagnostics:
+#   - name: applicationinsights
+#     properties:
+#       loggerId: "appinsights-logger-${environment}"
+#       verbosity: Error
+
+# Override logger credentials or resource IDs
+# loggers:
+#   - name: appinsights-logger
+#     properties:
+#       loggerType: applicationInsights
+#       resourceId: "/subscriptions/xxxxx/resourceGroups/${environment}-rg/providers/microsoft.insights/components/${environment}-appinsights"
+#       isBuffered: true
+#       credentials:
+#         instrumentationKey: "<APP-INSIGHTS-INSTRUMENTATION-KEY>"
+
+# Override service-level policies
+# policies:
+#   - name: policy
+#     properties:
+#       format: rawxml
+
+# Override gateway properties
+# gateways:
+#   - name: on-prem-gateway
+#     properties:
+#       locationData:
+#         name: "${environment} datacenter"
+
+# Override version sets, groups, subscriptions, products, tags, policy fragments
+# versionSets:
+#   - name: my-version-set
+#     properties:
+#       displayName: "My Version Set (${environment})"
+# products:
+#   - name: starter
+#     properties:
+#       displayName: "Starter Plan (${environment})"
+# tags:
+#   - name: env-tag
+#     properties:
+#       displayName: "${environment}"
 `;
 }
 //# sourceMappingURL=override-config.js.map

package/dist/templates/configs/override-config.js.map

@@ -1 +1 @@
-{"version":3,"file":"override-config.js","sourceRoot":"","sources":["../../../src/templates/configs/override-config.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAClC;;;GAGG;AAEH,MAAM,UAAU,sBAAsB,CAAC,WAAmB;IACxD,OAAO,qCAAqC,WAAW;;;;;;;;kBAQvC,WAAW;;;yBAGJ,WAAW;;;;uCAIG,WAAW;;;;;;;wBAO1B,WAAW;;;wBAGX,WAAW;gDACa,WAAW;;;;;;+BAM5B,WAAW;;;+BAGX,WAAW;sCACJ,WAAW;;;;4CAIL,WAAW;;;;;;;;;;;wCAWf,WAAW;;;;;;;;2DAQQ,WAAW,+CAA+C,WAAW;;;;;;;;;;;;;;mBAc7G,WAAW;;;;;;wCAMU,WAAW;;;;sCAIb,WAAW;;;;wBAIzB,WAAW;CAClC,CAAC;AACF,CAAC"}
+{"version":3,"file":"override-config.js","sourceRoot":"","sources":["../../../src/templates/configs/override-config.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAClC;;;GAGG;AAEH,MAAM,UAAU,sBAAsB,CAAC,WAAmB;IACxD,OAAO,qCAAqC,WAAW;;;;;;;;;kBASvC,WAAW;;;;;;;uCAOU,WAAW;;;;;;;wBAO1B,WAAW;;;wBAGX,WAAW;gDACa,WAAW;;;;;;+BAM5B,WAAW;;;+BAGX,WAAW;sCACJ,WAAW;;;;4CAIL,WAAW;;;;;;;;;;;wCAWf,WAAW;;;;;;;;2DAQQ,WAAW,+CAA+C,WAAW;;;;;;;;;;;;;;;;mBAgB7G,WAAW;;;;;;wCAMU,WAAW;;;;sCAIb,WAAW;;;;wBAIzB,WAAW;CAClC,CAAC;AACF,CAAC"}

package/dist/templates/github-actions/extract-workflow.d.ts

@@ -1,5 +1,5 @@
 /**
- * T043: GitHub Actions extract workflow template
+ * GitHub Actions extract workflow template
  * Generates extract workflow with manual trigger, configuration choice, and auto-PR creation
  */
 export interface ExtractWorkflowConfig {

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

@@ -1,128 +1,128 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT license.
 /**
- * T043: GitHub Actions extract workflow template
+ * GitHub Actions extract workflow template
  * Generates extract workflow with manual trigger, configuration choice, and auto-PR creation
  */
 export function generateExtractWorkflow(config) {
-    return `name: Run APIM Extractor
-
-on:
-  workflow_dispatch:
-    inputs:
-      ENVIRONMENT:
-        description: 'Choose which environment to extract from'
-        required: true
-        type: choice
-        default: dev
-        options:
-          - dev
-          - prod
-      CONFIGURATION_YAML_PATH:
-        description: 'Choose whether to extract all APIs or use the extraction configuration file'
-        required: true
-        type: choice
-        options:
-          - Extract All APIs
-          - configuration.extractor.yaml
-
-permissions:
-  id-token: write
-  contents: write
-  pull-requests: write
-
-jobs:
-  extract:
-    runs-on: ubuntu-latest
-    environment: \${{ github.event.inputs.ENVIRONMENT }}
-    env:
-      APIM_RESOURCE_GROUP: \${{ (github.event.inputs.ENVIRONMENT == 'dev' && secrets.APIM_RESOURCE_GROUP_DEV) || (github.event.inputs.ENVIRONMENT == 'prod' && secrets.APIM_RESOURCE_GROUP_PROD) }}
-      APIM_SERVICE_NAME: \${{ (github.event.inputs.ENVIRONMENT == 'dev' && secrets.APIM_SERVICE_NAME_DEV) || (github.event.inputs.ENVIRONMENT == 'prod' && secrets.APIM_SERVICE_NAME_PROD) }}
-    steps:
-      - name: Validate required secrets
-        run: |
-          if [ -z "\${{ env.APIM_RESOURCE_GROUP }}" ]; then
-            echo "::error::APIM_RESOURCE_GROUP secret is not set for environment '\${{ github.event.inputs.ENVIRONMENT }}'"
-            echo "Please configure APIM_RESOURCE_GROUP_\${{ github.event.inputs.ENVIRONMENT == 'dev' && 'DEV' || 'PROD' }} secret in the \${{ github.event.inputs.ENVIRONMENT }} environment"
-            exit 1
-          fi
-          if [ -z "\${{ env.APIM_SERVICE_NAME }}" ]; then
-            echo "::error::APIM_SERVICE_NAME secret is not set for environment '\${{ github.event.inputs.ENVIRONMENT }}'"
-            echo "Please configure APIM_SERVICE_NAME_\${{ github.event.inputs.ENVIRONMENT == 'dev' && 'DEV' || 'PROD' }} secret in the \${{ github.event.inputs.ENVIRONMENT }} environment"
-            exit 1
-          fi
-          echo "✓ All required secrets are configured"
-          echo "  Environment: \${{ github.event.inputs.ENVIRONMENT }}"
-          echo "  Resource Group: \${{ env.APIM_RESOURCE_GROUP }}"
-          echo "  Service Name: \${{ env.APIM_SERVICE_NAME }}"
-
-      - name: Checkout repository
-        uses: actions/checkout@v4
-
-      - name: Setup Node.js
-        uses: actions/setup-node@v4
-        with:
-          node-version: '22'
-
-      - name: Install dependencies
-        run: npm install
-
-      - name: Azure Login (Federated Credential)
-        uses: azure/login@v2
-        with:
-          client-id: \${{ secrets.AZURE_CLIENT_ID }}
-          tenant-id: \${{ secrets.AZURE_TENANT_ID }}
-          subscription-id: \${{ secrets.AZURE_SUBSCRIPTION_ID }}
-
-      - name: Run APIM Extract (All APIs)
-        if: \${{ github.event.inputs.CONFIGURATION_YAML_PATH == 'Extract All APIs' }}
-        run: |
-          npx apiops extract \\
-            --subscription-id \${{ secrets.AZURE_SUBSCRIPTION_ID }} \\
-            --resource-group \${{ env.APIM_RESOURCE_GROUP }} \\
-            --service-name \${{ env.APIM_SERVICE_NAME }} \\
-            --output ${config.artifactDir}
-
-      - name: Run APIM Extract (With Configuration)
-        if: \${{ github.event.inputs.CONFIGURATION_YAML_PATH != 'Extract All APIs' }}
-        run: |
-          npx apiops extract \\
-            --subscription-id \${{ secrets.AZURE_SUBSCRIPTION_ID }} \\
-            --resource-group \${{ env.APIM_RESOURCE_GROUP }} \\
-            --service-name \${{ env.APIM_SERVICE_NAME }} \\
-            --output ${config.artifactDir} \\
-            --filter configuration.extractor.yaml
-
-      - name: Upload artifacts
-        uses: actions/upload-artifact@v4
-        with:
-          name: apim-artifacts
-          path: ${config.artifactDir}
-          retention-days: 30
-
-  create-pull-request:
-    needs: extract
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout repository
-        uses: actions/checkout@v4
-
-      - name: Download artifacts
-        uses: actions/download-artifact@v4
-        with:
-          name: apim-artifacts
-          path: ${config.artifactDir}
-
-      - name: Create pull request
-        uses: peter-evans/create-pull-request@v6
-        with:
-          token: \${{ secrets.GITHUB_TOKEN }}
-          commit-message: "chore: update APIM artifacts from extract"
-          title: "APIM Extract - Update artifacts"
-          body: >
-            This PR is auto-generated by the APIM extract workflow.
-          labels: extract, automated pr
-          branch: apim-extract-\${{ github.run_id }}
+    return `name: Run APIM Extractor
+
+on:
+  workflow_dispatch:
+    inputs:
+      ENVIRONMENT:
+        description: 'Choose which environment to extract from'
+        required: true
+        type: choice
+        default: dev
+        options:
+          - dev
+          - prod
+      CONFIGURATION_YAML_PATH:
+        description: 'Choose whether to extract all APIs or use the extraction configuration file'
+        required: true
+        type: choice
+        options:
+          - Extract All APIs
+          - configuration.extractor.yaml
+
+permissions:
+  id-token: write
+  contents: write
+  pull-requests: write
+
+jobs:
+  extract:
+    runs-on: ubuntu-latest
+    environment: \${{ github.event.inputs.ENVIRONMENT }}
+    env:
+      APIM_RESOURCE_GROUP: \${{ (github.event.inputs.ENVIRONMENT == 'dev' && secrets.APIM_RESOURCE_GROUP_DEV) || (github.event.inputs.ENVIRONMENT == 'prod' && secrets.APIM_RESOURCE_GROUP_PROD) }}
+      APIM_SERVICE_NAME: \${{ (github.event.inputs.ENVIRONMENT == 'dev' && secrets.APIM_SERVICE_NAME_DEV) || (github.event.inputs.ENVIRONMENT == 'prod' && secrets.APIM_SERVICE_NAME_PROD) }}
+    steps:
+      - name: Validate required secrets
+        run: |
+          if [ -z "\${{ env.APIM_RESOURCE_GROUP }}" ]; then
+            echo "::error::APIM_RESOURCE_GROUP secret is not set for environment '\${{ github.event.inputs.ENVIRONMENT }}'"
+            echo "Please configure APIM_RESOURCE_GROUP_\${{ github.event.inputs.ENVIRONMENT == 'dev' && 'DEV' || 'PROD' }} secret in the \${{ github.event.inputs.ENVIRONMENT }} environment"
+            exit 1
+          fi
+          if [ -z "\${{ env.APIM_SERVICE_NAME }}" ]; then
+            echo "::error::APIM_SERVICE_NAME secret is not set for environment '\${{ github.event.inputs.ENVIRONMENT }}'"
+            echo "Please configure APIM_SERVICE_NAME_\${{ github.event.inputs.ENVIRONMENT == 'dev' && 'DEV' || 'PROD' }} secret in the \${{ github.event.inputs.ENVIRONMENT }} environment"
+            exit 1
+          fi
+          echo "✓ All required secrets are configured"
+          echo "  Environment: \${{ github.event.inputs.ENVIRONMENT }}"
+          echo "  Resource Group: \${{ env.APIM_RESOURCE_GROUP }}"
+          echo "  Service Name: \${{ env.APIM_SERVICE_NAME }}"
+
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '22'
+
+      - name: Install dependencies
+        run: npm install
+
+      - name: Azure Login (Federated Credential)
+        uses: azure/login@v2
+        with:
+          client-id: \${{ secrets.AZURE_CLIENT_ID }}
+          tenant-id: \${{ secrets.AZURE_TENANT_ID }}
+          subscription-id: \${{ secrets.AZURE_SUBSCRIPTION_ID }}
+
+      - name: Run APIM Extract (All APIs)
+        if: \${{ github.event.inputs.CONFIGURATION_YAML_PATH == 'Extract All APIs' }}
+        run: |
+          npx apiops extract \\
+            --subscription-id \${{ secrets.AZURE_SUBSCRIPTION_ID }} \\
+            --resource-group \${{ env.APIM_RESOURCE_GROUP }} \\
+            --service-name \${{ env.APIM_SERVICE_NAME }} \\
+            --output ${config.artifactDir}
+
+      - name: Run APIM Extract (With Configuration)
+        if: \${{ github.event.inputs.CONFIGURATION_YAML_PATH != 'Extract All APIs' }}
+        run: |
+          npx apiops extract \\
+            --subscription-id \${{ secrets.AZURE_SUBSCRIPTION_ID }} \\
+            --resource-group \${{ env.APIM_RESOURCE_GROUP }} \\
+            --service-name \${{ env.APIM_SERVICE_NAME }} \\
+            --output ${config.artifactDir} \\
+            --filter configuration.extractor.yaml
+
+      - name: Upload artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: apim-artifacts
+          path: ${config.artifactDir}
+          retention-days: 30
+
+  create-pull-request:
+    needs: extract
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Download artifacts
+        uses: actions/download-artifact@v4
+        with:
+          name: apim-artifacts
+          path: ${config.artifactDir}
+
+      - name: Create pull request
+        uses: peter-evans/create-pull-request@v6
+        with:
+          token: \${{ secrets.GITHUB_TOKEN }}
+          commit-message: "chore: update APIM artifacts from extract"
+          title: "APIM Extract - Update artifacts"
+          body: >
+            This PR is auto-generated by the APIM extract workflow.
+          labels: extract, automated pr
+          branch: apim-extract-\${{ github.run_id }}
 `;
 }
 //# sourceMappingURL=extract-workflow.js.map

package/dist/templates/github-actions/publish-workflow.d.ts

@@ -1,5 +1,5 @@
 /**
- * T044: GitHub Actions publish workflow template
+ * GitHub Actions publish workflow template
  * Push-to-main trigger with commit ID choice, environment selection, and multi-env stages
  */
 export interface PublishWorkflowConfig {

package/dist/templates/github-actions/publish-workflow.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"publish-workflow.d.ts","sourceRoot":"","sources":["../../../src/templates/github-actions/publish-workflow.ts"],"names":[],"mappings":"AAEA;;;GAGG;AAEH,MAAM,WAAW,qBAAqB;IACpC,WAAW,EAAE,MAAM,CAAC;IACpB,YAAY,EAAE,MAAM,EAAE,CAAC;CACxB;AAED,wBAAgB,uBAAuB,CAAC,MAAM,EAAE,qBAAqB,GAAG,MAAM,CAoH7E"}
+{"version":3,"file":"publish-workflow.d.ts","sourceRoot":"","sources":["../../../src/templates/github-actions/publish-workflow.ts"],"names":[],"mappings":"AAEA;;;GAGG;AAEH,MAAM,WAAW,qBAAqB;IACpC,WAAW,EAAE,MAAM,CAAC;IACpB,YAAY,EAAE,MAAM,EAAE,CAAC;CACxB;AAED,wBAAgB,uBAAuB,CAAC,MAAM,EAAE,qBAAqB,GAAG,MAAM,CA+J7E"}