diff --git a/.gitattributes b/.gitattributes index 898f8fd0..8159be3c 100644 --- a/.gitattributes +++ b/.gitattributes @@ -4,12 +4,10 @@ /.eslintrc.json linguist-generated /.gitattributes linguist-generated /.github/pull_request_template.md linguist-generated -/.github/workflows/auto-approve.yml linguist-generated /.github/workflows/build.yml linguist-generated /.github/workflows/pull-request-lint.yml linguist-generated /.github/workflows/release.yml linguist-generated -/.github/workflows/upgrade-cdklabs-projen-project-types-main.yml linguist-generated -/.github/workflows/upgrade-main.yml linguist-generated +/.github/workflows/upgrade-nextdoor.yml linguist-generated /.gitignore linguist-generated /.mergify.yml linguist-generated /.npmignore linguist-generated diff --git a/.github/workflows/auto-approve.yml b/.github/workflows/auto-approve.yml deleted file mode 100644 index 815b9a4e..00000000 --- a/.github/workflows/auto-approve.yml +++ /dev/null @@ -1,21 +0,0 @@ -# ~~ Generated by projen. To modify, edit .projenrc.ts and run "npx projen". - -name: auto-approve -on: - pull_request_target: - types: - - labeled - - opened - - synchronize - - reopened - - ready_for_review -jobs: - approve: - runs-on: ubuntu-latest - permissions: - pull-requests: write - if: contains(github.event.pull_request.labels.*.name, 'auto-approve') && (github.event.pull_request.user.login == 'cdklabs-automation' || github.event.pull_request.user.login == 'dependabot[bot]') - steps: - - uses: hmarr/auto-approve-action@v2.2.1 - with: - github-token: ${{ secrets.GITHUB_TOKEN }} diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 8b69f375..9d766c7a 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -108,116 +108,3 @@ jobs: run: cd .repo && npx projen package:js - name: Collect js Artifact run: mv .repo/dist dist - package-java: - needs: build - runs-on: ubuntu-latest - permissions: {} - if: "! needs.build.outputs.self_mutation_happened" - steps: - - uses: actions/setup-java@v3 - with: - distribution: temurin - java-version: 11.x - - uses: actions/setup-node@v3 - with: - node-version: 16.x - - name: Download build artifacts - uses: actions/download-artifact@v3 - with: - name: build-artifact - path: dist - - name: Restore build artifact permissions - run: cd dist && setfacl --restore=permissions-backup.acl - continue-on-error: true - - name: Prepare Repository - run: mv dist .repo - - name: Install Dependencies - run: cd .repo && yarn install --check-files --frozen-lockfile - - name: Create java artifact - run: cd .repo && npx projen package:java - - name: Collect java Artifact - run: mv .repo/dist dist - package-python: - needs: build - runs-on: ubuntu-latest - permissions: {} - if: "! needs.build.outputs.self_mutation_happened" - steps: - - uses: actions/setup-node@v3 - with: - node-version: 16.x - - uses: actions/setup-python@v4 - with: - python-version: 3.x - - name: Download build artifacts - uses: actions/download-artifact@v3 - with: - name: build-artifact - path: dist - - name: Restore build artifact permissions - run: cd dist && setfacl --restore=permissions-backup.acl - continue-on-error: true - - name: Prepare Repository - run: mv dist .repo - - name: Install Dependencies - run: cd .repo && yarn install --check-files --frozen-lockfile - - name: Create python artifact - run: cd .repo && npx projen package:python - - name: Collect python Artifact - run: mv .repo/dist dist - package-dotnet: - needs: build - runs-on: ubuntu-latest - permissions: {} - if: "! needs.build.outputs.self_mutation_happened" - steps: - - uses: actions/setup-node@v3 - with: - node-version: 16.x - - uses: actions/setup-dotnet@v3 - with: - dotnet-version: 3.x - - name: Download build artifacts - uses: actions/download-artifact@v3 - with: - name: build-artifact - path: dist - - name: Restore build artifact permissions - run: cd dist && setfacl --restore=permissions-backup.acl - continue-on-error: true - - name: Prepare Repository - run: mv dist .repo - - name: Install Dependencies - run: cd .repo && yarn install --check-files --frozen-lockfile - - name: Create dotnet artifact - run: cd .repo && npx projen package:dotnet - - name: Collect dotnet Artifact - run: mv .repo/dist dist - package-go: - needs: build - runs-on: ubuntu-latest - permissions: {} - if: "! needs.build.outputs.self_mutation_happened" - steps: - - uses: actions/setup-node@v3 - with: - node-version: 16.x - - uses: actions/setup-go@v3 - with: - go-version: ^1.16.0 - - name: Download build artifacts - uses: actions/download-artifact@v3 - with: - name: build-artifact - path: dist - - name: Restore build artifact permissions - run: cd dist && setfacl --restore=permissions-backup.acl - continue-on-error: true - - name: Prepare Repository - run: mv dist .repo - - name: Install Dependencies - run: cd .repo && yarn install --check-files --frozen-lockfile - - name: Create go artifact - run: cd .repo && npx projen package:go - - name: Collect go Artifact - run: mv .repo/dist dist diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 138e2986..26c55eae 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -4,7 +4,7 @@ name: release on: push: branches: - - main + - nextdoor workflow_dispatch: {} jobs: release: @@ -30,8 +30,8 @@ jobs: node-version: 16.x - name: Install dependencies run: yarn install --check-files --frozen-lockfile - - name: release - run: npx projen release + - name: release:nextdoor + run: npx projen release:nextdoor - name: Check for new commits id: git_remote run: echo "latest_commit=$(git ls-remote origin -h ${{ github.ref }} | cut -f1)" >> $GITHUB_OUTPUT @@ -80,6 +80,7 @@ jobs: runs-on: ubuntu-latest permissions: contents: read + packages: write if: needs.release.outputs.latest_commit == github.sha steps: - uses: actions/setup-node@v3 @@ -104,151 +105,6 @@ jobs: - name: Release env: NPM_DIST_TAG: latest - NPM_REGISTRY: registry.npmjs.org - NPM_TOKEN: ${{ secrets.NPM_TOKEN }} + NPM_REGISTRY: npm.pkg.github.com + NPM_TOKEN: ${{ secrets.GITHUB_TOKEN }} run: npx -p publib@latest publib-npm - release_maven: - name: Publish to Maven Central - needs: release - runs-on: ubuntu-latest - permissions: - contents: read - if: needs.release.outputs.latest_commit == github.sha - steps: - - uses: actions/setup-java@v3 - with: - distribution: temurin - java-version: 11.x - - uses: actions/setup-node@v3 - with: - node-version: 16.x - - name: Download build artifacts - uses: actions/download-artifact@v3 - with: - name: build-artifact - path: dist - - name: Restore build artifact permissions - run: cd dist && setfacl --restore=permissions-backup.acl - continue-on-error: true - - name: Prepare Repository - run: mv dist .repo - - name: Install Dependencies - run: cd .repo && yarn install --check-files --frozen-lockfile - - name: Create java artifact - run: cd .repo && npx projen package:java - - name: Collect java Artifact - run: mv .repo/dist dist - - name: Release - env: - MAVEN_ENDPOINT: https://s01.oss.sonatype.org - MAVEN_GPG_PRIVATE_KEY: ${{ secrets.MAVEN_GPG_PRIVATE_KEY }} - MAVEN_GPG_PRIVATE_KEY_PASSPHRASE: ${{ secrets.MAVEN_GPG_PRIVATE_KEY_PASSPHRASE }} - MAVEN_PASSWORD: ${{ secrets.MAVEN_PASSWORD }} - MAVEN_USERNAME: ${{ secrets.MAVEN_USERNAME }} - MAVEN_STAGING_PROFILE_ID: ${{ secrets.MAVEN_STAGING_PROFILE_ID }} - run: npx -p publib@latest publib-maven - release_pypi: - name: Publish to PyPI - needs: release - runs-on: ubuntu-latest - permissions: - contents: read - if: needs.release.outputs.latest_commit == github.sha - steps: - - uses: actions/setup-node@v3 - with: - node-version: 16.x - - uses: actions/setup-python@v4 - with: - python-version: 3.x - - name: Download build artifacts - uses: actions/download-artifact@v3 - with: - name: build-artifact - path: dist - - name: Restore build artifact permissions - run: cd dist && setfacl --restore=permissions-backup.acl - continue-on-error: true - - name: Prepare Repository - run: mv dist .repo - - name: Install Dependencies - run: cd .repo && yarn install --check-files --frozen-lockfile - - name: Create python artifact - run: cd .repo && npx projen package:python - - name: Collect python Artifact - run: mv .repo/dist dist - - name: Release - env: - TWINE_USERNAME: ${{ secrets.TWINE_USERNAME }} - TWINE_PASSWORD: ${{ secrets.TWINE_PASSWORD }} - run: npx -p publib@latest publib-pypi - release_nuget: - name: Publish to NuGet Gallery - needs: release - runs-on: ubuntu-latest - permissions: - contents: read - if: needs.release.outputs.latest_commit == github.sha - steps: - - uses: actions/setup-node@v3 - with: - node-version: 16.x - - uses: actions/setup-dotnet@v3 - with: - dotnet-version: 3.x - - name: Download build artifacts - uses: actions/download-artifact@v3 - with: - name: build-artifact - path: dist - - name: Restore build artifact permissions - run: cd dist && setfacl --restore=permissions-backup.acl - continue-on-error: true - - name: Prepare Repository - run: mv dist .repo - - name: Install Dependencies - run: cd .repo && yarn install --check-files --frozen-lockfile - - name: Create dotnet artifact - run: cd .repo && npx projen package:dotnet - - name: Collect dotnet Artifact - run: mv .repo/dist dist - - name: Release - env: - NUGET_API_KEY: ${{ secrets.NUGET_API_KEY }} - run: npx -p publib@latest publib-nuget - release_golang: - name: Publish to GitHub Go Module Repository - needs: release - runs-on: ubuntu-latest - permissions: - contents: read - if: needs.release.outputs.latest_commit == github.sha - steps: - - uses: actions/setup-node@v3 - with: - node-version: 16.x - - uses: actions/setup-go@v3 - with: - go-version: ^1.16.0 - - name: Download build artifacts - uses: actions/download-artifact@v3 - with: - name: build-artifact - path: dist - - name: Restore build artifact permissions - run: cd dist && setfacl --restore=permissions-backup.acl - continue-on-error: true - - name: Prepare Repository - run: mv dist .repo - - name: Install Dependencies - run: cd .repo && yarn install --check-files --frozen-lockfile - - name: Create go artifact - run: cd .repo && npx projen package:go - - name: Collect go Artifact - run: mv .repo/dist dist - - name: Release - env: - GIT_USER_NAME: github-actions - GIT_USER_EMAIL: github-actions@github.com - GITHUB_TOKEN: ${{ secrets.GO_GITHUB_TOKEN }} - run: npx -p publib@latest publib-golang diff --git a/.github/workflows/upgrade-cdklabs-projen-project-types-main.yml b/.github/workflows/upgrade-cdklabs-projen-project-types-main.yml deleted file mode 100644 index 00a34960..00000000 --- a/.github/workflows/upgrade-cdklabs-projen-project-types-main.yml +++ /dev/null @@ -1,87 +0,0 @@ -# ~~ Generated by projen. To modify, edit .projenrc.ts and run "npx projen". - -name: upgrade-cdklabs-projen-project-types-main -on: - workflow_dispatch: {} -jobs: - upgrade: - name: Upgrade - runs-on: ubuntu-latest - permissions: - contents: read - outputs: - patch_created: ${{ steps.create_patch.outputs.patch_created }} - steps: - - name: Checkout - uses: actions/checkout@v3 - with: - ref: main - - name: Setup Node.js - uses: actions/setup-node@v3 - - name: Install dependencies - run: yarn install --check-files --frozen-lockfile - - name: Upgrade dependencies - run: npx projen upgrade-cdklabs-projen-project-types - - name: Find mutations - id: create_patch - run: |- - git add . - git diff --staged --patch --exit-code > .repo.patch || echo "patch_created=true" >> $GITHUB_OUTPUT - - name: Upload patch - if: steps.create_patch.outputs.patch_created - uses: actions/upload-artifact@v3 - with: - name: .repo.patch - path: .repo.patch - pr: - name: Create Pull Request - needs: upgrade - runs-on: ubuntu-latest - permissions: - contents: read - if: ${{ needs.upgrade.outputs.patch_created }} - steps: - - name: Checkout - uses: actions/checkout@v3 - with: - ref: main - - name: Download patch - uses: actions/download-artifact@v3 - with: - name: .repo.patch - path: ${{ runner.temp }} - - name: Apply patch - run: '[ -s ${{ runner.temp }}/.repo.patch ] && git apply ${{ runner.temp }}/.repo.patch || echo "Empty patch. Skipping."' - - name: Set git identity - run: |- - git config user.name "github-actions" - git config user.email "github-actions@github.com" - - name: Create Pull Request - id: create-pr - uses: peter-evans/create-pull-request@v4 - with: - token: ${{ secrets.PROJEN_GITHUB_TOKEN }} - commit-message: |- - chore(deps): upgrade cdklabs-projen-project-types - - Upgrades cdklabs-projen-project-types dependency. See details in [workflow run]. - - [Workflow Run]: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }} - - ------ - - *Automatically created by projen via the "upgrade-cdklabs-projen-project-types-main" workflow* - branch: github-actions/upgrade-cdklabs-projen-project-types-main - title: "chore(deps): upgrade cdklabs-projen-project-types" - labels: auto-approve - body: |- - Upgrades cdklabs-projen-project-types dependency. See details in [workflow run]. - - [Workflow Run]: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }} - - ------ - - *Automatically created by projen via the "upgrade-cdklabs-projen-project-types-main" workflow* - author: github-actions - committer: github-actions - signoff: true diff --git a/.github/workflows/upgrade-main.yml b/.github/workflows/upgrade-nextdoor.yml similarity index 90% rename from .github/workflows/upgrade-main.yml rename to .github/workflows/upgrade-nextdoor.yml index eb9011fb..e9a0acc4 100644 --- a/.github/workflows/upgrade-main.yml +++ b/.github/workflows/upgrade-nextdoor.yml @@ -1,6 +1,6 @@ # ~~ Generated by projen. To modify, edit .projenrc.ts and run "npx projen". -name: upgrade-main +name: upgrade-nextdoor on: workflow_dispatch: {} schedule: @@ -17,7 +17,7 @@ jobs: - name: Checkout uses: actions/checkout@v3 with: - ref: main + ref: nextdoor - name: Setup Node.js uses: actions/setup-node@v3 with: @@ -48,7 +48,7 @@ jobs: - name: Checkout uses: actions/checkout@v3 with: - ref: main + ref: nextdoor - name: Download patch uses: actions/download-artifact@v3 with: @@ -74,10 +74,9 @@ jobs: ------ - *Automatically created by projen via the "upgrade-main" workflow* - branch: github-actions/upgrade-main + *Automatically created by projen via the "upgrade-nextdoor" workflow* + branch: github-actions/upgrade-nextdoor title: "chore(deps): upgrade dependencies" - labels: auto-approve body: |- Upgrades project dependencies. See details in [workflow run]. @@ -85,7 +84,7 @@ jobs: ------ - *Automatically created by projen via the "upgrade-main" workflow* + *Automatically created by projen via the "upgrade-nextdoor" workflow* author: github-actions committer: github-actions signoff: true diff --git a/.gitignore b/.gitignore index 84038a8e..38d71db6 100644 --- a/.gitignore +++ b/.gitignore @@ -4,7 +4,6 @@ !/.projen/deps.json !/.projen/files.json !/.github/workflows/pull-request-lint.yml -!/.github/workflows/auto-approve.yml !/package.json !/LICENSE !/.npmignore @@ -40,7 +39,7 @@ junit.xml /dist/version.txt !/.github/workflows/release.yml !/.mergify.yml -!/.github/workflows/upgrade-main.yml +!/.github/workflows/upgrade-nextdoor.yml !/.github/pull_request_template.md !/.npmrc !/test/ @@ -52,6 +51,3 @@ junit.xml .jsii tsconfig.json !/API.md -.jsii.tabl.json -!/rosetta/default.ts-fixture -!/.github/workflows/upgrade-cdklabs-projen-project-types-main.yml diff --git a/.mergify.yml b/.mergify.yml index 39d81185..154b39fa 100644 --- a/.mergify.yml +++ b/.mergify.yml @@ -8,10 +8,6 @@ queue_rules: - -label~=(do-not-merge) - status-success=build - status-success=package-js - - status-success=package-java - - status-success=package-python - - status-success=package-dotnet - - status-success=package-go pull_request_rules: - name: Automatic merge on approval and successful build actions: @@ -28,7 +24,3 @@ pull_request_rules: - -label~=(do-not-merge) - status-success=build - status-success=package-js - - status-success=package-java - - status-success=package-python - - status-success=package-dotnet - - status-success=package-go diff --git a/.projen/deps.json b/.projen/deps.json index 97aa62ad..dd66cbe0 100644 --- a/.projen/deps.json +++ b/.projen/deps.json @@ -84,6 +84,7 @@ }, { "name": "jsii-rosetta", + "version": "1.x", "type": "build" }, { @@ -130,16 +131,6 @@ "name": "yaml", "type": "bundled" }, - { - "name": "@aws-cdk/integ-runner", - "version": "latest", - "type": "devenv" - }, - { - "name": "@aws-cdk/integ-tests-alpha", - "version": "latest", - "type": "devenv" - }, { "name": "@types/babel__traverse", "version": "7.18.2", diff --git a/.projen/files.json b/.projen/files.json index d2fe20eb..5386a417 100644 --- a/.projen/files.json +++ b/.projen/files.json @@ -3,12 +3,10 @@ ".eslintrc.json", ".gitattributes", ".github/pull_request_template.md", - ".github/workflows/auto-approve.yml", ".github/workflows/build.yml", ".github/workflows/pull-request-lint.yml", ".github/workflows/release.yml", - ".github/workflows/upgrade-cdklabs-projen-project-types-main.yml", - ".github/workflows/upgrade-main.yml", + ".github/workflows/upgrade-nextdoor.yml", ".gitignore", ".mergify.yml", ".npmrc", diff --git a/.projen/tasks.json b/.projen/tasks.json index a2e9a673..62dd29a2 100644 --- a/.projen/tasks.json +++ b/.projen/tasks.json @@ -32,8 +32,7 @@ "CHANGELOG": "dist/changelog.md", "BUMPFILE": "dist/version.txt", "RELEASETAG": "dist/releasetag.txt", - "RELEASE_TAG_PREFIX": "", - "RELEASABLE_COMMITS": "git log --no-merges --oneline $LATEST_TAG..HEAD -E --grep '^(feat|fix){1}(\\([^()[:space:]]+\\))?(!)?:[[:blank:]]+.+'" + "RELEASE_TAG_PREFIX": "" }, "steps": [ { @@ -149,26 +148,6 @@ } ] }, - "integ": { - "name": "integ", - "description": "Run integration snapshot tests", - "steps": [ - { - "exec": "yarn integ-runner --language typescript", - "receiveArgs": true - } - ] - }, - "integ:update": { - "name": "integ:update", - "description": "Run and update integration snapshot tests", - "steps": [ - { - "exec": "yarn integ-runner --language typescript --update-on-failed", - "receiveArgs": true - } - ] - }, "package": { "name": "package", "description": "Creates the distribution package", @@ -184,45 +163,6 @@ "steps": [ { "spawn": "package:js" - }, - { - "spawn": "package:java" - }, - { - "spawn": "package:python" - }, - { - "spawn": "package:dotnet" - }, - { - "spawn": "package:go" - } - ] - }, - "package:dotnet": { - "name": "package:dotnet", - "description": "Create dotnet language bindings", - "steps": [ - { - "exec": "jsii-pacmak -v --target dotnet" - } - ] - }, - "package:go": { - "name": "package:go", - "description": "Create go language bindings", - "steps": [ - { - "exec": "jsii-pacmak -v --target go" - } - ] - }, - "package:java": { - "name": "package:java", - "description": "Create java language bindings", - "steps": [ - { - "exec": "jsii-pacmak -v --target java" } ] }, @@ -235,24 +175,12 @@ } ] }, - "package:python": { - "name": "package:python", - "description": "Create python language bindings", - "steps": [ - { - "exec": "jsii-pacmak -v --target python" - } - ] - }, "post-compile": { "name": "post-compile", "description": "Runs after successful compilation", "steps": [ { "spawn": "docgen" - }, - { - "spawn": "rosetta:extract" } ] }, @@ -264,9 +192,9 @@ "name": "pre-compile", "description": "Prepare the project for compilation" }, - "release": { - "name": "release", - "description": "Prepare a release from \"main\" branch", + "release:nextdoor": { + "name": "release:nextdoor", + "description": "Prepare a release from \"nextdoor\" branch", "env": { "RELEASE": "true" }, @@ -288,28 +216,16 @@ } ] }, - "rosetta:extract": { - "name": "rosetta:extract", - "description": "Test rosetta extract", - "steps": [ - { - "exec": "yarn --silent jsii-rosetta extract --strict" - } - ] - }, "test": { "name": "test", "description": "Run tests", "steps": [ { - "exec": "jest --passWithNoTests --coverageProvider=v8 --ci", + "exec": "jest --passWithNoTests --ci", "receiveArgs": true }, { "spawn": "eslint" - }, - { - "spawn": "integ" } ] }, @@ -318,7 +234,7 @@ "description": "Update jest snapshots", "steps": [ { - "exec": "jest --updateSnapshot --passWithNoTests --coverageProvider=v8 --ci", + "exec": "jest --updateSnapshot --passWithNoTests --ci", "receiveArgs": true } ] @@ -340,8 +256,7 @@ "CHANGELOG": "dist/changelog.md", "BUMPFILE": "dist/version.txt", "RELEASETAG": "dist/releasetag.txt", - "RELEASE_TAG_PREFIX": "", - "RELEASABLE_COMMITS": "git log --no-merges --oneline $LATEST_TAG..HEAD -E --grep '^(feat|fix){1}(\\([^()[:space:]]+\\))?(!)?:[[:blank:]]+.+'" + "RELEASE_TAG_PREFIX": "" }, "steps": [ { @@ -360,13 +275,13 @@ "exec": "yarn upgrade npm-check-updates" }, { - "exec": "npm-check-updates --upgrade --target=minor --peer --dep=dev,peer,prod,optional --filter=@aws-cdk/integ-runner,@aws-cdk/integ-tests-alpha,@types/jest,@types/node,@typescript-eslint/eslint-plugin,@typescript-eslint/parser,cdklabs-projen-project-types,eslint-import-resolver-node,eslint-import-resolver-typescript,eslint-plugin-import,eslint,jest-junit,jest,jsii-diff,jsii-docgen,jsii-pacmak,jsii-rosetta,npm-check-updates,projen,standard-version,ts-jest,ts-node,typescript,decamelize,fast-json-patch,yaml,aws-cdk-lib,constructs" + "exec": "npm-check-updates --upgrade --target=minor --peer --dep=dev,peer,prod,optional --filter=@aws-cdk/integ-runner,@aws-cdk/integ-tests-alpha,@types/jest,@types/node,@typescript-eslint/eslint-plugin,@typescript-eslint/parser,cdklabs-projen-project-types,eslint-import-resolver-node,eslint-import-resolver-typescript,eslint-plugin-import,eslint,jest-junit,jest,jsii-diff,jsii-docgen,jsii-pacmak,npm-check-updates,projen,standard-version,ts-jest,ts-node,typescript,decamelize,fast-json-patch,yaml,aws-cdk-lib,constructs" }, { "exec": "yarn install --check-files" }, { - "exec": "yarn upgrade @aws-cdk/integ-runner @aws-cdk/integ-tests-alpha @types/jest @types/node @typescript-eslint/eslint-plugin @typescript-eslint/parser cdklabs-projen-project-types eslint-import-resolver-node eslint-import-resolver-typescript eslint-plugin-import eslint jest-junit jest jsii-diff jsii-docgen jsii-pacmak jsii-rosetta npm-check-updates projen standard-version ts-jest ts-node typescript decamelize fast-json-patch yaml aws-cdk-lib constructs" + "exec": "yarn upgrade @aws-cdk/integ-runner @aws-cdk/integ-tests-alpha @types/jest @types/node @typescript-eslint/eslint-plugin @typescript-eslint/parser cdklabs-projen-project-types eslint-import-resolver-node eslint-import-resolver-typescript eslint-plugin-import eslint jest-junit jest jsii-diff jsii-docgen jsii-pacmak npm-check-updates projen standard-version ts-jest ts-node typescript decamelize fast-json-patch yaml aws-cdk-lib constructs" }, { "exec": "npx projen" @@ -376,30 +291,6 @@ } ] }, - "upgrade-cdklabs-projen-project-types": { - "name": "upgrade-cdklabs-projen-project-types", - "description": "upgrade cdklabs-projen-project-types", - "env": { - "CI": "0" - }, - "steps": [ - { - "exec": "yarn upgrade npm-check-updates" - }, - { - "exec": "npm-check-updates --filter=cdklabs-projen-project-types,projen --upgrade" - }, - { - "exec": "yarn install --check-files" - }, - { - "exec": "yarn upgrade cdklabs-projen-project-types projen" - }, - { - "exec": "npx projen" - } - ] - }, "watch": { "name": "watch", "description": "Watch & compile in the background", diff --git a/.projenrc.ts b/.projenrc.ts index f33d0242..1b9ff229 100644 --- a/.projenrc.ts +++ b/.projenrc.ts @@ -1,17 +1,18 @@ -import { CdklabsConstructLibrary } from 'cdklabs-projen-project-types'; +/** @format */ + import { JsonPatch } from 'projen'; -import { UpdateSnapshot } from 'projen/lib/javascript'; +import { AwsCdkConstructLibrary } from 'projen/lib/awscdk'; +import { NpmAccess, UpdateSnapshot } from 'projen/lib/javascript'; -const project = new CdklabsConstructLibrary({ +const project = new AwsCdkConstructLibrary({ projenrcTs: true, - private: false, - name: 'cdk-pipelines-github', + name: '@nextdoor/cdk-pipelines-github', description: 'GitHub Workflows support for CDK Pipelines', author: 'Amazon Web Services', authorAddress: 'aws-cdk-dev@amazon.com', cdkVersion: '2.9.0', constructsVersion: '10.0.46', - defaultReleaseBranch: 'main', + defaultReleaseBranch: 'nextdoor', repositoryUrl: 'https://github.com/cdklabs/cdk-pipelines-github.git', bundledDeps: ['decamelize', 'yaml', 'fast-json-patch'], devDeps: [ @@ -25,22 +26,13 @@ const project = new CdklabsConstructLibrary({ updateSnapshot: UpdateSnapshot.NEVER, }, - publishToPypi: { - distName: 'cdk-pipelines-github', - module: 'cdk_pipelines_github', - }, - - publishToMaven: { - javaPackage: 'io.github.cdklabs.cdkpipelines.github', - mavenGroupId: 'io.github.cdklabs', - mavenArtifactId: 'cdk-pipelines-github', - mavenEndpoint: 'https://s01.oss.sonatype.org', - }, - - publishToNuget: { - dotNetNamespace: 'Cdklabs.CdkPipelinesGitHub', - packageId: 'Cdklabs.CdkPipelinesGitHub', - }, + /** + * Automatic publishing of our packages to Github Packages as a private package. + */ + npmAccess: NpmAccess.RESTRICTED, + npmDistTag: 'latest', + npmRegistryUrl: 'https://npm.pkg.github.com', + npmTokenSecret: 'GITHUB_TOKEN', }); // JSII sets this to `false` so we need to be compatible diff --git a/API.md b/API.md index 70ea3a67..d1c95e76 100644 --- a/API.md +++ b/API.md @@ -656,7 +656,7 @@ This project is licensed under the Apache-2.0 License. ## Constructs -### GitHubActionRole +### GitHubActionRole Creates or references a GitHub OIDC provider and accompanying role that trusts the provider. @@ -671,37 +671,37 @@ the `gitHubActionRoleArn` property. The role arn will be `arn:aws:iam:: [https://docs.github.com/en/actions/deployment/security-hardening-your-deployments/configuring-openid-connect-in-amazon-web-services](https://docs.github.com/en/actions/deployment/security-hardening-your-deployments/configuring-openid-connect-in-amazon-web-services) -#### Initializers +#### Initializers ```typescript -import { GitHubActionRole } from 'cdk-pipelines-github' +import { GitHubActionRole } from '@nextdoor/cdk-pipelines-github' new GitHubActionRole(scope: Construct, id: string, props: GitHubActionRoleProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | -| scope | constructs.Construct | *No description.* | -| id | string | *No description.* | -| props | GitHubActionRoleProps | *No description.* | +| scope | constructs.Construct | *No description.* | +| id | string | *No description.* | +| props | GitHubActionRoleProps | *No description.* | --- -##### `scope`Required +##### `scope`Required - *Type:* constructs.Construct --- -##### `id`Required +##### `id`Required - *Type:* string --- -##### `props`Required +##### `props`Required -- *Type:* GitHubActionRoleProps +- *Type:* GitHubActionRoleProps --- @@ -709,11 +709,11 @@ new GitHubActionRole(scope: Construct, id: string, props: GitHubActionRoleProps) | **Name** | **Description** | | --- | --- | -| toString | Returns a string representation of this construct. | +| toString | Returns a string representation of this construct. | --- -##### `toString` +##### `toString` ```typescript public toString(): string @@ -725,22 +725,22 @@ Returns a string representation of this construct. | **Name** | **Description** | | --- | --- | -| isConstruct | Checks if `x` is a construct. | -| existingGitHubActionsProvider | Reference an existing GitHub Actions provider. | +| isConstruct | Checks if `x` is a construct. | +| existingGitHubActionsProvider | Reference an existing GitHub Actions provider. | --- -##### ~~`isConstruct`~~ +##### ~~`isConstruct`~~ ```typescript -import { GitHubActionRole } from 'cdk-pipelines-github' +import { GitHubActionRole } from '@nextdoor/cdk-pipelines-github' GitHubActionRole.isConstruct(x: any) ``` Checks if `x` is a construct. -###### `x`Required +###### `x`Required - *Type:* any @@ -748,10 +748,10 @@ Any object. --- -##### `existingGitHubActionsProvider` +##### `existingGitHubActionsProvider` ```typescript -import { GitHubActionRole } from 'cdk-pipelines-github' +import { GitHubActionRole } from '@nextdoor/cdk-pipelines-github' GitHubActionRole.existingGitHubActionsProvider(scope: Construct) ``` @@ -761,7 +761,7 @@ Reference an existing GitHub Actions provider. You do not need to pass in an arn because the arn for such a provider is always the same. -###### `scope`Required +###### `scope`Required - *Type:* constructs.Construct @@ -771,12 +771,12 @@ a provider is always the same. | **Name** | **Type** | **Description** | | --- | --- | --- | -| node | constructs.Node | The tree node. | -| role | aws-cdk-lib.aws_iam.IRole | The role that gets created. | +| node | constructs.Node | The tree node. | +| role | aws-cdk-lib.aws_iam.IRole | The role that gets created. | --- -##### `node`Required +##### `node`Required ```typescript public readonly node: Node; @@ -788,7 +788,7 @@ The tree node. --- -##### `role`Required +##### `role`Required ```typescript public readonly role: IRole; @@ -804,39 +804,39 @@ property in your GitHub Workflow app. --- -### GitHubStage +### GitHubStage -#### Initializers +#### Initializers ```typescript -import { GitHubStage } from 'cdk-pipelines-github' +import { GitHubStage } from '@nextdoor/cdk-pipelines-github' new GitHubStage(scope: Construct, id: string, props?: GitHubStageProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | -| scope | constructs.Construct | *No description.* | -| id | string | *No description.* | -| props | GitHubStageProps | *No description.* | +| scope | constructs.Construct | *No description.* | +| id | string | *No description.* | +| props | GitHubStageProps | *No description.* | --- -##### `scope`Required +##### `scope`Required - *Type:* constructs.Construct --- -##### `id`Required +##### `id`Required - *Type:* string --- -##### `props`Optional +##### `props`Optional -- *Type:* GitHubStageProps +- *Type:* GitHubStageProps --- @@ -844,12 +844,12 @@ new GitHubStage(scope: Construct, id: string, props?: GitHubStageProps) | **Name** | **Description** | | --- | --- | -| toString | Returns a string representation of this construct. | -| synth | Synthesize this stage into a cloud assembly. | +| toString | Returns a string representation of this construct. | +| synth | Synthesize this stage into a cloud assembly. | --- -##### `toString` +##### `toString` ```typescript public toString(): string @@ -857,7 +857,7 @@ public toString(): string Returns a string representation of this construct. -##### `synth` +##### `synth` ```typescript public synth(options?: StageSynthesisOptions): CloudAssembly @@ -868,7 +868,7 @@ Synthesize this stage into a cloud assembly. Once an assembly has been synthesized, it cannot be modified. Subsequent calls will return the same assembly. -###### `options`Optional +###### `options`Optional - *Type:* aws-cdk-lib.StageSynthesisOptions @@ -878,23 +878,23 @@ calls will return the same assembly. | **Name** | **Description** | | --- | --- | -| isConstruct | Checks if `x` is a construct. | -| isStage | Test whether the given construct is a stage. | -| of | Return the stage this construct is contained with, if available. | +| isConstruct | Checks if `x` is a construct. | +| isStage | Test whether the given construct is a stage. | +| of | Return the stage this construct is contained with, if available. | --- -##### ~~`isConstruct`~~ +##### ~~`isConstruct`~~ ```typescript -import { GitHubStage } from 'cdk-pipelines-github' +import { GitHubStage } from '@nextdoor/cdk-pipelines-github' GitHubStage.isConstruct(x: any) ``` Checks if `x` is a construct. -###### `x`Required +###### `x`Required - *Type:* any @@ -902,26 +902,26 @@ Any object. --- -##### `isStage` +##### `isStage` ```typescript -import { GitHubStage } from 'cdk-pipelines-github' +import { GitHubStage } from '@nextdoor/cdk-pipelines-github' GitHubStage.isStage(x: any) ``` Test whether the given construct is a stage. -###### `x`Required +###### `x`Required - *Type:* any --- -##### `of` +##### `of` ```typescript -import { GitHubStage } from 'cdk-pipelines-github' +import { GitHubStage } from '@nextdoor/cdk-pipelines-github' GitHubStage.of(construct: IConstruct) ``` @@ -931,7 +931,7 @@ Return the stage this construct is contained with, if available. If called on a nested stage, returns its parent. -###### `construct`Required +###### `construct`Required - *Type:* constructs.IConstruct @@ -941,19 +941,19 @@ on a nested stage, returns its parent. | **Name** | **Type** | **Description** | | --- | --- | --- | -| node | constructs.Node | The tree node. | -| artifactId | string | Artifact ID of the assembly if it is a nested stage. The root stage (app) will return an empty string. | -| assetOutdir | string | The cloud assembly asset output directory. | -| outdir | string | The cloud assembly output directory. | -| stageName | string | The name of the stage. | -| account | string | The default account for all resources defined within this stage. | -| parentStage | aws-cdk-lib.Stage | The parent stage or `undefined` if this is the app. | -| region | string | The default region for all resources defined within this stage. | -| props | GitHubStageProps | *No description.* | +| node | constructs.Node | The tree node. | +| artifactId | string | Artifact ID of the assembly if it is a nested stage. The root stage (app) will return an empty string. | +| assetOutdir | string | The cloud assembly asset output directory. | +| outdir | string | The cloud assembly output directory. | +| stageName | string | The name of the stage. | +| account | string | The default account for all resources defined within this stage. | +| parentStage | aws-cdk-lib.Stage | The parent stage or `undefined` if this is the app. | +| region | string | The default region for all resources defined within this stage. | +| props | GitHubStageProps | *No description.* | --- -##### `node`Required +##### `node`Required ```typescript public readonly node: Node; @@ -965,7 +965,7 @@ The tree node. --- -##### `artifactId`Required +##### `artifactId`Required ```typescript public readonly artifactId: string; @@ -979,7 +979,7 @@ Derived from the construct path. --- -##### `assetOutdir`Required +##### `assetOutdir`Required ```typescript public readonly assetOutdir: string; @@ -991,7 +991,7 @@ The cloud assembly asset output directory. --- -##### `outdir`Required +##### `outdir`Required ```typescript public readonly outdir: string; @@ -1003,7 +1003,7 @@ The cloud assembly output directory. --- -##### `stageName`Required +##### `stageName`Required ```typescript public readonly stageName: string; @@ -1018,7 +1018,7 @@ hypens. --- -##### `account`Optional +##### `account`Optional ```typescript public readonly account: string; @@ -1030,7 +1030,7 @@ The default account for all resources defined within this stage. --- -##### `parentStage`Optional +##### `parentStage`Optional ```typescript public readonly parentStage: Stage; @@ -1044,7 +1044,7 @@ The parent stage or `undefined` if this is the app. --- -##### `region`Optional +##### `region`Optional ```typescript public readonly region: string; @@ -1056,52 +1056,52 @@ The default region for all resources defined within this stage. --- -##### `props`Optional +##### `props`Optional ```typescript public readonly props: GitHubStageProps; ``` -- *Type:* GitHubStageProps +- *Type:* GitHubStageProps --- -### GitHubWorkflow +### GitHubWorkflow CDK Pipelines for GitHub workflows. -#### Initializers +#### Initializers ```typescript -import { GitHubWorkflow } from 'cdk-pipelines-github' +import { GitHubWorkflow } from '@nextdoor/cdk-pipelines-github' new GitHubWorkflow(scope: Construct, id: string, props: GitHubWorkflowProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | -| scope | constructs.Construct | *No description.* | -| id | string | *No description.* | -| props | GitHubWorkflowProps | *No description.* | +| scope | constructs.Construct | *No description.* | +| id | string | *No description.* | +| props | GitHubWorkflowProps | *No description.* | --- -##### `scope`Required +##### `scope`Required - *Type:* constructs.Construct --- -##### `id`Required +##### `id`Required - *Type:* string --- -##### `props`Required +##### `props`Required -- *Type:* GitHubWorkflowProps +- *Type:* GitHubWorkflowProps --- @@ -1109,16 +1109,16 @@ new GitHubWorkflow(scope: Construct, id: string, props: GitHubWorkflowProps) | **Name** | **Description** | | --- | --- | -| toString | Returns a string representation of this construct. | -| addStage | Deploy a single Stage by itself. | -| addWave | Add a Wave to the pipeline, for deploying multiple Stages in parallel. | -| buildPipeline | Send the current pipeline definition to the engine, and construct the pipeline. | -| addGitHubWave | *No description.* | -| addStageWithGitHubOptions | Deploy a single Stage by itself with options for further GitHub configuration. | +| toString | Returns a string representation of this construct. | +| addStage | Deploy a single Stage by itself. | +| addWave | Add a Wave to the pipeline, for deploying multiple Stages in parallel. | +| buildPipeline | Send the current pipeline definition to the engine, and construct the pipeline. | +| addGitHubWave | *No description.* | +| addStageWithGitHubOptions | Deploy a single Stage by itself with options for further GitHub configuration. | --- -##### `toString` +##### `toString` ```typescript public toString(): string @@ -1126,7 +1126,7 @@ public toString(): string Returns a string representation of this construct. -##### `addStage` +##### `addStage` ```typescript public addStage(stage: Stage, options?: AddStageOpts): StageDeployment @@ -1138,19 +1138,19 @@ Add a Stage to the pipeline, to be deployed in sequence with other Stages added to the pipeline. All Stacks in the stage will be deployed in an order automatically determined by their relative dependencies. -###### `stage`Required +###### `stage`Required - *Type:* aws-cdk-lib.Stage --- -###### `options`Optional +###### `options`Optional - *Type:* aws-cdk-lib.pipelines.AddStageOpts --- -##### `addWave` +##### `addWave` ```typescript public addWave(id: string, options?: WaveOptions): Wave @@ -1170,19 +1170,19 @@ wave.addStage(new MyStage(this, 'Stage1')); wave.addStage(new MyStage(this, 'Stage2')); ``` -###### `id`Required +###### `id`Required - *Type:* string --- -###### `options`Optional +###### `options`Optional - *Type:* aws-cdk-lib.pipelines.WaveOptions --- -##### `buildPipeline` +##### `buildPipeline` ```typescript public buildPipeline(): void @@ -1192,25 +1192,25 @@ Send the current pipeline definition to the engine, and construct the pipeline. It is not possible to modify the pipeline after calling this method. -##### `addGitHubWave` +##### `addGitHubWave` ```typescript public addGitHubWave(id: string, options?: WaveOptions): GitHubWave ``` -###### `id`Required +###### `id`Required - *Type:* string --- -###### `options`Optional +###### `options`Optional - *Type:* aws-cdk-lib.pipelines.WaveOptions --- -##### `addStageWithGitHubOptions` +##### `addStageWithGitHubOptions` ```typescript public addStageWithGitHubOptions(stage: Stage, options?: AddGitHubStageOptions): StageDeployment @@ -1221,15 +1221,15 @@ Deploy a single Stage by itself with options for further GitHub configuration. Add a Stage to the pipeline, to be deployed in sequence with other Stages added to the pipeline. All Stacks in the stage will be deployed in an order automatically determined by their relative dependencies. -###### `stage`Required +###### `stage`Required - *Type:* aws-cdk-lib.Stage --- -###### `options`Optional +###### `options`Optional -- *Type:* AddGitHubStageOptions +- *Type:* AddGitHubStageOptions --- @@ -1237,21 +1237,21 @@ All Stacks in the stage will be deployed in an order automatically determined by | **Name** | **Description** | | --- | --- | -| isConstruct | Checks if `x` is a construct. | +| isConstruct | Checks if `x` is a construct. | --- -##### ~~`isConstruct`~~ +##### ~~`isConstruct`~~ ```typescript -import { GitHubWorkflow } from 'cdk-pipelines-github' +import { GitHubWorkflow } from '@nextdoor/cdk-pipelines-github' GitHubWorkflow.isConstruct(x: any) ``` Checks if `x` is a construct. -###### `x`Required +###### `x`Required - *Type:* any @@ -1263,17 +1263,17 @@ Any object. | **Name** | **Type** | **Description** | | --- | --- | --- | -| node | constructs.Node | The tree node. | -| cloudAssemblyFileSet | aws-cdk-lib.pipelines.FileSet | The FileSet tha contains the cloud assembly. | -| synth | aws-cdk-lib.pipelines.IFileSetProducer | The build step that produces the CDK Cloud Assembly. | -| waves | aws-cdk-lib.pipelines.Wave[] | The waves in this pipeline. | -| workflowFile | YamlFile | *No description.* | -| workflowName | string | *No description.* | -| workflowPath | string | *No description.* | +| node | constructs.Node | The tree node. | +| cloudAssemblyFileSet | aws-cdk-lib.pipelines.FileSet | The FileSet tha contains the cloud assembly. | +| synth | aws-cdk-lib.pipelines.IFileSetProducer | The build step that produces the CDK Cloud Assembly. | +| waves | aws-cdk-lib.pipelines.Wave[] | The waves in this pipeline. | +| workflowFile | YamlFile | *No description.* | +| workflowName | string | *No description.* | +| workflowPath | string | *No description.* | --- -##### `node`Required +##### `node`Required ```typescript public readonly node: Node; @@ -1285,7 +1285,7 @@ The tree node. --- -##### `cloudAssemblyFileSet`Required +##### `cloudAssemblyFileSet`Required ```typescript public readonly cloudAssemblyFileSet: FileSet; @@ -1299,7 +1299,7 @@ This is the primary output of the synth step. --- -##### `synth`Required +##### `synth`Required ```typescript public readonly synth: IFileSetProducer; @@ -1311,7 +1311,7 @@ The build step that produces the CDK Cloud Assembly. --- -##### `waves`Required +##### `waves`Required ```typescript public readonly waves: Wave[]; @@ -1323,17 +1323,17 @@ The waves in this pipeline. --- -##### `workflowFile`Required +##### `workflowFile`Required ```typescript public readonly workflowFile: YamlFile; ``` -- *Type:* YamlFile +- *Type:* YamlFile --- -##### `workflowName`Required +##### `workflowName`Required ```typescript public readonly workflowName: string; @@ -1343,7 +1343,7 @@ public readonly workflowName: string; --- -##### `workflowPath`Required +##### `workflowPath`Required ```typescript public readonly workflowPath: string; @@ -1356,14 +1356,14 @@ public readonly workflowPath: string; ## Structs -### AddGitHubStageOptions +### AddGitHubStageOptions Options to pass to `addStageWithGitHubOpts`. -#### Initializer +#### Initializer ```typescript -import { AddGitHubStageOptions } from 'cdk-pipelines-github' +import { AddGitHubStageOptions } from '@nextdoor/cdk-pipelines-github' const addGitHubStageOptions: AddGitHubStageOptions = { ... } ``` @@ -1372,16 +1372,16 @@ const addGitHubStageOptions: AddGitHubStageOptions = { ... } | **Name** | **Type** | **Description** | | --- | --- | --- | -| post | aws-cdk-lib.pipelines.Step[] | Additional steps to run after all of the stacks in the stage. | -| pre | aws-cdk-lib.pipelines.Step[] | Additional steps to run before any of the stacks in the stage. | -| stackSteps | aws-cdk-lib.pipelines.StackSteps[] | Instructions for stack level steps. | -| gitHubEnvironment | GitHubEnvironment | Run the stage in a specific GitHub Environment. | -| jobSettings | JobSettings | Job level settings that will be applied to all jobs in the stage. | -| stackCapabilities | StackCapabilities[] | In some cases, you must explicitly acknowledge that your CloudFormation stack template contains certain capabilities in order for CloudFormation to create the stack. | +| post | aws-cdk-lib.pipelines.Step[] | Additional steps to run after all of the stacks in the stage. | +| pre | aws-cdk-lib.pipelines.Step[] | Additional steps to run before any of the stacks in the stage. | +| stackSteps | aws-cdk-lib.pipelines.StackSteps[] | Instructions for stack level steps. | +| gitHubEnvironment | GitHubEnvironment | Run the stage in a specific GitHub Environment. | +| jobSettings | JobSettings | Job level settings that will be applied to all jobs in the stage. | +| stackCapabilities | StackCapabilities[] | In some cases, you must explicitly acknowledge that your CloudFormation stack template contains certain capabilities in order for CloudFormation to create the stack. | --- -##### `post`Optional +##### `post`Optional ```typescript public readonly post: Step[]; @@ -1394,7 +1394,7 @@ Additional steps to run after all of the stacks in the stage. --- -##### `pre`Optional +##### `pre`Optional ```typescript public readonly pre: Step[]; @@ -1407,7 +1407,7 @@ Additional steps to run before any of the stacks in the stage. --- -##### `stackSteps`Optional +##### `stackSteps`Optional ```typescript public readonly stackSteps: StackSteps[]; @@ -1420,13 +1420,13 @@ Instructions for stack level steps. --- -##### `gitHubEnvironment`Optional +##### `gitHubEnvironment`Optional ```typescript public readonly gitHubEnvironment: GitHubEnvironment; ``` -- *Type:* GitHubEnvironment +- *Type:* GitHubEnvironment - *Default:* no GitHub environment Run the stage in a specific GitHub Environment. @@ -1444,13 +1444,13 @@ exist will create an environment with the referenced name. --- -##### `jobSettings`Optional +##### `jobSettings`Optional ```typescript public readonly jobSettings: JobSettings; ``` -- *Type:* JobSettings +- *Type:* JobSettings Job level settings that will be applied to all jobs in the stage. @@ -1458,13 +1458,13 @@ Currently the only valid setting is 'if'. --- -##### `stackCapabilities`Optional +##### `stackCapabilities`Optional ```typescript public readonly stackCapabilities: StackCapabilities[]; ``` -- *Type:* StackCapabilities[] +- *Type:* StackCapabilities[] - *Default:* ['CAPABILITY_IAM'] In some cases, you must explicitly acknowledge that your CloudFormation stack template contains certain capabilities in order for CloudFormation to create the stack. @@ -1474,14 +1474,14 @@ error. --- -### AwsCredentialsSecrets +### AwsCredentialsSecrets Names of secrets for AWS credentials. -#### Initializer +#### Initializer ```typescript -import { AwsCredentialsSecrets } from 'cdk-pipelines-github' +import { AwsCredentialsSecrets } from '@nextdoor/cdk-pipelines-github' const awsCredentialsSecrets: AwsCredentialsSecrets = { ... } ``` @@ -1490,13 +1490,13 @@ const awsCredentialsSecrets: AwsCredentialsSecrets = { ... } | **Name** | **Type** | **Description** | | --- | --- | --- | -| accessKeyId | string | *No description.* | -| secretAccessKey | string | *No description.* | -| sessionToken | string | *No description.* | +| accessKeyId | string | *No description.* | +| secretAccessKey | string | *No description.* | +| sessionToken | string | *No description.* | --- -##### `accessKeyId`Optional +##### `accessKeyId`Optional ```typescript public readonly accessKeyId: string; @@ -1507,7 +1507,7 @@ public readonly accessKeyId: string; --- -##### `secretAccessKey`Optional +##### `secretAccessKey`Optional ```typescript public readonly secretAccessKey: string; @@ -1518,7 +1518,7 @@ public readonly secretAccessKey: string; --- -##### `sessionToken`Optional +##### `sessionToken`Optional ```typescript public readonly sessionToken: string; @@ -1529,14 +1529,14 @@ public readonly sessionToken: string; --- -### CheckRunOptions +### CheckRunOptions Check run options. -#### Initializer +#### Initializer ```typescript -import { CheckRunOptions } from 'cdk-pipelines-github' +import { CheckRunOptions } from '@nextdoor/cdk-pipelines-github' const checkRunOptions: CheckRunOptions = { ... } ``` @@ -1545,11 +1545,11 @@ const checkRunOptions: CheckRunOptions = { ... } | **Name** | **Type** | **Description** | | --- | --- | --- | -| types | string[] | Which activity types to trigger on. | +| types | string[] | Which activity types to trigger on. | --- -##### `types`Optional +##### `types`Optional ```typescript public readonly types: string[]; @@ -1561,14 +1561,14 @@ Which activity types to trigger on. --- -### CheckSuiteOptions +### CheckSuiteOptions Check suite options. -#### Initializer +#### Initializer ```typescript -import { CheckSuiteOptions } from 'cdk-pipelines-github' +import { CheckSuiteOptions } from '@nextdoor/cdk-pipelines-github' const checkSuiteOptions: CheckSuiteOptions = { ... } ``` @@ -1577,11 +1577,11 @@ const checkSuiteOptions: CheckSuiteOptions = { ... } | **Name** | **Type** | **Description** | | --- | --- | --- | -| types | string[] | Which activity types to trigger on. | +| types | string[] | Which activity types to trigger on. | --- -##### `types`Optional +##### `types`Optional ```typescript public readonly types: string[]; @@ -1593,14 +1593,14 @@ Which activity types to trigger on. --- -### ContainerCredentials +### ContainerCredentials Credentials to use to authenticate to Docker registries. -#### Initializer +#### Initializer ```typescript -import { ContainerCredentials } from 'cdk-pipelines-github' +import { ContainerCredentials } from '@nextdoor/cdk-pipelines-github' const containerCredentials: ContainerCredentials = { ... } ``` @@ -1609,12 +1609,12 @@ const containerCredentials: ContainerCredentials = { ... } | **Name** | **Type** | **Description** | | --- | --- | --- | -| password | string | The password. | -| username | string | The username. | +| password | string | The password. | +| username | string | The username. | --- -##### `password`Required +##### `password`Required ```typescript public readonly password: string; @@ -1626,7 +1626,7 @@ The password. --- -##### `username`Required +##### `username`Required ```typescript public readonly username: string; @@ -1638,14 +1638,14 @@ The username. --- -### ContainerOptions +### ContainerOptions Options petaining to container environments. -#### Initializer +#### Initializer ```typescript -import { ContainerOptions } from 'cdk-pipelines-github' +import { ContainerOptions } from '@nextdoor/cdk-pipelines-github' const containerOptions: ContainerOptions = { ... } ``` @@ -1654,16 +1654,16 @@ const containerOptions: ContainerOptions = { ... } | **Name** | **Type** | **Description** | | --- | --- | --- | -| image | string | The Docker image to use as the container to run the action. | -| credentials | ContainerCredentials | f the image's container registry requires authentication to pull the image, you can use credentials to set a map of the username and password. | -| env | {[ key: string ]: string} | Sets a map of environment variables in the container. | -| options | string[] | Additional Docker container resource options. | -| ports | number[] | Sets an array of ports to expose on the container. | -| volumes | string[] | Sets an array of volumes for the container to use. | +| image | string | The Docker image to use as the container to run the action. | +| credentials | ContainerCredentials | f the image's container registry requires authentication to pull the image, you can use credentials to set a map of the username and password. | +| env | {[ key: string ]: string} | Sets a map of environment variables in the container. | +| options | string[] | Additional Docker container resource options. | +| ports | number[] | Sets an array of ports to expose on the container. | +| volumes | string[] | Sets an array of volumes for the container to use. | --- -##### `image`Required +##### `image`Required ```typescript public readonly image: string; @@ -1678,13 +1678,13 @@ be the Docker Hub image name or a registry name. --- -##### `credentials`Optional +##### `credentials`Optional ```typescript public readonly credentials: ContainerCredentials; ``` -- *Type:* ContainerCredentials +- *Type:* ContainerCredentials f the image's container registry requires authentication to pull the image, you can use credentials to set a map of the username and password. @@ -1693,7 +1693,7 @@ login command. --- -##### `env`Optional +##### `env`Optional ```typescript public readonly env: {[ key: string ]: string}; @@ -1705,7 +1705,7 @@ Sets a map of environment variables in the container. --- -##### `options`Optional +##### `options`Optional ```typescript public readonly options: string[]; @@ -1719,7 +1719,7 @@ Additional Docker container resource options. --- -##### `ports`Optional +##### `ports`Optional ```typescript public readonly ports: number[]; @@ -1731,7 +1731,7 @@ Sets an array of ports to expose on the container. --- -##### `volumes`Optional +##### `volumes`Optional ```typescript public readonly volumes: string[]; @@ -1751,27 +1751,27 @@ To specify a volume, you specify the source and destination path: --- -### CreateOptions +### CreateOptions The Create event accepts no options. -#### Initializer +#### Initializer ```typescript -import { CreateOptions } from 'cdk-pipelines-github' +import { CreateOptions } from '@nextdoor/cdk-pipelines-github' const createOptions: CreateOptions = { ... } ``` -### CronScheduleOptions +### CronScheduleOptions CRON schedule options. -#### Initializer +#### Initializer ```typescript -import { CronScheduleOptions } from 'cdk-pipelines-github' +import { CronScheduleOptions } from '@nextdoor/cdk-pipelines-github' const cronScheduleOptions: CronScheduleOptions = { ... } ``` @@ -1780,11 +1780,11 @@ const cronScheduleOptions: CronScheduleOptions = { ... } | **Name** | **Type** | **Description** | | --- | --- | --- | -| cron | string | *No description.* | +| cron | string | *No description.* | --- -##### `cron`Required +##### `cron`Required ```typescript public readonly cron: string; @@ -1796,53 +1796,53 @@ public readonly cron: string; --- -### DeleteOptions +### DeleteOptions The Delete event accepts no options. -#### Initializer +#### Initializer ```typescript -import { DeleteOptions } from 'cdk-pipelines-github' +import { DeleteOptions } from '@nextdoor/cdk-pipelines-github' const deleteOptions: DeleteOptions = { ... } ``` -### DeploymentOptions +### DeploymentOptions The Deployment event accepts no options. -#### Initializer +#### Initializer ```typescript -import { DeploymentOptions } from 'cdk-pipelines-github' +import { DeploymentOptions } from '@nextdoor/cdk-pipelines-github' const deploymentOptions: DeploymentOptions = { ... } ``` -### DeploymentStatusOptions +### DeploymentStatusOptions The Deployment status event accepts no options. -#### Initializer +#### Initializer ```typescript -import { DeploymentStatusOptions } from 'cdk-pipelines-github' +import { DeploymentStatusOptions } from '@nextdoor/cdk-pipelines-github' const deploymentStatusOptions: DeploymentStatusOptions = { ... } ``` -### DockerHubCredentialSecrets +### DockerHubCredentialSecrets Locations of GitHub Secrets used to authenticate to DockerHub. -#### Initializer +#### Initializer ```typescript -import { DockerHubCredentialSecrets } from 'cdk-pipelines-github' +import { DockerHubCredentialSecrets } from '@nextdoor/cdk-pipelines-github' const dockerHubCredentialSecrets: DockerHubCredentialSecrets = { ... } ``` @@ -1851,12 +1851,12 @@ const dockerHubCredentialSecrets: DockerHubCredentialSecrets = { ... } | **Name** | **Type** | **Description** | | --- | --- | --- | -| personalAccessTokenKey | string | The key of the GitHub Secret containing the DockerHub personal access token. | -| usernameKey | string | The key of the GitHub Secret containing the DockerHub username. | +| personalAccessTokenKey | string | The key of the GitHub Secret containing the DockerHub personal access token. | +| usernameKey | string | The key of the GitHub Secret containing the DockerHub username. | --- -##### `personalAccessTokenKey`Optional +##### `personalAccessTokenKey`Optional ```typescript public readonly personalAccessTokenKey: string; @@ -1869,7 +1869,7 @@ The key of the GitHub Secret containing the DockerHub personal access token. --- -##### `usernameKey`Optional +##### `usernameKey`Optional ```typescript public readonly usernameKey: string; @@ -1882,14 +1882,14 @@ The key of the GitHub Secret containing the DockerHub username. --- -### ExternalDockerCredentialSecrets +### ExternalDockerCredentialSecrets Generic structure to supply the locations of GitHub Secrets used to authenticate to a docker registry. -#### Initializer +#### Initializer ```typescript -import { ExternalDockerCredentialSecrets } from 'cdk-pipelines-github' +import { ExternalDockerCredentialSecrets } from '@nextdoor/cdk-pipelines-github' const externalDockerCredentialSecrets: ExternalDockerCredentialSecrets = { ... } ``` @@ -1898,12 +1898,12 @@ const externalDockerCredentialSecrets: ExternalDockerCredentialSecrets = { ... } | **Name** | **Type** | **Description** | | --- | --- | --- | -| passwordKey | string | The key of the GitHub Secret containing your registry password. | -| usernameKey | string | The key of the GitHub Secret containing your registry username. | +| passwordKey | string | The key of the GitHub Secret containing your registry password. | +| usernameKey | string | The key of the GitHub Secret containing your registry username. | --- -##### `passwordKey`Required +##### `passwordKey`Required ```typescript public readonly passwordKey: string; @@ -1915,7 +1915,7 @@ The key of the GitHub Secret containing your registry password. --- -##### `usernameKey`Required +##### `usernameKey`Required ```typescript public readonly usernameKey: string; @@ -1927,27 +1927,27 @@ The key of the GitHub Secret containing your registry username. --- -### ForkOptions +### ForkOptions The Fork event accepts no options. -#### Initializer +#### Initializer ```typescript -import { ForkOptions } from 'cdk-pipelines-github' +import { ForkOptions } from '@nextdoor/cdk-pipelines-github' const forkOptions: ForkOptions = { ... } ``` -### GitHubActionRoleProps +### GitHubActionRoleProps Properties for the GitHubActionRole construct. -#### Initializer +#### Initializer ```typescript -import { GitHubActionRoleProps } from 'cdk-pipelines-github' +import { GitHubActionRoleProps } from '@nextdoor/cdk-pipelines-github' const gitHubActionRoleProps: GitHubActionRoleProps = { ... } ``` @@ -1956,14 +1956,14 @@ const gitHubActionRoleProps: GitHubActionRoleProps = { ... } | **Name** | **Type** | **Description** | | --- | --- | --- | -| repos | string[] | A list of GitHub repositories you want to be able to access the IAM role. | -| provider | aws-cdk-lib.aws_iam.IOpenIdConnectProvider | The GitHub OpenId Connect Provider. Must have provider url `https://token.actions.githubusercontent.com`. The audience must be `sts:amazonaws.com`. | -| roleName | string | The name of the Oidc role. | -| thumbprints | string[] | Thumbprints of GitHub's certificates. | +| repos | string[] | A list of GitHub repositories you want to be able to access the IAM role. | +| provider | aws-cdk-lib.aws_iam.IOpenIdConnectProvider | The GitHub OpenId Connect Provider. Must have provider url `https://token.actions.githubusercontent.com`. The audience must be `sts:amazonaws.com`. | +| roleName | string | The name of the Oidc role. | +| thumbprints | string[] | Thumbprints of GitHub's certificates. | --- -##### `repos`Required +##### `repos`Required ```typescript public readonly repos: string[]; @@ -1980,7 +1980,7 @@ For example, `['owner/repo1', 'owner/repo2']. --- -##### `provider`Optional +##### `provider`Optional ```typescript public readonly provider: IOpenIdConnectProvider; @@ -1996,7 +1996,7 @@ have a provider with the same url, a new provider cannot be created for you. --- -##### `roleName`Optional +##### `roleName`Optional ```typescript public readonly roleName: string; @@ -2009,7 +2009,7 @@ The name of the Oidc role. --- -##### `thumbprints`Optional +##### `thumbprints`Optional ```typescript public readonly thumbprints: string[]; @@ -2027,12 +2027,12 @@ https://github.blog/changelog/2023-06-27-github-actions-update-on-oidc-integrati --- -### GitHubActionStepProps +### GitHubActionStepProps -#### Initializer +#### Initializer ```typescript -import { GitHubActionStepProps } from 'cdk-pipelines-github' +import { GitHubActionStepProps } from '@nextdoor/cdk-pipelines-github' const gitHubActionStepProps: GitHubActionStepProps = { ... } ``` @@ -2041,24 +2041,24 @@ const gitHubActionStepProps: GitHubActionStepProps = { ... } | **Name** | **Type** | **Description** | | --- | --- | --- | -| jobSteps | JobStep[] | The Job steps. | -| env | {[ key: string ]: string} | Environment variables to set. | +| jobSteps | JobStep[] | The Job steps. | +| env | {[ key: string ]: string} | Environment variables to set. | --- -##### `jobSteps`Required +##### `jobSteps`Required ```typescript public readonly jobSteps: JobStep[]; ``` -- *Type:* JobStep[] +- *Type:* JobStep[] The Job steps. --- -##### `env`Optional +##### `env`Optional ```typescript public readonly env: {[ key: string ]: string}; @@ -2070,14 +2070,14 @@ Environment variables to set. --- -### GitHubCommonProps +### GitHubCommonProps Common properties to extend both StageProps and AddStageOpts. -#### Initializer +#### Initializer ```typescript -import { GitHubCommonProps } from 'cdk-pipelines-github' +import { GitHubCommonProps } from '@nextdoor/cdk-pipelines-github' const gitHubCommonProps: GitHubCommonProps = { ... } ``` @@ -2086,19 +2086,19 @@ const gitHubCommonProps: GitHubCommonProps = { ... } | **Name** | **Type** | **Description** | | --- | --- | --- | -| gitHubEnvironment | GitHubEnvironment | Run the stage in a specific GitHub Environment. | -| jobSettings | JobSettings | Job level settings that will be applied to all jobs in the stage. | -| stackCapabilities | StackCapabilities[] | In some cases, you must explicitly acknowledge that your CloudFormation stack template contains certain capabilities in order for CloudFormation to create the stack. | +| gitHubEnvironment | GitHubEnvironment | Run the stage in a specific GitHub Environment. | +| jobSettings | JobSettings | Job level settings that will be applied to all jobs in the stage. | +| stackCapabilities | StackCapabilities[] | In some cases, you must explicitly acknowledge that your CloudFormation stack template contains certain capabilities in order for CloudFormation to create the stack. | --- -##### `gitHubEnvironment`Optional +##### `gitHubEnvironment`Optional ```typescript public readonly gitHubEnvironment: GitHubEnvironment; ``` -- *Type:* GitHubEnvironment +- *Type:* GitHubEnvironment - *Default:* no GitHub environment Run the stage in a specific GitHub Environment. @@ -2116,13 +2116,13 @@ exist will create an environment with the referenced name. --- -##### `jobSettings`Optional +##### `jobSettings`Optional ```typescript public readonly jobSettings: JobSettings; ``` -- *Type:* JobSettings +- *Type:* JobSettings Job level settings that will be applied to all jobs in the stage. @@ -2130,13 +2130,13 @@ Currently the only valid setting is 'if'. --- -##### `stackCapabilities`Optional +##### `stackCapabilities`Optional ```typescript public readonly stackCapabilities: StackCapabilities[]; ``` -- *Type:* StackCapabilities[] +- *Type:* StackCapabilities[] - *Default:* ['CAPABILITY_IAM'] In some cases, you must explicitly acknowledge that your CloudFormation stack template contains certain capabilities in order for CloudFormation to create the stack. @@ -2146,16 +2146,16 @@ error. --- -### GitHubEnvironment +### GitHubEnvironment Github environment with name and url. > [https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idenvironment](https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idenvironment) -#### Initializer +#### Initializer ```typescript -import { GitHubEnvironment } from 'cdk-pipelines-github' +import { GitHubEnvironment } from '@nextdoor/cdk-pipelines-github' const gitHubEnvironment: GitHubEnvironment = { ... } ``` @@ -2164,12 +2164,12 @@ const gitHubEnvironment: GitHubEnvironment = { ... } | **Name** | **Type** | **Description** | | --- | --- | --- | -| name | string | Name of the environment. | -| url | string | The url for the environment. | +| name | string | Name of the environment. | +| url | string | The url for the environment. | --- -##### `name`Required +##### `name`Required ```typescript public readonly name: string; @@ -2183,7 +2183,7 @@ Name of the environment. --- -##### `url`Optional +##### `url`Optional ```typescript public readonly url: string; @@ -2197,14 +2197,14 @@ The url for the environment. --- -### GitHubSecretsProviderProps +### GitHubSecretsProviderProps Locations of GitHub Secrets used to authenticate to AWS. -#### Initializer +#### Initializer ```typescript -import { GitHubSecretsProviderProps } from 'cdk-pipelines-github' +import { GitHubSecretsProviderProps } from '@nextdoor/cdk-pipelines-github' const gitHubSecretsProviderProps: GitHubSecretsProviderProps = { ... } ``` @@ -2213,13 +2213,13 @@ const gitHubSecretsProviderProps: GitHubSecretsProviderProps = { ... } | **Name** | **Type** | **Description** | | --- | --- | --- | -| accessKeyId | string | *No description.* | -| secretAccessKey | string | *No description.* | -| sessionToken | string | *No description.* | +| accessKeyId | string | *No description.* | +| secretAccessKey | string | *No description.* | +| sessionToken | string | *No description.* | --- -##### `accessKeyId`Required +##### `accessKeyId`Required ```typescript public readonly accessKeyId: string; @@ -2230,7 +2230,7 @@ public readonly accessKeyId: string; --- -##### `secretAccessKey`Required +##### `secretAccessKey`Required ```typescript public readonly secretAccessKey: string; @@ -2241,7 +2241,7 @@ public readonly secretAccessKey: string; --- -##### `sessionToken`Optional +##### `sessionToken`Optional ```typescript public readonly sessionToken: string; @@ -2252,12 +2252,12 @@ public readonly sessionToken: string; --- -### GitHubStageProps +### GitHubStageProps -#### Initializer +#### Initializer ```typescript -import { GitHubStageProps } from 'cdk-pipelines-github' +import { GitHubStageProps } from '@nextdoor/cdk-pipelines-github' const gitHubStageProps: GitHubStageProps = { ... } ``` @@ -2266,15 +2266,15 @@ const gitHubStageProps: GitHubStageProps = { ... } | **Name** | **Type** | **Description** | | --- | --- | --- | -| env | aws-cdk-lib.Environment | Default AWS environment (account/region) for `Stack`s in this `Stage`. | -| outdir | string | The output directory into which to emit synthesized artifacts. | -| gitHubEnvironment | GitHubEnvironment | Run the stage in a specific GitHub Environment. | -| jobSettings | JobSettings | Job level settings that will be applied to all jobs in the stage. | -| stackCapabilities | StackCapabilities[] | In some cases, you must explicitly acknowledge that your CloudFormation stack template contains certain capabilities in order for CloudFormation to create the stack. | +| env | aws-cdk-lib.Environment | Default AWS environment (account/region) for `Stack`s in this `Stage`. | +| outdir | string | The output directory into which to emit synthesized artifacts. | +| gitHubEnvironment | GitHubEnvironment | Run the stage in a specific GitHub Environment. | +| jobSettings | JobSettings | Job level settings that will be applied to all jobs in the stage. | +| stackCapabilities | StackCapabilities[] | In some cases, you must explicitly acknowledge that your CloudFormation stack template contains certain capabilities in order for CloudFormation to create the stack. | --- -##### `env`Optional +##### `env`Optional ```typescript public readonly env: Environment; @@ -2315,7 +2315,7 @@ new Stage(app, 'Stage2', { ``` -##### `outdir`Optional +##### `outdir`Optional ```typescript public readonly outdir: string; @@ -2332,13 +2332,13 @@ thrown. --- -##### `gitHubEnvironment`Optional +##### `gitHubEnvironment`Optional ```typescript public readonly gitHubEnvironment: GitHubEnvironment; ``` -- *Type:* GitHubEnvironment +- *Type:* GitHubEnvironment - *Default:* no GitHub environment Run the stage in a specific GitHub Environment. @@ -2356,13 +2356,13 @@ exist will create an environment with the referenced name. --- -##### `jobSettings`Optional +##### `jobSettings`Optional ```typescript public readonly jobSettings: JobSettings; ``` -- *Type:* JobSettings +- *Type:* JobSettings Job level settings that will be applied to all jobs in the stage. @@ -2370,13 +2370,13 @@ Currently the only valid setting is 'if'. --- -##### `stackCapabilities`Optional +##### `stackCapabilities`Optional ```typescript public readonly stackCapabilities: StackCapabilities[]; ``` -- *Type:* StackCapabilities[] +- *Type:* StackCapabilities[] - *Default:* ['CAPABILITY_IAM'] In some cases, you must explicitly acknowledge that your CloudFormation stack template contains certain capabilities in order for CloudFormation to create the stack. @@ -2386,14 +2386,14 @@ error. --- -### GitHubWorkflowProps +### GitHubWorkflowProps Props for `GitHubWorkflow`. -#### Initializer +#### Initializer ```typescript -import { GitHubWorkflowProps } from 'cdk-pipelines-github' +import { GitHubWorkflowProps } from '@nextdoor/cdk-pipelines-github' const gitHubWorkflowProps: GitHubWorkflowProps = { ... } ``` @@ -2402,26 +2402,26 @@ const gitHubWorkflowProps: GitHubWorkflowProps = { ... } | **Name** | **Type** | **Description** | | --- | --- | --- | -| synth | aws-cdk-lib.pipelines.IFileSetProducer | The build step that produces the CDK Cloud Assembly. | -| awsCredentials | AwsCredentialsSecrets | Names of GitHub repository secrets that include AWS credentials for deployment. | -| awsCreds | AwsCredentialsProvider | Configure provider for AWS credentials used for deployment. | -| buildContainer | ContainerOptions | Build container options. | -| cdkCliVersion | string | Version of the CDK CLI to use. | -| dockerCredentials | DockerCredential[] | The Docker Credentials to use to login. | -| gitHubActionRoleArn | string | A role that utilizes the GitHub OIDC Identity Provider in your AWS account. | -| jobSettings | JobSettings | Job level settings that will be applied to all jobs in the workflow, including synth and asset deploy jobs. | -| postBuildSteps | JobStep[] | GitHub workflow steps to execute after build. | -| preBuildSteps | JobStep[] | GitHub workflow steps to execute before build. | -| preSynthed | boolean | Indicates if the repository already contains a synthesized `cdk.out` directory, in which case we will simply checkout the repo in jobs that require `cdk.out`. | -| publishAssetsAuthRegion | string | Will assume the GitHubActionRole in this region when publishing assets. | -| runner | Runner | The type of runner to run the job on. | -| workflowName | string | Name of the workflow. | -| workflowPath | string | File path for the GitHub workflow. | -| workflowTriggers | WorkflowTriggers | GitHub workflow triggers. | +| synth | aws-cdk-lib.pipelines.IFileSetProducer | The build step that produces the CDK Cloud Assembly. | +| awsCredentials | AwsCredentialsSecrets | Names of GitHub repository secrets that include AWS credentials for deployment. | +| awsCreds | AwsCredentialsProvider | Configure provider for AWS credentials used for deployment. | +| buildContainer | ContainerOptions | Build container options. | +| cdkCliVersion | string | Version of the CDK CLI to use. | +| dockerCredentials | DockerCredential[] | The Docker Credentials to use to login. | +| gitHubActionRoleArn | string | A role that utilizes the GitHub OIDC Identity Provider in your AWS account. | +| jobSettings | JobSettings | Job level settings that will be applied to all jobs in the workflow, including synth and asset deploy jobs. | +| postBuildSteps | JobStep[] | GitHub workflow steps to execute after build. | +| preBuildSteps | JobStep[] | GitHub workflow steps to execute before build. | +| preSynthed | boolean | Indicates if the repository already contains a synthesized `cdk.out` directory, in which case we will simply checkout the repo in jobs that require `cdk.out`. | +| publishAssetsAuthRegion | string | Will assume the GitHubActionRole in this region when publishing assets. | +| runner | Runner | The type of runner to run the job on. | +| workflowName | string | Name of the workflow. | +| workflowPath | string | File path for the GitHub workflow. | +| workflowTriggers | WorkflowTriggers | GitHub workflow triggers. | --- -##### `synth`Required +##### `synth`Required ```typescript public readonly synth: IFileSetProducer; @@ -2439,7 +2439,7 @@ the output directory will automatically be assumed to be `cdk.out`. --- -##### ~~`awsCredentials`~~Optional +##### ~~`awsCredentials`~~Optional - *Deprecated:* Use `awsCreds.fromGitHubSecrets()` instead. @@ -2447,40 +2447,40 @@ the output directory will automatically be assumed to be `cdk.out`. public readonly awsCredentials: AwsCredentialsSecrets; ``` -- *Type:* AwsCredentialsSecrets +- *Type:* AwsCredentialsSecrets - *Default:* `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY`. Names of GitHub repository secrets that include AWS credentials for deployment. --- -##### `awsCreds`Optional +##### `awsCreds`Optional ```typescript public readonly awsCreds: AwsCredentialsProvider; ``` -- *Type:* AwsCredentialsProvider +- *Type:* AwsCredentialsProvider - *Default:* Get AWS credentials from GitHub secrets `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY`. Configure provider for AWS credentials used for deployment. --- -##### `buildContainer`Optional +##### `buildContainer`Optional ```typescript public readonly buildContainer: ContainerOptions; ``` -- *Type:* ContainerOptions +- *Type:* ContainerOptions - *Default:* GitHub defaults Build container options. --- -##### `cdkCliVersion`Optional +##### `cdkCliVersion`Optional ```typescript public readonly cdkCliVersion: string; @@ -2493,13 +2493,13 @@ Version of the CDK CLI to use. --- -##### `dockerCredentials`Optional +##### `dockerCredentials`Optional ```typescript public readonly dockerCredentials: DockerCredential[]; ``` -- *Type:* DockerCredential[] +- *Type:* DockerCredential[] The Docker Credentials to use to login. @@ -2508,7 +2508,7 @@ you will be logged in to docker when you upload Docker Assets. --- -##### ~~`gitHubActionRoleArn`~~Optional +##### ~~`gitHubActionRoleArn`~~Optional - *Deprecated:* Use `awsCreds.fromOpenIdConnect()` instead. @@ -2529,13 +2529,13 @@ you can utilize the `GitHubActionRole` construct to create a role for you. --- -##### `jobSettings`Optional +##### `jobSettings`Optional ```typescript public readonly jobSettings: JobSettings; ``` -- *Type:* JobSettings +- *Type:* JobSettings Job level settings that will be applied to all jobs in the workflow, including synth and asset deploy jobs. @@ -2546,33 +2546,33 @@ is 'if'. You can use this to run jobs only in specific repositories. --- -##### `postBuildSteps`Optional +##### `postBuildSteps`Optional ```typescript public readonly postBuildSteps: JobStep[]; ``` -- *Type:* JobStep[] +- *Type:* JobStep[] - *Default:* [] GitHub workflow steps to execute after build. --- -##### `preBuildSteps`Optional +##### `preBuildSteps`Optional ```typescript public readonly preBuildSteps: JobStep[]; ``` -- *Type:* JobStep[] +- *Type:* JobStep[] - *Default:* [] GitHub workflow steps to execute before build. --- -##### `preSynthed`Optional +##### `preSynthed`Optional ```typescript public readonly preSynthed: boolean; @@ -2585,7 +2585,7 @@ Indicates if the repository already contains a synthesized `cdk.out` directory, --- -##### `publishAssetsAuthRegion`Optional +##### `publishAssetsAuthRegion`Optional ```typescript public readonly publishAssetsAuthRegion: string; @@ -2603,13 +2603,13 @@ ignore it. --- -##### `runner`Optional +##### `runner`Optional ```typescript public readonly runner: Runner; ``` -- *Type:* Runner +- *Type:* Runner - *Default:* Runner.UBUNTU_LATEST The type of runner to run the job on. @@ -2619,7 +2619,7 @@ GitHub-hosted runner or a self-hosted runner. --- -##### `workflowName`Optional +##### `workflowName`Optional ```typescript public readonly workflowName: string; @@ -2632,7 +2632,7 @@ Name of the workflow. --- -##### `workflowPath`Optional +##### `workflowPath`Optional ```typescript public readonly workflowPath: string; @@ -2645,40 +2645,40 @@ File path for the GitHub workflow. --- -##### `workflowTriggers`Optional +##### `workflowTriggers`Optional ```typescript public readonly workflowTriggers: WorkflowTriggers; ``` -- *Type:* WorkflowTriggers +- *Type:* WorkflowTriggers - *Default:* By default, workflow is triggered on push to the `main` branch and can also be triggered manually (`workflow_dispatch`). GitHub workflow triggers. --- -### GollumOptions +### GollumOptions The Gollum event accepts no options. -#### Initializer +#### Initializer ```typescript -import { GollumOptions } from 'cdk-pipelines-github' +import { GollumOptions } from '@nextdoor/cdk-pipelines-github' const gollumOptions: GollumOptions = { ... } ``` -### IssueCommentOptions +### IssueCommentOptions Issue comment options. -#### Initializer +#### Initializer ```typescript -import { IssueCommentOptions } from 'cdk-pipelines-github' +import { IssueCommentOptions } from '@nextdoor/cdk-pipelines-github' const issueCommentOptions: IssueCommentOptions = { ... } ``` @@ -2687,11 +2687,11 @@ const issueCommentOptions: IssueCommentOptions = { ... } | **Name** | **Type** | **Description** | | --- | --- | --- | -| types | string[] | Which activity types to trigger on. | +| types | string[] | Which activity types to trigger on. | --- -##### `types`Optional +##### `types`Optional ```typescript public readonly types: string[]; @@ -2703,14 +2703,14 @@ Which activity types to trigger on. --- -### IssuesOptions +### IssuesOptions Issues options. -#### Initializer +#### Initializer ```typescript -import { IssuesOptions } from 'cdk-pipelines-github' +import { IssuesOptions } from '@nextdoor/cdk-pipelines-github' const issuesOptions: IssuesOptions = { ... } ``` @@ -2719,11 +2719,11 @@ const issuesOptions: IssuesOptions = { ... } | **Name** | **Type** | **Description** | | --- | --- | --- | -| types | string[] | Which activity types to trigger on. | +| types | string[] | Which activity types to trigger on. | --- -##### `types`Optional +##### `types`Optional ```typescript public readonly types: string[]; @@ -2735,14 +2735,14 @@ Which activity types to trigger on. --- -### Job +### Job A GitHub Workflow job definition. -#### Initializer +#### Initializer ```typescript -import { Job } from 'cdk-pipelines-github' +import { Job } from '@nextdoor/cdk-pipelines-github' const job: Job = { ... } ``` @@ -2751,32 +2751,32 @@ const job: Job = { ... } | **Name** | **Type** | **Description** | | --- | --- | --- | -| permissions | JobPermissions | You can modify the default permissions granted to the GITHUB_TOKEN, adding or removing access as required, so that you only allow the minimum required access. | -| runsOn | string \| string[] | The type of machine to run the job on. | -| steps | JobStep[] | A job contains a sequence of tasks called steps. | -| concurrency | any | Concurrency ensures that only a single job or workflow using the same concurrency group will run at a time. | -| container | ContainerOptions | A container to run any steps in a job that don't already specify a container. | -| continueOnError | boolean | Prevents a workflow run from failing when a job fails. | -| defaults | JobDefaults | A map of default settings that will apply to all steps in the job. | -| env | {[ key: string ]: string} | A map of environment variables that are available to all steps in the job. | -| environment | any | The environment that the job references. | -| if | string | You can use the if conditional to prevent a job from running unless a condition is met. | -| name | string | The name of the job displayed on GitHub. | -| needs | string[] | Identifies any jobs that must complete successfully before this job will run. | -| outputs | {[ key: string ]: string} | A map of outputs for a job. | -| services | {[ key: string ]: ContainerOptions} | Used to host service containers for a job in a workflow. | -| strategy | JobStrategy | A strategy creates a build matrix for your jobs. | -| timeoutMinutes | number | The maximum number of minutes to let a job run before GitHub automatically cancels it. | +| permissions | JobPermissions | You can modify the default permissions granted to the GITHUB_TOKEN, adding or removing access as required, so that you only allow the minimum required access. | +| runsOn | string \| string[] | The type of machine to run the job on. | +| steps | JobStep[] | A job contains a sequence of tasks called steps. | +| concurrency | any | Concurrency ensures that only a single job or workflow using the same concurrency group will run at a time. | +| container | ContainerOptions | A container to run any steps in a job that don't already specify a container. | +| continueOnError | boolean | Prevents a workflow run from failing when a job fails. | +| defaults | JobDefaults | A map of default settings that will apply to all steps in the job. | +| env | {[ key: string ]: string} | A map of environment variables that are available to all steps in the job. | +| environment | any | The environment that the job references. | +| if | string | You can use the if conditional to prevent a job from running unless a condition is met. | +| name | string | The name of the job displayed on GitHub. | +| needs | string[] | Identifies any jobs that must complete successfully before this job will run. | +| outputs | {[ key: string ]: string} | A map of outputs for a job. | +| services | {[ key: string ]: ContainerOptions} | Used to host service containers for a job in a workflow. | +| strategy | JobStrategy | A strategy creates a build matrix for your jobs. | +| timeoutMinutes | number | The maximum number of minutes to let a job run before GitHub automatically cancels it. | --- -##### `permissions`Required +##### `permissions`Required ```typescript public readonly permissions: JobPermissions; ``` -- *Type:* JobPermissions +- *Type:* JobPermissions You can modify the default permissions granted to the GITHUB_TOKEN, adding or removing access as required, so that you only allow the minimum required access. @@ -2790,7 +2790,7 @@ access. --- -##### `runsOn`Required +##### `runsOn`Required ```typescript public readonly runsOn: string | string[]; @@ -2812,13 +2812,13 @@ GitHub-hosted runner or a self-hosted runner. ``` -##### `steps`Required +##### `steps`Required ```typescript public readonly steps: JobStep[]; ``` -- *Type:* JobStep[] +- *Type:* JobStep[] A job contains a sequence of tasks called steps. @@ -2833,7 +2833,7 @@ and complete a job. --- -##### `concurrency`Optional +##### `concurrency`Optional ```typescript public readonly concurrency: any; @@ -2849,13 +2849,13 @@ secrets context. --- -##### `container`Optional +##### `container`Optional ```typescript public readonly container: ContainerOptions; ``` -- *Type:* ContainerOptions +- *Type:* ContainerOptions A container to run any steps in a job that don't already specify a container. @@ -2865,7 +2865,7 @@ with the same volume mounts. --- -##### `continueOnError`Optional +##### `continueOnError`Optional ```typescript public readonly continueOnError: boolean; @@ -2880,13 +2880,13 @@ allow a workflow run to pass when this job fails. --- -##### `defaults`Optional +##### `defaults`Optional ```typescript public readonly defaults: JobDefaults; ``` -- *Type:* JobDefaults +- *Type:* JobDefaults A map of default settings that will apply to all steps in the job. @@ -2895,7 +2895,7 @@ can also set default settings for the entire workflow. --- -##### `env`Optional +##### `env`Optional ```typescript public readonly env: {[ key: string ]: string}; @@ -2910,7 +2910,7 @@ individual step. --- -##### `environment`Optional +##### `environment`Optional ```typescript public readonly environment: any; @@ -2927,7 +2927,7 @@ must pass before a job referencing the environment is sent to a runner. --- -##### `if`Optional +##### `if`Optional ```typescript public readonly if: string; @@ -2942,7 +2942,7 @@ create a conditional. --- -##### `name`Optional +##### `name`Optional ```typescript public readonly name: string; @@ -2954,7 +2954,7 @@ The name of the job displayed on GitHub. --- -##### `needs`Optional +##### `needs`Optional ```typescript public readonly needs: string[]; @@ -2970,7 +2970,7 @@ that causes the job to continue. --- -##### `outputs`Optional +##### `outputs`Optional ```typescript public readonly outputs: {[ key: string ]: string}; @@ -2985,13 +2985,13 @@ jobs that depend on this job. --- -##### `services`Optional +##### `services`Optional ```typescript public readonly services: {[ key: string ]: ContainerOptions}; ``` -- *Type:* {[ key: string ]: ContainerOptions} +- *Type:* {[ key: string ]: ContainerOptions} Used to host service containers for a job in a workflow. @@ -3002,13 +3002,13 @@ cycle of the service containers. --- -##### `strategy`Optional +##### `strategy`Optional ```typescript public readonly strategy: JobStrategy; ``` -- *Type:* JobStrategy +- *Type:* JobStrategy A strategy creates a build matrix for your jobs. @@ -3017,7 +3017,7 @@ variations to run each job in. --- -##### `timeoutMinutes`Optional +##### `timeoutMinutes`Optional ```typescript public readonly timeoutMinutes: number; @@ -3030,14 +3030,14 @@ The maximum number of minutes to let a job run before GitHub automatically cance --- -### JobDefaults +### JobDefaults Default settings for all steps in the job. -#### Initializer +#### Initializer ```typescript -import { JobDefaults } from 'cdk-pipelines-github' +import { JobDefaults } from '@nextdoor/cdk-pipelines-github' const jobDefaults: JobDefaults = { ... } ``` @@ -3046,30 +3046,30 @@ const jobDefaults: JobDefaults = { ... } | **Name** | **Type** | **Description** | | --- | --- | --- | -| run | RunSettings | Default run settings. | +| run | RunSettings | Default run settings. | --- -##### `run`Optional +##### `run`Optional ```typescript public readonly run: RunSettings; ``` -- *Type:* RunSettings +- *Type:* RunSettings Default run settings. --- -### JobMatrix +### JobMatrix A job matrix. -#### Initializer +#### Initializer ```typescript -import { JobMatrix } from 'cdk-pipelines-github' +import { JobMatrix } from '@nextdoor/cdk-pipelines-github' const jobMatrix: JobMatrix = { ... } ``` @@ -3078,13 +3078,13 @@ const jobMatrix: JobMatrix = { ... } | **Name** | **Type** | **Description** | | --- | --- | --- | -| domain | {[ key: string ]: string[]} | Each option you define in the matrix has a key and value. | -| exclude | {[ key: string ]: string}[] | You can remove a specific configurations defined in the build matrix using the exclude option. | -| include | {[ key: string ]: string}[] | You can add additional configuration options to a build matrix job that already exists. | +| domain | {[ key: string ]: string[]} | Each option you define in the matrix has a key and value. | +| exclude | {[ key: string ]: string}[] | You can remove a specific configurations defined in the build matrix using the exclude option. | +| include | {[ key: string ]: string}[] | You can add additional configuration options to a build matrix job that already exists. | --- -##### `domain`Optional +##### `domain`Optional ```typescript public readonly domain: {[ key: string ]: string[]}; @@ -3103,7 +3103,7 @@ for each operating system. --- -##### `exclude`Optional +##### `exclude`Optional ```typescript public readonly exclude: {[ key: string ]: string}[]; @@ -3118,7 +3118,7 @@ build matrix. --- -##### `include`Optional +##### `include`Optional ```typescript public readonly include: {[ key: string ]: string}[]; @@ -3134,7 +3134,7 @@ use include to specify that additional option. --- -### JobPermissions +### JobPermissions The available scopes and access values for workflow permissions. @@ -3143,10 +3143,10 @@ specify the access for any of these scopes, all those that are not specified are set to `JobPermission.NONE`, instead of the default behavior when none is specified. -#### Initializer +#### Initializer ```typescript -import { JobPermissions } from 'cdk-pipelines-github' +import { JobPermissions } from '@nextdoor/cdk-pipelines-github' const jobPermissions: JobPermissions = { ... } ``` @@ -3155,149 +3155,149 @@ const jobPermissions: JobPermissions = { ... } | **Name** | **Type** | **Description** | | --- | --- | --- | -| actions | JobPermission | *No description.* | -| checks | JobPermission | *No description.* | -| contents | JobPermission | *No description.* | -| deployments | JobPermission | *No description.* | -| discussions | JobPermission | *No description.* | -| idToken | JobPermission | *No description.* | -| issues | JobPermission | *No description.* | -| packages | JobPermission | *No description.* | -| pullRequests | JobPermission | *No description.* | -| repositoryProjects | JobPermission | *No description.* | -| securityEvents | JobPermission | *No description.* | -| statuses | JobPermission | *No description.* | +| actions | JobPermission | *No description.* | +| checks | JobPermission | *No description.* | +| contents | JobPermission | *No description.* | +| deployments | JobPermission | *No description.* | +| discussions | JobPermission | *No description.* | +| idToken | JobPermission | *No description.* | +| issues | JobPermission | *No description.* | +| packages | JobPermission | *No description.* | +| pullRequests | JobPermission | *No description.* | +| repositoryProjects | JobPermission | *No description.* | +| securityEvents | JobPermission | *No description.* | +| statuses | JobPermission | *No description.* | --- -##### `actions`Optional +##### `actions`Optional ```typescript public readonly actions: JobPermission; ``` -- *Type:* JobPermission +- *Type:* JobPermission --- -##### `checks`Optional +##### `checks`Optional ```typescript public readonly checks: JobPermission; ``` -- *Type:* JobPermission +- *Type:* JobPermission --- -##### `contents`Optional +##### `contents`Optional ```typescript public readonly contents: JobPermission; ``` -- *Type:* JobPermission +- *Type:* JobPermission --- -##### `deployments`Optional +##### `deployments`Optional ```typescript public readonly deployments: JobPermission; ``` -- *Type:* JobPermission +- *Type:* JobPermission --- -##### `discussions`Optional +##### `discussions`Optional ```typescript public readonly discussions: JobPermission; ``` -- *Type:* JobPermission +- *Type:* JobPermission --- -##### `idToken`Optional +##### `idToken`Optional ```typescript public readonly idToken: JobPermission; ``` -- *Type:* JobPermission +- *Type:* JobPermission --- -##### `issues`Optional +##### `issues`Optional ```typescript public readonly issues: JobPermission; ``` -- *Type:* JobPermission +- *Type:* JobPermission --- -##### `packages`Optional +##### `packages`Optional ```typescript public readonly packages: JobPermission; ``` -- *Type:* JobPermission +- *Type:* JobPermission --- -##### `pullRequests`Optional +##### `pullRequests`Optional ```typescript public readonly pullRequests: JobPermission; ``` -- *Type:* JobPermission +- *Type:* JobPermission --- -##### `repositoryProjects`Optional +##### `repositoryProjects`Optional ```typescript public readonly repositoryProjects: JobPermission; ``` -- *Type:* JobPermission +- *Type:* JobPermission --- -##### `securityEvents`Optional +##### `securityEvents`Optional ```typescript public readonly securityEvents: JobPermission; ``` -- *Type:* JobPermission +- *Type:* JobPermission --- -##### `statuses`Optional +##### `statuses`Optional ```typescript public readonly statuses: JobPermission; ``` -- *Type:* JobPermission +- *Type:* JobPermission --- -### JobSettings +### JobSettings Job level settings applied to all jobs in the workflow. -#### Initializer +#### Initializer ```typescript -import { JobSettings } from 'cdk-pipelines-github' +import { JobSettings } from '@nextdoor/cdk-pipelines-github' const jobSettings: JobSettings = { ... } ``` @@ -3306,11 +3306,11 @@ const jobSettings: JobSettings = { ... } | **Name** | **Type** | **Description** | | --- | --- | --- | -| if | string | jobs..if. | +| if | string | jobs..if. | --- -##### `if`Optional +##### `if`Optional ```typescript public readonly if: string; @@ -3324,14 +3324,14 @@ jobs..if. --- -### JobStep +### JobStep A job step. -#### Initializer +#### Initializer ```typescript -import { JobStep } from 'cdk-pipelines-github' +import { JobStep } from '@nextdoor/cdk-pipelines-github' const jobStep: JobStep = { ... } ``` @@ -3340,19 +3340,19 @@ const jobStep: JobStep = { ... } | **Name** | **Type** | **Description** | | --- | --- | --- | -| continueOnError | boolean | Prevents a job from failing when a step fails. | -| env | {[ key: string ]: string} | Sets environment variables for steps to use in the runner environment. | -| id | string | A unique identifier for the step. | -| if | string | You can use the if conditional to prevent a job from running unless a condition is met. | -| name | string | A name for your step to display on GitHub. | -| run | string | Runs command-line programs using the operating system's shell. | -| timeoutMinutes | number | The maximum number of minutes to run the step before killing the process. | -| uses | string | Selects an action to run as part of a step in your job. | -| with | {[ key: string ]: any} | A map of the input parameters defined by the action. | +| continueOnError | boolean | Prevents a job from failing when a step fails. | +| env | {[ key: string ]: string} | Sets environment variables for steps to use in the runner environment. | +| id | string | A unique identifier for the step. | +| if | string | You can use the if conditional to prevent a job from running unless a condition is met. | +| name | string | A name for your step to display on GitHub. | +| run | string | Runs command-line programs using the operating system's shell. | +| timeoutMinutes | number | The maximum number of minutes to run the step before killing the process. | +| uses | string | Selects an action to run as part of a step in your job. | +| with | {[ key: string ]: any} | A map of the input parameters defined by the action. | --- -##### `continueOnError`Optional +##### `continueOnError`Optional ```typescript public readonly continueOnError: boolean; @@ -3367,7 +3367,7 @@ to pass when this step fails. --- -##### `env`Optional +##### `env`Optional ```typescript public readonly env: {[ key: string ]: string}; @@ -3381,7 +3381,7 @@ You can also set environment variables for the entire workflow or a job. --- -##### `id`Optional +##### `id`Optional ```typescript public readonly id: string; @@ -3396,7 +3396,7 @@ step in contexts. --- -##### `if`Optional +##### `if`Optional ```typescript public readonly if: string; @@ -3411,7 +3411,7 @@ create a conditional. --- -##### `name`Optional +##### `name`Optional ```typescript public readonly name: string; @@ -3423,7 +3423,7 @@ A name for your step to display on GitHub. --- -##### `run`Optional +##### `run`Optional ```typescript public readonly run: string; @@ -3439,7 +3439,7 @@ the run command. --- -##### `timeoutMinutes`Optional +##### `timeoutMinutes`Optional ```typescript public readonly timeoutMinutes: number; @@ -3451,7 +3451,7 @@ The maximum number of minutes to run the step before killing the process. --- -##### `uses`Optional +##### `uses`Optional ```typescript public readonly uses: string; @@ -3468,7 +3468,7 @@ container image. --- -##### `with`Optional +##### `with`Optional ```typescript public readonly with: {[ key: string ]: any}; @@ -3484,14 +3484,14 @@ The variable is prefixed with INPUT_ and converted to upper case. --- -### JobStepOutput +### JobStepOutput An output binding for a job. -#### Initializer +#### Initializer ```typescript -import { JobStepOutput } from 'cdk-pipelines-github' +import { JobStepOutput } from '@nextdoor/cdk-pipelines-github' const jobStepOutput: JobStepOutput = { ... } ``` @@ -3500,12 +3500,12 @@ const jobStepOutput: JobStepOutput = { ... } | **Name** | **Type** | **Description** | | --- | --- | --- | -| outputName | string | The name of the job output that is being bound. | -| stepId | string | The ID of the step that exposes the output. | +| outputName | string | The name of the job output that is being bound. | +| stepId | string | The ID of the step that exposes the output. | --- -##### `outputName`Required +##### `outputName`Required ```typescript public readonly outputName: string; @@ -3517,7 +3517,7 @@ The name of the job output that is being bound. --- -##### `stepId`Required +##### `stepId`Required ```typescript public readonly stepId: string; @@ -3529,17 +3529,17 @@ The ID of the step that exposes the output. --- -### JobStrategy +### JobStrategy A strategy creates a build matrix for your jobs. You can define different variations to run each job in. -#### Initializer +#### Initializer ```typescript -import { JobStrategy } from 'cdk-pipelines-github' +import { JobStrategy } from '@nextdoor/cdk-pipelines-github' const jobStrategy: JobStrategy = { ... } ``` @@ -3548,13 +3548,13 @@ const jobStrategy: JobStrategy = { ... } | **Name** | **Type** | **Description** | | --- | --- | --- | -| failFast | boolean | When set to true, GitHub cancels all in-progress jobs if any matrix job fails. | -| matrix | JobMatrix | You can define a matrix of different job configurations. | -| maxParallel | number | The maximum number of jobs that can run simultaneously when using a matrix job strategy. | +| failFast | boolean | When set to true, GitHub cancels all in-progress jobs if any matrix job fails. | +| matrix | JobMatrix | You can define a matrix of different job configurations. | +| maxParallel | number | The maximum number of jobs that can run simultaneously when using a matrix job strategy. | --- -##### `failFast`Optional +##### `failFast`Optional ```typescript public readonly failFast: boolean; @@ -3568,13 +3568,13 @@ Default: true --- -##### `matrix`Optional +##### `matrix`Optional ```typescript public readonly matrix: JobMatrix; ``` -- *Type:* JobMatrix +- *Type:* JobMatrix You can define a matrix of different job configurations. @@ -3590,7 +3590,7 @@ limit also applies to self-hosted runners. --- -##### `maxParallel`Optional +##### `maxParallel`Optional ```typescript public readonly maxParallel: number; @@ -3606,14 +3606,14 @@ virtual machines. --- -### LabelOptions +### LabelOptions label options. -#### Initializer +#### Initializer ```typescript -import { LabelOptions } from 'cdk-pipelines-github' +import { LabelOptions } from '@nextdoor/cdk-pipelines-github' const labelOptions: LabelOptions = { ... } ``` @@ -3622,11 +3622,11 @@ const labelOptions: LabelOptions = { ... } | **Name** | **Type** | **Description** | | --- | --- | --- | -| types | string[] | Which activity types to trigger on. | +| types | string[] | Which activity types to trigger on. | --- -##### `types`Optional +##### `types`Optional ```typescript public readonly types: string[]; @@ -3638,14 +3638,14 @@ Which activity types to trigger on. --- -### MilestoneOptions +### MilestoneOptions Milestone options. -#### Initializer +#### Initializer ```typescript -import { MilestoneOptions } from 'cdk-pipelines-github' +import { MilestoneOptions } from '@nextdoor/cdk-pipelines-github' const milestoneOptions: MilestoneOptions = { ... } ``` @@ -3654,11 +3654,11 @@ const milestoneOptions: MilestoneOptions = { ... } | **Name** | **Type** | **Description** | | --- | --- | --- | -| types | string[] | Which activity types to trigger on. | +| types | string[] | Which activity types to trigger on. | --- -##### `types`Optional +##### `types`Optional ```typescript public readonly types: string[]; @@ -3670,14 +3670,14 @@ Which activity types to trigger on. --- -### OpenIdConnectProviderProps +### OpenIdConnectProviderProps Role to assume using OpenId Connect. -#### Initializer +#### Initializer ```typescript -import { OpenIdConnectProviderProps } from 'cdk-pipelines-github' +import { OpenIdConnectProviderProps } from '@nextdoor/cdk-pipelines-github' const openIdConnectProviderProps: OpenIdConnectProviderProps = { ... } ``` @@ -3686,12 +3686,12 @@ const openIdConnectProviderProps: OpenIdConnectProviderProps = { ... } | **Name** | **Type** | **Description** | | --- | --- | --- | -| gitHubActionRoleArn | string | A role that utilizes the GitHub OIDC Identity Provider in your AWS account. | -| roleSessionName | string | The role session name to use when assuming the role. | +| gitHubActionRoleArn | string | A role that utilizes the GitHub OIDC Identity Provider in your AWS account. | +| roleSessionName | string | The role session name to use when assuming the role. | --- -##### `gitHubActionRoleArn`Required +##### `gitHubActionRoleArn`Required ```typescript public readonly gitHubActionRoleArn: string; @@ -3707,7 +3707,7 @@ you can utilize the `GitHubActionRole` construct to create a role for you. --- -##### `roleSessionName`Optional +##### `roleSessionName`Optional ```typescript public readonly roleSessionName: string; @@ -3720,27 +3720,27 @@ The role session name to use when assuming the role. --- -### PageBuildOptions +### PageBuildOptions The Page build event accepts no options. -#### Initializer +#### Initializer ```typescript -import { PageBuildOptions } from 'cdk-pipelines-github' +import { PageBuildOptions } from '@nextdoor/cdk-pipelines-github' const pageBuildOptions: PageBuildOptions = { ... } ``` -### ProjectCardOptions +### ProjectCardOptions Project card options. -#### Initializer +#### Initializer ```typescript -import { ProjectCardOptions } from 'cdk-pipelines-github' +import { ProjectCardOptions } from '@nextdoor/cdk-pipelines-github' const projectCardOptions: ProjectCardOptions = { ... } ``` @@ -3749,11 +3749,11 @@ const projectCardOptions: ProjectCardOptions = { ... } | **Name** | **Type** | **Description** | | --- | --- | --- | -| types | string[] | Which activity types to trigger on. | +| types | string[] | Which activity types to trigger on. | --- -##### `types`Optional +##### `types`Optional ```typescript public readonly types: string[]; @@ -3765,14 +3765,14 @@ Which activity types to trigger on. --- -### ProjectColumnOptions +### ProjectColumnOptions Probject column options. -#### Initializer +#### Initializer ```typescript -import { ProjectColumnOptions } from 'cdk-pipelines-github' +import { ProjectColumnOptions } from '@nextdoor/cdk-pipelines-github' const projectColumnOptions: ProjectColumnOptions = { ... } ``` @@ -3781,11 +3781,11 @@ const projectColumnOptions: ProjectColumnOptions = { ... } | **Name** | **Type** | **Description** | | --- | --- | --- | -| types | string[] | Which activity types to trigger on. | +| types | string[] | Which activity types to trigger on. | --- -##### `types`Optional +##### `types`Optional ```typescript public readonly types: string[]; @@ -3797,14 +3797,14 @@ Which activity types to trigger on. --- -### ProjectOptions +### ProjectOptions Project options. -#### Initializer +#### Initializer ```typescript -import { ProjectOptions } from 'cdk-pipelines-github' +import { ProjectOptions } from '@nextdoor/cdk-pipelines-github' const projectOptions: ProjectOptions = { ... } ``` @@ -3813,11 +3813,11 @@ const projectOptions: ProjectOptions = { ... } | **Name** | **Type** | **Description** | | --- | --- | --- | -| types | string[] | Which activity types to trigger on. | +| types | string[] | Which activity types to trigger on. | --- -##### `types`Optional +##### `types`Optional ```typescript public readonly types: string[]; @@ -3829,27 +3829,27 @@ Which activity types to trigger on. --- -### PublicOptions +### PublicOptions The Public event accepts no options. -#### Initializer +#### Initializer ```typescript -import { PublicOptions } from 'cdk-pipelines-github' +import { PublicOptions } from '@nextdoor/cdk-pipelines-github' const publicOptions: PublicOptions = { ... } ``` -### PullRequestOptions +### PullRequestOptions Pull request options. -#### Initializer +#### Initializer ```typescript -import { PullRequestOptions } from 'cdk-pipelines-github' +import { PullRequestOptions } from '@nextdoor/cdk-pipelines-github' const pullRequestOptions: PullRequestOptions = { ... } ``` @@ -3858,11 +3858,11 @@ const pullRequestOptions: PullRequestOptions = { ... } | **Name** | **Type** | **Description** | | --- | --- | --- | -| types | string[] | Which activity types to trigger on. | +| types | string[] | Which activity types to trigger on. | --- -##### `types`Optional +##### `types`Optional ```typescript public readonly types: string[]; @@ -3874,14 +3874,14 @@ Which activity types to trigger on. --- -### PullRequestReviewCommentOptions +### PullRequestReviewCommentOptions Pull request review comment options. -#### Initializer +#### Initializer ```typescript -import { PullRequestReviewCommentOptions } from 'cdk-pipelines-github' +import { PullRequestReviewCommentOptions } from '@nextdoor/cdk-pipelines-github' const pullRequestReviewCommentOptions: PullRequestReviewCommentOptions = { ... } ``` @@ -3890,11 +3890,11 @@ const pullRequestReviewCommentOptions: PullRequestReviewCommentOptions = { ... } | **Name** | **Type** | **Description** | | --- | --- | --- | -| types | string[] | Which activity types to trigger on. | +| types | string[] | Which activity types to trigger on. | --- -##### `types`Optional +##### `types`Optional ```typescript public readonly types: string[]; @@ -3906,14 +3906,14 @@ Which activity types to trigger on. --- -### PullRequestReviewOptions +### PullRequestReviewOptions Pull request review options. -#### Initializer +#### Initializer ```typescript -import { PullRequestReviewOptions } from 'cdk-pipelines-github' +import { PullRequestReviewOptions } from '@nextdoor/cdk-pipelines-github' const pullRequestReviewOptions: PullRequestReviewOptions = { ... } ``` @@ -3922,11 +3922,11 @@ const pullRequestReviewOptions: PullRequestReviewOptions = { ... } | **Name** | **Type** | **Description** | | --- | --- | --- | -| types | string[] | Which activity types to trigger on. | +| types | string[] | Which activity types to trigger on. | --- -##### `types`Optional +##### `types`Optional ```typescript public readonly types: string[]; @@ -3938,14 +3938,14 @@ Which activity types to trigger on. --- -### PullRequestTargetOptions +### PullRequestTargetOptions Pull request target options. -#### Initializer +#### Initializer ```typescript -import { PullRequestTargetOptions } from 'cdk-pipelines-github' +import { PullRequestTargetOptions } from '@nextdoor/cdk-pipelines-github' const pullRequestTargetOptions: PullRequestTargetOptions = { ... } ``` @@ -3954,14 +3954,14 @@ const pullRequestTargetOptions: PullRequestTargetOptions = { ... } | **Name** | **Type** | **Description** | | --- | --- | --- | -| branches | string[] | When using the push and pull_request events, you can configure a workflow to run on specific branches or tags. | -| paths | string[] | When using the push and pull_request events, you can configure a workflow to run when at least one file does not match paths-ignore or at least one modified file matches the configured paths. | -| tags | string[] | When using the push and pull_request events, you can configure a workflow to run on specific branches or tags. | -| types | string[] | Which activity types to trigger on. | +| branches | string[] | When using the push and pull_request events, you can configure a workflow to run on specific branches or tags. | +| paths | string[] | When using the push and pull_request events, you can configure a workflow to run when at least one file does not match paths-ignore or at least one modified file matches the configured paths. | +| tags | string[] | When using the push and pull_request events, you can configure a workflow to run on specific branches or tags. | +| types | string[] | Which activity types to trigger on. | --- -##### `branches`Optional +##### `branches`Optional ```typescript public readonly branches: string[]; @@ -3980,7 +3980,7 @@ Git ref. --- -##### `paths`Optional +##### `paths`Optional ```typescript public readonly paths: string[]; @@ -3997,7 +3997,7 @@ evaluated for pushes to tags. --- -##### `tags`Optional +##### `tags`Optional ```typescript public readonly tags: string[]; @@ -4016,7 +4016,7 @@ Git ref. --- -##### `types`Optional +##### `types`Optional ```typescript public readonly types: string[]; @@ -4028,14 +4028,14 @@ Which activity types to trigger on. --- -### PushOptions +### PushOptions Options for push-like events. -#### Initializer +#### Initializer ```typescript -import { PushOptions } from 'cdk-pipelines-github' +import { PushOptions } from '@nextdoor/cdk-pipelines-github' const pushOptions: PushOptions = { ... } ``` @@ -4044,13 +4044,13 @@ const pushOptions: PushOptions = { ... } | **Name** | **Type** | **Description** | | --- | --- | --- | -| branches | string[] | When using the push and pull_request events, you can configure a workflow to run on specific branches or tags. | -| paths | string[] | When using the push and pull_request events, you can configure a workflow to run when at least one file does not match paths-ignore or at least one modified file matches the configured paths. | -| tags | string[] | When using the push and pull_request events, you can configure a workflow to run on specific branches or tags. | +| branches | string[] | When using the push and pull_request events, you can configure a workflow to run on specific branches or tags. | +| paths | string[] | When using the push and pull_request events, you can configure a workflow to run when at least one file does not match paths-ignore or at least one modified file matches the configured paths. | +| tags | string[] | When using the push and pull_request events, you can configure a workflow to run on specific branches or tags. | --- -##### `branches`Optional +##### `branches`Optional ```typescript public readonly branches: string[]; @@ -4069,7 +4069,7 @@ Git ref. --- -##### `paths`Optional +##### `paths`Optional ```typescript public readonly paths: string[]; @@ -4086,7 +4086,7 @@ evaluated for pushes to tags. --- -##### `tags`Optional +##### `tags`Optional ```typescript public readonly tags: string[]; @@ -4105,14 +4105,14 @@ Git ref. --- -### RegistryPackageOptions +### RegistryPackageOptions Registry package options. -#### Initializer +#### Initializer ```typescript -import { RegistryPackageOptions } from 'cdk-pipelines-github' +import { RegistryPackageOptions } from '@nextdoor/cdk-pipelines-github' const registryPackageOptions: RegistryPackageOptions = { ... } ``` @@ -4121,11 +4121,11 @@ const registryPackageOptions: RegistryPackageOptions = { ... } | **Name** | **Type** | **Description** | | --- | --- | --- | -| types | string[] | Which activity types to trigger on. | +| types | string[] | Which activity types to trigger on. | --- -##### `types`Optional +##### `types`Optional ```typescript public readonly types: string[]; @@ -4137,14 +4137,14 @@ Which activity types to trigger on. --- -### ReleaseOptions +### ReleaseOptions Release options. -#### Initializer +#### Initializer ```typescript -import { ReleaseOptions } from 'cdk-pipelines-github' +import { ReleaseOptions } from '@nextdoor/cdk-pipelines-github' const releaseOptions: ReleaseOptions = { ... } ``` @@ -4153,11 +4153,11 @@ const releaseOptions: ReleaseOptions = { ... } | **Name** | **Type** | **Description** | | --- | --- | --- | -| types | string[] | Which activity types to trigger on. | +| types | string[] | Which activity types to trigger on. | --- -##### `types`Optional +##### `types`Optional ```typescript public readonly types: string[]; @@ -4169,14 +4169,14 @@ Which activity types to trigger on. --- -### RepositoryDispatchOptions +### RepositoryDispatchOptions Repository dispatch options. -#### Initializer +#### Initializer ```typescript -import { RepositoryDispatchOptions } from 'cdk-pipelines-github' +import { RepositoryDispatchOptions } from '@nextdoor/cdk-pipelines-github' const repositoryDispatchOptions: RepositoryDispatchOptions = { ... } ``` @@ -4185,11 +4185,11 @@ const repositoryDispatchOptions: RepositoryDispatchOptions = { ... } | **Name** | **Type** | **Description** | | --- | --- | --- | -| types | string[] | Which activity types to trigger on. | +| types | string[] | Which activity types to trigger on. | --- -##### `types`Optional +##### `types`Optional ```typescript public readonly types: string[]; @@ -4201,14 +4201,14 @@ Which activity types to trigger on. --- -### RunSettings +### RunSettings Run settings for a job. -#### Initializer +#### Initializer ```typescript -import { RunSettings } from 'cdk-pipelines-github' +import { RunSettings } from '@nextdoor/cdk-pipelines-github' const runSettings: RunSettings = { ... } ``` @@ -4217,12 +4217,12 @@ const runSettings: RunSettings = { ... } | **Name** | **Type** | **Description** | | --- | --- | --- | -| shell | string | Which shell to use for running the step. | -| workingDirectory | string | Working directory to use when running the step. | +| shell | string | Which shell to use for running the step. | +| workingDirectory | string | Working directory to use when running the step. | --- -##### `shell`Optional +##### `shell`Optional ```typescript public readonly shell: string; @@ -4241,7 +4241,7 @@ Which shell to use for running the step. ``` -##### `workingDirectory`Optional +##### `workingDirectory`Optional ```typescript public readonly workingDirectory: string; @@ -4253,27 +4253,27 @@ Working directory to use when running the step. --- -### StatusOptions +### StatusOptions The Status event accepts no options. -#### Initializer +#### Initializer ```typescript -import { StatusOptions } from 'cdk-pipelines-github' +import { StatusOptions } from '@nextdoor/cdk-pipelines-github' const statusOptions: StatusOptions = { ... } ``` -### WatchOptions +### WatchOptions Watch options. -#### Initializer +#### Initializer ```typescript -import { WatchOptions } from 'cdk-pipelines-github' +import { WatchOptions } from '@nextdoor/cdk-pipelines-github' const watchOptions: WatchOptions = { ... } ``` @@ -4282,11 +4282,11 @@ const watchOptions: WatchOptions = { ... } | **Name** | **Type** | **Description** | | --- | --- | --- | -| types | string[] | Which activity types to trigger on. | +| types | string[] | Which activity types to trigger on. | --- -##### `types`Optional +##### `types`Optional ```typescript public readonly types: string[]; @@ -4298,27 +4298,27 @@ Which activity types to trigger on. --- -### WorkflowDispatchOptions +### WorkflowDispatchOptions The Workflow dispatch event accepts no options. -#### Initializer +#### Initializer ```typescript -import { WorkflowDispatchOptions } from 'cdk-pipelines-github' +import { WorkflowDispatchOptions } from '@nextdoor/cdk-pipelines-github' const workflowDispatchOptions: WorkflowDispatchOptions = { ... } ``` -### WorkflowRunOptions +### WorkflowRunOptions Workflow run options. -#### Initializer +#### Initializer ```typescript -import { WorkflowRunOptions } from 'cdk-pipelines-github' +import { WorkflowRunOptions } from '@nextdoor/cdk-pipelines-github' const workflowRunOptions: WorkflowRunOptions = { ... } ``` @@ -4327,11 +4327,11 @@ const workflowRunOptions: WorkflowRunOptions = { ... } | **Name** | **Type** | **Description** | | --- | --- | --- | -| types | string[] | Which activity types to trigger on. | +| types | string[] | Which activity types to trigger on. | --- -##### `types`Optional +##### `types`Optional ```typescript public readonly types: string[]; @@ -4343,16 +4343,16 @@ Which activity types to trigger on. --- -### WorkflowTriggers +### WorkflowTriggers The set of available triggers for GitHub Workflows. > [https://docs.github.com/en/actions/reference/events-that-trigger-workflows](https://docs.github.com/en/actions/reference/events-that-trigger-workflows) -#### Initializer +#### Initializer ```typescript -import { WorkflowTriggers } from 'cdk-pipelines-github' +import { WorkflowTriggers } from '@nextdoor/cdk-pipelines-github' const workflowTriggers: WorkflowTriggers = { ... } ``` @@ -4361,94 +4361,94 @@ const workflowTriggers: WorkflowTriggers = { ... } | **Name** | **Type** | **Description** | | --- | --- | --- | -| checkRun | CheckRunOptions | Runs your workflow anytime the check_run event occurs. | -| checkSuite | CheckSuiteOptions | Runs your workflow anytime the check_suite event occurs. | -| create | CreateOptions | Runs your workflow anytime someone creates a branch or tag, which triggers the create event. | -| delete | DeleteOptions | Runs your workflow anytime someone deletes a branch or tag, which triggers the delete event. | -| deployment | DeploymentOptions | Runs your workflow anytime someone creates a deployment, which triggers the deployment event. | -| deploymentStatus | DeploymentStatusOptions | Runs your workflow anytime a third party provides a deployment status, which triggers the deployment_status event. | -| fork | ForkOptions | Runs your workflow anytime when someone forks a repository, which triggers the fork event. | -| gollum | GollumOptions | Runs your workflow when someone creates or updates a Wiki page, which triggers the gollum event. | -| issueComment | IssueCommentOptions | Runs your workflow anytime the issue_comment event occurs. | -| issues | IssuesOptions | Runs your workflow anytime the issues event occurs. | -| label | LabelOptions | Runs your workflow anytime the label event occurs. | -| milestone | MilestoneOptions | Runs your workflow anytime the milestone event occurs. | -| pageBuild | PageBuildOptions | Runs your workflow anytime someone pushes to a GitHub Pages-enabled branch, which triggers the page_build event. | -| project | ProjectOptions | Runs your workflow anytime the project event occurs. | -| projectCard | ProjectCardOptions | Runs your workflow anytime the project_card event occurs. | -| projectColumn | ProjectColumnOptions | Runs your workflow anytime the project_column event occurs. | -| public | PublicOptions | Runs your workflow anytime someone makes a private repository public, which triggers the public event. | -| pullRequest | PullRequestOptions | Runs your workflow anytime the pull_request event occurs. | -| pullRequestReview | PullRequestReviewOptions | Runs your workflow anytime the pull_request_review event occurs. | -| pullRequestReviewComment | PullRequestReviewCommentOptions | Runs your workflow anytime a comment on a pull request's unified diff is modified, which triggers the pull_request_review_comment event. | -| pullRequestTarget | PullRequestTargetOptions | This event runs in the context of the base of the pull request, rather than in the merge commit as the pull_request event does. | -| push | PushOptions | Runs your workflow when someone pushes to a repository branch, which triggers the push event. | -| registryPackage | RegistryPackageOptions | Runs your workflow anytime a package is published or updated. | -| release | ReleaseOptions | Runs your workflow anytime the release event occurs. | -| repositoryDispatch | RepositoryDispatchOptions | You can use the GitHub API to trigger a webhook event called repository_dispatch when you want to trigger a workflow for activity that happens outside of GitHub. | -| schedule | CronScheduleOptions[] | You can schedule a workflow to run at specific UTC times using POSIX cron syntax. | -| status | StatusOptions | Runs your workflow anytime the status of a Git commit changes, which triggers the status event. | -| watch | WatchOptions | Runs your workflow anytime the watch event occurs. | -| workflowDispatch | WorkflowDispatchOptions | You can configure custom-defined input properties, default input values, and required inputs for the event directly in your workflow. | -| workflowRun | WorkflowRunOptions | This event occurs when a workflow run is requested or completed, and allows you to execute a workflow based on the finished result of another workflow. | - ---- - -##### `checkRun`Optional +| checkRun | CheckRunOptions | Runs your workflow anytime the check_run event occurs. | +| checkSuite | CheckSuiteOptions | Runs your workflow anytime the check_suite event occurs. | +| create | CreateOptions | Runs your workflow anytime someone creates a branch or tag, which triggers the create event. | +| delete | DeleteOptions | Runs your workflow anytime someone deletes a branch or tag, which triggers the delete event. | +| deployment | DeploymentOptions | Runs your workflow anytime someone creates a deployment, which triggers the deployment event. | +| deploymentStatus | DeploymentStatusOptions | Runs your workflow anytime a third party provides a deployment status, which triggers the deployment_status event. | +| fork | ForkOptions | Runs your workflow anytime when someone forks a repository, which triggers the fork event. | +| gollum | GollumOptions | Runs your workflow when someone creates or updates a Wiki page, which triggers the gollum event. | +| issueComment | IssueCommentOptions | Runs your workflow anytime the issue_comment event occurs. | +| issues | IssuesOptions | Runs your workflow anytime the issues event occurs. | +| label | LabelOptions | Runs your workflow anytime the label event occurs. | +| milestone | MilestoneOptions | Runs your workflow anytime the milestone event occurs. | +| pageBuild | PageBuildOptions | Runs your workflow anytime someone pushes to a GitHub Pages-enabled branch, which triggers the page_build event. | +| project | ProjectOptions | Runs your workflow anytime the project event occurs. | +| projectCard | ProjectCardOptions | Runs your workflow anytime the project_card event occurs. | +| projectColumn | ProjectColumnOptions | Runs your workflow anytime the project_column event occurs. | +| public | PublicOptions | Runs your workflow anytime someone makes a private repository public, which triggers the public event. | +| pullRequest | PullRequestOptions | Runs your workflow anytime the pull_request event occurs. | +| pullRequestReview | PullRequestReviewOptions | Runs your workflow anytime the pull_request_review event occurs. | +| pullRequestReviewComment | PullRequestReviewCommentOptions | Runs your workflow anytime a comment on a pull request's unified diff is modified, which triggers the pull_request_review_comment event. | +| pullRequestTarget | PullRequestTargetOptions | This event runs in the context of the base of the pull request, rather than in the merge commit as the pull_request event does. | +| push | PushOptions | Runs your workflow when someone pushes to a repository branch, which triggers the push event. | +| registryPackage | RegistryPackageOptions | Runs your workflow anytime a package is published or updated. | +| release | ReleaseOptions | Runs your workflow anytime the release event occurs. | +| repositoryDispatch | RepositoryDispatchOptions | You can use the GitHub API to trigger a webhook event called repository_dispatch when you want to trigger a workflow for activity that happens outside of GitHub. | +| schedule | CronScheduleOptions[] | You can schedule a workflow to run at specific UTC times using POSIX cron syntax. | +| status | StatusOptions | Runs your workflow anytime the status of a Git commit changes, which triggers the status event. | +| watch | WatchOptions | Runs your workflow anytime the watch event occurs. | +| workflowDispatch | WorkflowDispatchOptions | You can configure custom-defined input properties, default input values, and required inputs for the event directly in your workflow. | +| workflowRun | WorkflowRunOptions | This event occurs when a workflow run is requested or completed, and allows you to execute a workflow based on the finished result of another workflow. | + +--- + +##### `checkRun`Optional ```typescript public readonly checkRun: CheckRunOptions; ``` -- *Type:* CheckRunOptions +- *Type:* CheckRunOptions Runs your workflow anytime the check_run event occurs. --- -##### `checkSuite`Optional +##### `checkSuite`Optional ```typescript public readonly checkSuite: CheckSuiteOptions; ``` -- *Type:* CheckSuiteOptions +- *Type:* CheckSuiteOptions Runs your workflow anytime the check_suite event occurs. --- -##### `create`Optional +##### `create`Optional ```typescript public readonly create: CreateOptions; ``` -- *Type:* CreateOptions +- *Type:* CreateOptions Runs your workflow anytime someone creates a branch or tag, which triggers the create event. --- -##### `delete`Optional +##### `delete`Optional ```typescript public readonly delete: DeleteOptions; ``` -- *Type:* DeleteOptions +- *Type:* DeleteOptions Runs your workflow anytime someone deletes a branch or tag, which triggers the delete event. --- -##### `deployment`Optional +##### `deployment`Optional ```typescript public readonly deployment: DeploymentOptions; ``` -- *Type:* DeploymentOptions +- *Type:* DeploymentOptions Runs your workflow anytime someone creates a deployment, which triggers the deployment event. @@ -4457,13 +4457,13 @@ a Git ref. --- -##### `deploymentStatus`Optional +##### `deploymentStatus`Optional ```typescript public readonly deploymentStatus: DeploymentStatusOptions; ``` -- *Type:* DeploymentStatusOptions +- *Type:* DeploymentStatusOptions Runs your workflow anytime a third party provides a deployment status, which triggers the deployment_status event. @@ -4472,181 +4472,181 @@ commit SHA may not have a Git ref. --- -##### `fork`Optional +##### `fork`Optional ```typescript public readonly fork: ForkOptions; ``` -- *Type:* ForkOptions +- *Type:* ForkOptions Runs your workflow anytime when someone forks a repository, which triggers the fork event. --- -##### `gollum`Optional +##### `gollum`Optional ```typescript public readonly gollum: GollumOptions; ``` -- *Type:* GollumOptions +- *Type:* GollumOptions Runs your workflow when someone creates or updates a Wiki page, which triggers the gollum event. --- -##### `issueComment`Optional +##### `issueComment`Optional ```typescript public readonly issueComment: IssueCommentOptions; ``` -- *Type:* IssueCommentOptions +- *Type:* IssueCommentOptions Runs your workflow anytime the issue_comment event occurs. --- -##### `issues`Optional +##### `issues`Optional ```typescript public readonly issues: IssuesOptions; ``` -- *Type:* IssuesOptions +- *Type:* IssuesOptions Runs your workflow anytime the issues event occurs. --- -##### `label`Optional +##### `label`Optional ```typescript public readonly label: LabelOptions; ``` -- *Type:* LabelOptions +- *Type:* LabelOptions Runs your workflow anytime the label event occurs. --- -##### `milestone`Optional +##### `milestone`Optional ```typescript public readonly milestone: MilestoneOptions; ``` -- *Type:* MilestoneOptions +- *Type:* MilestoneOptions Runs your workflow anytime the milestone event occurs. --- -##### `pageBuild`Optional +##### `pageBuild`Optional ```typescript public readonly pageBuild: PageBuildOptions; ``` -- *Type:* PageBuildOptions +- *Type:* PageBuildOptions Runs your workflow anytime someone pushes to a GitHub Pages-enabled branch, which triggers the page_build event. --- -##### `project`Optional +##### `project`Optional ```typescript public readonly project: ProjectOptions; ``` -- *Type:* ProjectOptions +- *Type:* ProjectOptions Runs your workflow anytime the project event occurs. --- -##### `projectCard`Optional +##### `projectCard`Optional ```typescript public readonly projectCard: ProjectCardOptions; ``` -- *Type:* ProjectCardOptions +- *Type:* ProjectCardOptions Runs your workflow anytime the project_card event occurs. --- -##### `projectColumn`Optional +##### `projectColumn`Optional ```typescript public readonly projectColumn: ProjectColumnOptions; ``` -- *Type:* ProjectColumnOptions +- *Type:* ProjectColumnOptions Runs your workflow anytime the project_column event occurs. --- -##### `public`Optional +##### `public`Optional ```typescript public readonly public: PublicOptions; ``` -- *Type:* PublicOptions +- *Type:* PublicOptions Runs your workflow anytime someone makes a private repository public, which triggers the public event. --- -##### `pullRequest`Optional +##### `pullRequest`Optional ```typescript public readonly pullRequest: PullRequestOptions; ``` -- *Type:* PullRequestOptions +- *Type:* PullRequestOptions Runs your workflow anytime the pull_request event occurs. --- -##### `pullRequestReview`Optional +##### `pullRequestReview`Optional ```typescript public readonly pullRequestReview: PullRequestReviewOptions; ``` -- *Type:* PullRequestReviewOptions +- *Type:* PullRequestReviewOptions Runs your workflow anytime the pull_request_review event occurs. --- -##### `pullRequestReviewComment`Optional +##### `pullRequestReviewComment`Optional ```typescript public readonly pullRequestReviewComment: PullRequestReviewCommentOptions; ``` -- *Type:* PullRequestReviewCommentOptions +- *Type:* PullRequestReviewCommentOptions Runs your workflow anytime a comment on a pull request's unified diff is modified, which triggers the pull_request_review_comment event. --- -##### `pullRequestTarget`Optional +##### `pullRequestTarget`Optional ```typescript public readonly pullRequestTarget: PullRequestTargetOptions; ``` -- *Type:* PullRequestTargetOptions +- *Type:* PullRequestTargetOptions This event runs in the context of the base of the pull request, rather than in the merge commit as the pull_request event does. @@ -4669,61 +4669,61 @@ the cache contents were altered. --- -##### `push`Optional +##### `push`Optional ```typescript public readonly push: PushOptions; ``` -- *Type:* PushOptions +- *Type:* PushOptions Runs your workflow when someone pushes to a repository branch, which triggers the push event. --- -##### `registryPackage`Optional +##### `registryPackage`Optional ```typescript public readonly registryPackage: RegistryPackageOptions; ``` -- *Type:* RegistryPackageOptions +- *Type:* RegistryPackageOptions Runs your workflow anytime a package is published or updated. --- -##### `release`Optional +##### `release`Optional ```typescript public readonly release: ReleaseOptions; ``` -- *Type:* ReleaseOptions +- *Type:* ReleaseOptions Runs your workflow anytime the release event occurs. --- -##### `repositoryDispatch`Optional +##### `repositoryDispatch`Optional ```typescript public readonly repositoryDispatch: RepositoryDispatchOptions; ``` -- *Type:* RepositoryDispatchOptions +- *Type:* RepositoryDispatchOptions You can use the GitHub API to trigger a webhook event called repository_dispatch when you want to trigger a workflow for activity that happens outside of GitHub. --- -##### `schedule`Optional +##### `schedule`Optional ```typescript public readonly schedule: CronScheduleOptions[]; ``` -- *Type:* CronScheduleOptions[] +- *Type:* CronScheduleOptions[] You can schedule a workflow to run at specific UTC times using POSIX cron syntax. @@ -4735,37 +4735,37 @@ once every 5 minutes. --- -##### `status`Optional +##### `status`Optional ```typescript public readonly status: StatusOptions; ``` -- *Type:* StatusOptions +- *Type:* StatusOptions Runs your workflow anytime the status of a Git commit changes, which triggers the status event. --- -##### `watch`Optional +##### `watch`Optional ```typescript public readonly watch: WatchOptions; ``` -- *Type:* WatchOptions +- *Type:* WatchOptions Runs your workflow anytime the watch event occurs. --- -##### `workflowDispatch`Optional +##### `workflowDispatch`Optional ```typescript public readonly workflowDispatch: WorkflowDispatchOptions; ``` -- *Type:* WorkflowDispatchOptions +- *Type:* WorkflowDispatchOptions You can configure custom-defined input properties, default input values, and required inputs for the event directly in your workflow. @@ -4775,13 +4775,13 @@ context. --- -##### `workflowRun`Optional +##### `workflowRun`Optional ```typescript public readonly workflowRun: WorkflowRunOptions; ``` -- *Type:* WorkflowRunOptions +- *Type:* WorkflowRunOptions This event occurs when a workflow run is requested or completed, and allows you to execute a workflow based on the finished result of another workflow. @@ -4790,14 +4790,14 @@ previous workflow. --- -### YamlFileOptions +### YamlFileOptions Options for `YamlFile`. -#### Initializer +#### Initializer ```typescript -import { YamlFileOptions } from 'cdk-pipelines-github' +import { YamlFileOptions } from '@nextdoor/cdk-pipelines-github' const yamlFileOptions: YamlFileOptions = { ... } ``` @@ -4806,11 +4806,11 @@ const yamlFileOptions: YamlFileOptions = { ... } | **Name** | **Type** | **Description** | | --- | --- | --- | -| obj | any | The object that will be serialized. | +| obj | any | The object that will be serialized. | --- -##### `obj`Optional +##### `obj`Optional ```typescript public readonly obj: any; @@ -4828,14 +4828,14 @@ before synthesis. ## Classes -### AwsCredentials +### AwsCredentials Provides AWS credenitals to the pipeline jobs. -#### Initializers +#### Initializers ```typescript -import { AwsCredentials } from 'cdk-pipelines-github' +import { AwsCredentials } from '@nextdoor/cdk-pipelines-github' new AwsCredentials() ``` @@ -4850,16 +4850,16 @@ new AwsCredentials() | **Name** | **Description** | | --- | --- | -| fromGitHubSecrets | Reference credential secrets to authenticate with AWS. | -| fromOpenIdConnect | Provide AWS credentials using OpenID Connect. | -| runnerHasPreconfiguredCreds | Don't provide any AWS credentials, use this if runners have preconfigured credentials. | +| fromGitHubSecrets | Reference credential secrets to authenticate with AWS. | +| fromOpenIdConnect | Provide AWS credentials using OpenID Connect. | +| runnerHasPreconfiguredCreds | Don't provide any AWS credentials, use this if runners have preconfigured credentials. | --- -##### `fromGitHubSecrets` +##### `fromGitHubSecrets` ```typescript -import { AwsCredentials } from 'cdk-pipelines-github' +import { AwsCredentials } from '@nextdoor/cdk-pipelines-github' AwsCredentials.fromGitHubSecrets(props?: GitHubSecretsProviderProps) ``` @@ -4869,32 +4869,32 @@ Reference credential secrets to authenticate with AWS. This method assumes that your credentials will be stored as long-lived GitHub Secrets. -###### `props`Optional +###### `props`Optional -- *Type:* GitHubSecretsProviderProps +- *Type:* GitHubSecretsProviderProps --- -##### `fromOpenIdConnect` +##### `fromOpenIdConnect` ```typescript -import { AwsCredentials } from 'cdk-pipelines-github' +import { AwsCredentials } from '@nextdoor/cdk-pipelines-github' AwsCredentials.fromOpenIdConnect(props: OpenIdConnectProviderProps) ``` Provide AWS credentials using OpenID Connect. -###### `props`Required +###### `props`Required -- *Type:* OpenIdConnectProviderProps +- *Type:* OpenIdConnectProviderProps --- -##### `runnerHasPreconfiguredCreds` +##### `runnerHasPreconfiguredCreds` ```typescript -import { AwsCredentials } from 'cdk-pipelines-github' +import { AwsCredentials } from '@nextdoor/cdk-pipelines-github' AwsCredentials.runnerHasPreconfiguredCreds() ``` @@ -4903,14 +4903,14 @@ Don't provide any AWS credentials, use this if runners have preconfigured creden -### AwsCredentialsProvider +### AwsCredentialsProvider AWS credential provider. -#### Initializers +#### Initializers ```typescript -import { AwsCredentialsProvider } from 'cdk-pipelines-github' +import { AwsCredentialsProvider } from '@nextdoor/cdk-pipelines-github' new AwsCredentialsProvider() ``` @@ -4924,30 +4924,30 @@ new AwsCredentialsProvider() | **Name** | **Description** | | --- | --- | -| credentialSteps | *No description.* | -| jobPermission | *No description.* | +| credentialSteps | *No description.* | +| jobPermission | *No description.* | --- -##### `credentialSteps` +##### `credentialSteps` ```typescript public credentialSteps(region: string, assumeRoleArn?: string): JobStep[] ``` -###### `region`Required +###### `region`Required - *Type:* string --- -###### `assumeRoleArn`Optional +###### `assumeRoleArn`Optional - *Type:* string --- -##### `jobPermission` +##### `jobPermission` ```typescript public jobPermission(): JobPermission @@ -4956,7 +4956,7 @@ public jobPermission(): JobPermission -### DockerCredential +### DockerCredential Represents a credential used to authenticate to a docker registry. @@ -4969,16 +4969,16 @@ Uses the official Docker Login GitHub Action to authenticate. | **Name** | **Description** | | --- | --- | -| customRegistry | Create a credential for a custom registry. | -| dockerHub | Reference credential secrets to authenticate to DockerHub. | -| ecr | Create a credential for ECR. | +| customRegistry | Create a credential for a custom registry. | +| dockerHub | Reference credential secrets to authenticate to DockerHub. | +| ecr | Create a credential for ECR. | --- -##### `customRegistry` +##### `customRegistry` ```typescript -import { DockerCredential } from 'cdk-pipelines-github' +import { DockerCredential } from '@nextdoor/cdk-pipelines-github' DockerCredential.customRegistry(registry: string, creds: ExternalDockerCredentialSecrets) ``` @@ -4991,22 +4991,22 @@ registry you provide. > [https://github.com/marketplace/actions/docker-login](https://github.com/marketplace/actions/docker-login) -###### `registry`Required +###### `registry`Required - *Type:* string --- -###### `creds`Required +###### `creds`Required -- *Type:* ExternalDockerCredentialSecrets +- *Type:* ExternalDockerCredentialSecrets --- -##### `dockerHub` +##### `dockerHub` ```typescript -import { DockerCredential } from 'cdk-pipelines-github' +import { DockerCredential } from '@nextdoor/cdk-pipelines-github' DockerCredential.dockerHub(creds?: DockerHubCredentialSecrets) ``` @@ -5021,16 +5021,16 @@ The default for usernameKey is `DOCKERHUB_USERNAME`. The default for personalAcc is `DOCKERHUB_TOKEN`. If you do not set these values, your credentials should be found in your GitHub Secrets under these default keys. -###### `creds`Optional +###### `creds`Optional -- *Type:* DockerHubCredentialSecrets +- *Type:* DockerHubCredentialSecrets --- -##### `ecr` +##### `ecr` ```typescript -import { DockerCredential } from 'cdk-pipelines-github' +import { DockerCredential } from '@nextdoor/cdk-pipelines-github' DockerCredential.ecr(registry: string) ``` @@ -5047,7 +5047,7 @@ set of credentials (and DockerCredential). Attempting to associate one set of cr with one ECR repo and another with another ECR repo in the same account and region will result in failures when using these credentials in the pipeline. -###### `registry`Required +###### `registry`Required - *Type:* string @@ -5057,14 +5057,14 @@ result in failures when using these credentials in the pipeline. | **Name** | **Type** | **Description** | | --- | --- | --- | -| name | string | *No description.* | -| passwordKey | string | *No description.* | -| registry | string | *No description.* | -| usernameKey | string | *No description.* | +| name | string | *No description.* | +| passwordKey | string | *No description.* | +| registry | string | *No description.* | +| usernameKey | string | *No description.* | --- -##### `name`Required +##### `name`Required ```typescript public readonly name: string; @@ -5074,7 +5074,7 @@ public readonly name: string; --- -##### `passwordKey`Optional +##### `passwordKey`Optional ```typescript public readonly passwordKey: string; @@ -5084,7 +5084,7 @@ public readonly passwordKey: string; --- -##### `registry`Optional +##### `registry`Optional ```typescript public readonly registry: string; @@ -5094,7 +5094,7 @@ public readonly registry: string; --- -##### `usernameKey`Optional +##### `usernameKey`Optional ```typescript public readonly usernameKey: string; @@ -5105,34 +5105,34 @@ public readonly usernameKey: string; --- -### GitHubActionStep +### GitHubActionStep Specifies a GitHub Action as a step in the pipeline. -#### Initializers +#### Initializers ```typescript -import { GitHubActionStep } from 'cdk-pipelines-github' +import { GitHubActionStep } from '@nextdoor/cdk-pipelines-github' new GitHubActionStep(id: string, props: GitHubActionStepProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | -| id | string | *No description.* | -| props | GitHubActionStepProps | *No description.* | +| id | string | *No description.* | +| props | GitHubActionStepProps | *No description.* | --- -##### `id`Required +##### `id`Required - *Type:* string --- -##### `props`Required +##### `props`Required -- *Type:* GitHubActionStepProps +- *Type:* GitHubActionStepProps --- @@ -5140,12 +5140,12 @@ new GitHubActionStep(id: string, props: GitHubActionStepProps) | **Name** | **Description** | | --- | --- | -| addStepDependency | Add a dependency on another step. | -| toString | Return a string representation of this Step. | +| addStepDependency | Add a dependency on another step. | +| toString | Return a string representation of this Step. | --- -##### `addStepDependency` +##### `addStepDependency` ```typescript public addStepDependency(step: Step): void @@ -5153,13 +5153,13 @@ public addStepDependency(step: Step): void Add a dependency on another step. -###### `step`Required +###### `step`Required - *Type:* aws-cdk-lib.pipelines.Step --- -##### `toString` +##### `toString` ```typescript public toString(): string @@ -5171,21 +5171,21 @@ Return a string representation of this Step. | **Name** | **Description** | | --- | --- | -| sequence | Define a sequence of steps to be executed in order. | +| sequence | Define a sequence of steps to be executed in order. | --- -##### `sequence` +##### `sequence` ```typescript -import { GitHubActionStep } from 'cdk-pipelines-github' +import { GitHubActionStep } from '@nextdoor/cdk-pipelines-github' GitHubActionStep.sequence(steps: Step[]) ``` Define a sequence of steps to be executed in order. -###### `steps`Required +###### `steps`Required - *Type:* aws-cdk-lib.pipelines.Step[] @@ -5195,17 +5195,17 @@ Define a sequence of steps to be executed in order. | **Name** | **Type** | **Description** | | --- | --- | --- | -| dependencies | aws-cdk-lib.pipelines.Step[] | Return the steps this step depends on, based on the FileSets it requires. | -| dependencyFileSets | aws-cdk-lib.pipelines.FileSet[] | The list of FileSets consumed by this Step. | -| id | string | Identifier for this step. | -| isSource | boolean | Whether or not this is a Source step. | -| primaryOutput | aws-cdk-lib.pipelines.FileSet | The primary FileSet produced by this Step. | -| env | {[ key: string ]: string} | *No description.* | -| jobSteps | JobStep[] | *No description.* | +| dependencies | aws-cdk-lib.pipelines.Step[] | Return the steps this step depends on, based on the FileSets it requires. | +| dependencyFileSets | aws-cdk-lib.pipelines.FileSet[] | The list of FileSets consumed by this Step. | +| id | string | Identifier for this step. | +| isSource | boolean | Whether or not this is a Source step. | +| primaryOutput | aws-cdk-lib.pipelines.FileSet | The primary FileSet produced by this Step. | +| env | {[ key: string ]: string} | *No description.* | +| jobSteps | JobStep[] | *No description.* | --- -##### `dependencies`Required +##### `dependencies`Required ```typescript public readonly dependencies: Step[]; @@ -5217,7 +5217,7 @@ Return the steps this step depends on, based on the FileSets it requires. --- -##### `dependencyFileSets`Required +##### `dependencyFileSets`Required ```typescript public readonly dependencyFileSets: FileSet[]; @@ -5229,7 +5229,7 @@ The list of FileSets consumed by this Step. --- -##### `id`Required +##### `id`Required ```typescript public readonly id: string; @@ -5241,7 +5241,7 @@ Identifier for this step. --- -##### `isSource`Required +##### `isSource`Required ```typescript public readonly isSource: boolean; @@ -5255,7 +5255,7 @@ What it means to be a Source step depends on the engine. --- -##### `primaryOutput`Optional +##### `primaryOutput`Optional ```typescript public readonly primaryOutput: FileSet; @@ -5270,7 +5270,7 @@ you can substitute the `Step` object for the `FileSet` object. --- -##### `env`Required +##### `env`Required ```typescript public readonly env: {[ key: string ]: string}; @@ -5280,18 +5280,18 @@ public readonly env: {[ key: string ]: string}; --- -##### `jobSteps`Required +##### `jobSteps`Required ```typescript public readonly jobSteps: JobStep[]; ``` -- *Type:* JobStep[] +- *Type:* JobStep[] --- -### GitHubWave +### GitHubWave Multiple stages that are deployed in parallel. @@ -5300,23 +5300,23 @@ A `Wave`, but with addition GitHub options Create with `GitHubWorkflow.addWave()` or `GitHubWorkflow.addGitHubWave()`. You should not have to instantiate a GitHubWave yourself. -#### Initializers +#### Initializers ```typescript -import { GitHubWave } from 'cdk-pipelines-github' +import { GitHubWave } from '@nextdoor/cdk-pipelines-github' new GitHubWave(id: string, pipeline: GitHubWorkflow, props?: WaveProps) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | -| id | string | Identifier for this Wave. | -| pipeline | GitHubWorkflow | GitHubWorkflow that this wave is part of. | -| props | aws-cdk-lib.pipelines.WaveProps | *No description.* | +| id | string | Identifier for this Wave. | +| pipeline | GitHubWorkflow | GitHubWorkflow that this wave is part of. | +| props | aws-cdk-lib.pipelines.WaveProps | *No description.* | --- -##### `id`Required +##### `id`Required - *Type:* string @@ -5324,15 +5324,15 @@ Identifier for this Wave. --- -##### `pipeline`Required +##### `pipeline`Required -- *Type:* GitHubWorkflow +- *Type:* GitHubWorkflow GitHubWorkflow that this wave is part of. --- -##### `props`Optional +##### `props`Optional - *Type:* aws-cdk-lib.pipelines.WaveProps @@ -5342,14 +5342,14 @@ GitHubWorkflow that this wave is part of. | **Name** | **Description** | | --- | --- | -| addPost | Add an additional step to run after all of the stages in this wave. | -| addPre | Add an additional step to run before any of the stages in this wave. | -| addStage | Add a Stage to this wave. | -| addStageWithGitHubOptions | Add a Stage to this wave. | +| addPost | Add an additional step to run after all of the stages in this wave. | +| addPre | Add an additional step to run before any of the stages in this wave. | +| addStage | Add a Stage to this wave. | +| addStageWithGitHubOptions | Add a Stage to this wave. | --- -##### `addPost` +##### `addPost` ```typescript public addPost(steps: Step): void @@ -5357,13 +5357,13 @@ public addPost(steps: Step): void Add an additional step to run after all of the stages in this wave. -###### `steps`Required +###### `steps`Required - *Type:* aws-cdk-lib.pipelines.Step --- -##### `addPre` +##### `addPre` ```typescript public addPre(steps: Step): void @@ -5371,13 +5371,13 @@ public addPre(steps: Step): void Add an additional step to run before any of the stages in this wave. -###### `steps`Required +###### `steps`Required - *Type:* aws-cdk-lib.pipelines.Step --- -##### `addStage` +##### `addStage` ```typescript public addStage(stage: Stage, options?: AddStageOpts): StageDeployment @@ -5388,19 +5388,19 @@ Add a Stage to this wave. It will be deployed in parallel with all other stages in this wave. -###### `stage`Required +###### `stage`Required - *Type:* aws-cdk-lib.Stage --- -###### `options`Optional +###### `options`Optional - *Type:* aws-cdk-lib.pipelines.AddStageOpts --- -##### `addStageWithGitHubOptions` +##### `addStageWithGitHubOptions` ```typescript public addStageWithGitHubOptions(stage: Stage, options?: AddGitHubStageOptions): StageDeployment @@ -5411,15 +5411,15 @@ Add a Stage to this wave. It will be deployed in parallel with all other stages in this wave. -###### `stage`Required +###### `stage`Required - *Type:* aws-cdk-lib.Stage --- -###### `options`Optional +###### `options`Optional -- *Type:* AddGitHubStageOptions +- *Type:* AddGitHubStageOptions --- @@ -5428,14 +5428,14 @@ wave. | **Name** | **Type** | **Description** | | --- | --- | --- | -| id | string | Identifier for this Wave. | -| post | aws-cdk-lib.pipelines.Step[] | Additional steps that are run after all of the stages in the wave. | -| pre | aws-cdk-lib.pipelines.Step[] | Additional steps that are run before any of the stages in the wave. | -| stages | aws-cdk-lib.pipelines.StageDeployment[] | The stages that are deployed in this wave. | +| id | string | Identifier for this Wave. | +| post | aws-cdk-lib.pipelines.Step[] | Additional steps that are run after all of the stages in the wave. | +| pre | aws-cdk-lib.pipelines.Step[] | Additional steps that are run before any of the stages in the wave. | +| stages | aws-cdk-lib.pipelines.StageDeployment[] | The stages that are deployed in this wave. | --- -##### `id`Required +##### `id`Required ```typescript public readonly id: string; @@ -5447,7 +5447,7 @@ Identifier for this Wave. --- -##### `post`Required +##### `post`Required ```typescript public readonly post: Step[]; @@ -5459,7 +5459,7 @@ Additional steps that are run after all of the stages in the wave. --- -##### `pre`Required +##### `pre`Required ```typescript public readonly pre: Step[]; @@ -5471,7 +5471,7 @@ Additional steps that are run before any of the stages in the wave. --- -##### `stages`Required +##### `stages`Required ```typescript public readonly stages: StageDeployment[]; @@ -5484,7 +5484,7 @@ The stages that are deployed in this wave. --- -### JsonPatch +### JsonPatch Utility for applying RFC-6902 JSON-Patch to a document. @@ -5505,20 +5505,20 @@ const output = JsonPatch.apply(input, | **Name** | **Description** | | --- | --- | -| add | Adds a value to an object or inserts it into an array. | -| apply | Applies a set of JSON-Patch (RFC-6902) operations to `document` and returns the result. | -| copy | Copies a value from one location to another within the JSON document. | -| move | Moves a value from one location to the other. | -| remove | Removes a value from an object or array. | -| replace | Replaces a value. | -| test | Tests that the specified value is set in the document. | +| add | Adds a value to an object or inserts it into an array. | +| apply | Applies a set of JSON-Patch (RFC-6902) operations to `document` and returns the result. | +| copy | Copies a value from one location to another within the JSON document. | +| move | Moves a value from one location to the other. | +| remove | Removes a value from an object or array. | +| replace | Replaces a value. | +| test | Tests that the specified value is set in the document. | --- -##### `add` +##### `add` ```typescript -import { JsonPatch } from 'cdk-pipelines-github' +import { JsonPatch } from '@nextdoor/cdk-pipelines-github' JsonPatch.add(path: string, value: any) ``` @@ -5536,29 +5536,29 @@ JsonPatch.add('/biscuits/1', { "name": "Ginger Nut" }) ``` -###### `path`Required +###### `path`Required - *Type:* string --- -###### `value`Required +###### `value`Required - *Type:* any --- -##### `apply` +##### `apply` ```typescript -import { JsonPatch } from 'cdk-pipelines-github' +import { JsonPatch } from '@nextdoor/cdk-pipelines-github' JsonPatch.apply(document: any, ops: JsonPatch) ``` Applies a set of JSON-Patch (RFC-6902) operations to `document` and returns the result. -###### `document`Required +###### `document`Required - *Type:* any @@ -5566,18 +5566,18 @@ The document to patch. --- -###### `ops`Required +###### `ops`Required -- *Type:* JsonPatch +- *Type:* JsonPatch The operations to apply. --- -##### `copy` +##### `copy` ```typescript -import { JsonPatch } from 'cdk-pipelines-github' +import { JsonPatch } from '@nextdoor/cdk-pipelines-github' JsonPatch.copy(from: string, path: string) ``` @@ -5594,22 +5594,22 @@ JsonPatch.copy('/biscuits/0', '/best_biscuit') ``` -###### `from`Required +###### `from`Required - *Type:* string --- -###### `path`Required +###### `path`Required - *Type:* string --- -##### `move` +##### `move` ```typescript -import { JsonPatch } from 'cdk-pipelines-github' +import { JsonPatch } from '@nextdoor/cdk-pipelines-github' JsonPatch.move(from: string, path: string) ``` @@ -5625,22 +5625,22 @@ JsonPatch.move('/biscuits', '/cookies') ``` -###### `from`Required +###### `from`Required - *Type:* string --- -###### `path`Required +###### `path`Required - *Type:* string --- -##### `remove` +##### `remove` ```typescript -import { JsonPatch } from 'cdk-pipelines-github' +import { JsonPatch } from '@nextdoor/cdk-pipelines-github' JsonPatch.remove(path: string) ``` @@ -5654,16 +5654,16 @@ JsonPatch.remove('/biscuits/0') ``` -###### `path`Required +###### `path`Required - *Type:* string --- -##### `replace` +##### `replace` ```typescript -import { JsonPatch } from 'cdk-pipelines-github' +import { JsonPatch } from '@nextdoor/cdk-pipelines-github' JsonPatch.replace(path: string, value: any) ``` @@ -5679,22 +5679,22 @@ JsonPatch.replace('/biscuits/0/name', 'Chocolate Digestive') ``` -###### `path`Required +###### `path`Required - *Type:* string --- -###### `value`Required +###### `value`Required - *Type:* any --- -##### `test` +##### `test` ```typescript -import { JsonPatch } from 'cdk-pipelines-github' +import { JsonPatch } from '@nextdoor/cdk-pipelines-github' JsonPatch.test(path: string, value: any) ``` @@ -5711,13 +5711,13 @@ JsonPatch.test('/best_biscuit/name', 'Choco Leibniz') ``` -###### `path`Required +###### `path`Required - *Type:* string --- -###### `value`Required +###### `value`Required - *Type:* any @@ -5725,7 +5725,7 @@ JsonPatch.test('/best_biscuit/name', 'Choco Leibniz') -### Runner +### Runner The type of runner to run the job on. @@ -5737,14 +5737,14 @@ In case of self-hosted, a list of labels can be supplied. | **Name** | **Description** | | --- | --- | -| selfHosted | Creates a runner instance that sets runsOn to `self-hosted`. | +| selfHosted | Creates a runner instance that sets runsOn to `self-hosted`. | --- -##### `selfHosted` +##### `selfHosted` ```typescript -import { Runner } from 'cdk-pipelines-github' +import { Runner } from '@nextdoor/cdk-pipelines-github' Runner.selfHosted(labels: string[]) ``` @@ -5753,7 +5753,7 @@ Creates a runner instance that sets runsOn to `self-hosted`. Additional labels can be supplied. There is no need to supply `self-hosted` as a label explicitly. -###### `labels`Required +###### `labels`Required - *Type:* string[] @@ -5763,11 +5763,11 @@ Additional labels can be supplied. There is no need to supply `self-hosted` as a | **Name** | **Type** | **Description** | | --- | --- | --- | -| runsOn | string \| string[] | *No description.* | +| runsOn | string \| string[] | *No description.* | --- -##### `runsOn`Required +##### `runsOn`Required ```typescript public readonly runsOn: string | string[]; @@ -5781,76 +5781,76 @@ public readonly runsOn: string | string[]; | **Name** | **Type** | **Description** | | --- | --- | --- | -| MACOS_LATEST | Runner | Runner instance that sets runsOn to `macos-latest`. | -| UBUNTU_LATEST | Runner | Runner instance that sets runsOn to `ubuntu-latest`. | -| WINDOWS_LATEST | Runner | Runner instance that sets runsOn to `windows-latest`. | +| MACOS_LATEST | Runner | Runner instance that sets runsOn to `macos-latest`. | +| UBUNTU_LATEST | Runner | Runner instance that sets runsOn to `ubuntu-latest`. | +| WINDOWS_LATEST | Runner | Runner instance that sets runsOn to `windows-latest`. | --- -##### `MACOS_LATEST`Required +##### `MACOS_LATEST`Required ```typescript public readonly MACOS_LATEST: Runner; ``` -- *Type:* Runner +- *Type:* Runner Runner instance that sets runsOn to `macos-latest`. --- -##### `UBUNTU_LATEST`Required +##### `UBUNTU_LATEST`Required ```typescript public readonly UBUNTU_LATEST: Runner; ``` -- *Type:* Runner +- *Type:* Runner Runner instance that sets runsOn to `ubuntu-latest`. --- -##### `WINDOWS_LATEST`Required +##### `WINDOWS_LATEST`Required ```typescript public readonly WINDOWS_LATEST: Runner; ``` -- *Type:* Runner +- *Type:* Runner Runner instance that sets runsOn to `windows-latest`. --- -### YamlFile +### YamlFile Represents a Yaml File. -#### Initializers +#### Initializers ```typescript -import { YamlFile } from 'cdk-pipelines-github' +import { YamlFile } from '@nextdoor/cdk-pipelines-github' new YamlFile(filePath: string, options?: YamlFileOptions) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | -| filePath | string | *No description.* | -| options | YamlFileOptions | *No description.* | +| filePath | string | *No description.* | +| options | YamlFileOptions | *No description.* | --- -##### `filePath`Required +##### `filePath`Required - *Type:* string --- -##### `options`Optional +##### `options`Optional -- *Type:* YamlFileOptions +- *Type:* YamlFileOptions --- @@ -5858,14 +5858,14 @@ new YamlFile(filePath: string, options?: YamlFileOptions) | **Name** | **Description** | | --- | --- | -| patch | Applies an RFC 6902 JSON-patch to the synthesized object file. See https://datatracker.ietf.org/doc/html/rfc6902 for more information. | -| toYaml | Returns the patched yaml file. | -| update | Update the output object. | -| writeFile | Write the patched yaml file to the specified location. | +| patch | Applies an RFC 6902 JSON-patch to the synthesized object file. See https://datatracker.ietf.org/doc/html/rfc6902 for more information. | +| toYaml | Returns the patched yaml file. | +| update | Update the output object. | +| writeFile | Write the patched yaml file to the specified location. | --- -##### `patch` +##### `patch` ```typescript public patch(patches: JsonPatch): void @@ -5904,15 +5904,15 @@ on: ... ``` -###### `patches`Required +###### `patches`Required -- *Type:* JsonPatch +- *Type:* JsonPatch The patch operations to apply. --- -##### `toYaml` +##### `toYaml` ```typescript public toYaml(): string @@ -5920,7 +5920,7 @@ public toYaml(): string Returns the patched yaml file. -##### `update` +##### `update` ```typescript public update(obj: any): void @@ -5928,13 +5928,13 @@ public update(obj: any): void Update the output object. -###### `obj`Required +###### `obj`Required - *Type:* any --- -##### `writeFile` +##### `writeFile` ```typescript public writeFile(): void @@ -5947,11 +5947,11 @@ Write the patched yaml file to the specified location. | **Name** | **Type** | **Description** | | --- | --- | --- | -| commentAtTop | string | A comment to be added to the top of the YAML file. | +| commentAtTop | string | A comment to be added to the top of the YAML file. | --- -##### `commentAtTop`Optional +##### `commentAtTop`Optional ```typescript public readonly commentAtTop: string; @@ -5987,7 +5987,7 @@ name: deploy ## Enums -### JobPermission +### JobPermission Access level for workflow permission scopes. @@ -5995,34 +5995,34 @@ Access level for workflow permission scopes. | **Name** | **Description** | | --- | --- | -| READ | Read-only access. | -| WRITE | Read-write access. | -| NONE | No access at all. | +| READ | Read-only access. | +| WRITE | Read-write access. | +| NONE | No access at all. | --- -##### `READ` +##### `READ` Read-only access. --- -##### `WRITE` +##### `WRITE` Read-write access. --- -##### `NONE` +##### `NONE` No access at all. --- -### StackCapabilities +### StackCapabilities Acknowledge IAM resources in AWS CloudFormation templates. @@ -6032,27 +6032,27 @@ Acknowledge IAM resources in AWS CloudFormation templates. | **Name** | **Description** | | --- | --- | -| IAM | Acknowledge your stack includes IAM resources. | -| NAMED_IAM | Acknowledge your stack includes custom names for IAM resources. | -| AUTO_EXPAND | Acknowledge your stack contains one or more macros. | +| IAM | Acknowledge your stack includes IAM resources. | +| NAMED_IAM | Acknowledge your stack includes custom names for IAM resources. | +| AUTO_EXPAND | Acknowledge your stack contains one or more macros. | --- -##### `IAM` +##### `IAM` Acknowledge your stack includes IAM resources. --- -##### `NAMED_IAM` +##### `NAMED_IAM` Acknowledge your stack includes custom names for IAM resources. --- -##### `AUTO_EXPAND` +##### `AUTO_EXPAND` Acknowledge your stack contains one or more macros. diff --git a/package.json b/package.json index 1ad4e853..7126adbe 100644 --- a/package.json +++ b/package.json @@ -1,5 +1,5 @@ { - "name": "cdk-pipelines-github", + "name": "@nextdoor/cdk-pipelines-github", "description": "GitHub Workflows support for CDK Pipelines", "repository": { "type": "git", @@ -15,36 +15,28 @@ "docgen": "npx projen docgen", "eject": "npx projen eject", "eslint": "npx projen eslint", - "integ": "npx projen integ", - "integ:update": "npx projen integ:update", "package": "npx projen package", "package-all": "npx projen package-all", - "package:dotnet": "npx projen package:dotnet", - "package:go": "npx projen package:go", - "package:java": "npx projen package:java", "package:js": "npx projen package:js", - "package:python": "npx projen package:python", "post-compile": "npx projen post-compile", "post-upgrade": "npx projen post-upgrade", "pre-compile": "npx projen pre-compile", - "release": "npx projen release", - "rosetta:extract": "npx projen rosetta:extract", + "release:nextdoor": "npx projen release:nextdoor", "test": "npx projen test", "test:update": "npx projen test:update", "test:watch": "npx projen test:watch", "unbump": "npx projen unbump", "upgrade": "npx projen upgrade", - "upgrade-cdklabs-projen-project-types": "npx projen upgrade-cdklabs-projen-project-types", "watch": "npx projen watch", "projen": "npx projen" }, "author": { "name": "Amazon Web Services", "email": "aws-cdk-dev@amazon.com", - "organization": true + "organization": false }, "devDependencies": { - "@aws-cdk/integ-runner": "latest", + "@aws-cdk/integ-runner": "^2.60.0", "@aws-cdk/integ-tests-alpha": "latest", "@types/jest": "^27", "@types/node": "^16", @@ -63,7 +55,7 @@ "jsii-diff": "^1.88.0", "jsii-docgen": "^7.2.9", "jsii-pacmak": "^1.88.0", - "jsii-rosetta": "^5.1.11", + "jsii-rosetta": "1.x", "npm-check-updates": "^16", "projen": "^0.73.6", "standard-version": "^9", @@ -92,11 +84,11 @@ "keywords": [ "cdk" ], - "engines": { - "node": ">= 16.13.0" - }, "main": "lib/index.js", "license": "Apache-2.0", + "publishConfig": { + "registry": "https://npm.pkg.github.com/" + }, "version": "0.0.0", "jest": { "testMatch": [ @@ -139,29 +131,10 @@ } }, "types": "lib/index.d.ts", - "stability": "experimental", + "stability": "stable", "jsii": { "outdir": "dist", - "targets": { - "java": { - "package": "io.github.cdklabs.cdkpipelines.github", - "maven": { - "groupId": "io.github.cdklabs", - "artifactId": "cdk-pipelines-github" - } - }, - "python": { - "distName": "cdk-pipelines-github", - "module": "cdk_pipelines_github" - }, - "dotnet": { - "namespace": "Cdklabs.CdkPipelinesGitHub", - "packageId": "Cdklabs.CdkPipelinesGitHub" - }, - "go": { - "moduleName": "github.com/cdklabs/cdk-pipelines-github-go" - } - }, + "targets": {}, "tsc": { "outDir": "lib", "rootDir": "src" diff --git a/yarn.lock b/yarn.lock index c4e7bdcd..69e3409b 100644 --- a/yarn.lock +++ b/yarn.lock @@ -15,14 +15,12 @@ "@jridgewell/gen-mapping" "^0.3.0" "@jridgewell/trace-mapping" "^0.3.9" -"@aws-cdk/integ-runner@latest": - version "2.94.0-alpha.0" - resolved "https://registry.yarnpkg.com/@aws-cdk/integ-runner/-/integ-runner-2.94.0-alpha.0.tgz#1ce93341773457218728e87dd0f6433b29e80dd3" - integrity sha512-6KDCwmOKcMpoOGhQAHJi31K1fuF1eyHFXxWZ4+FjdyofUQW7C2VjDXSavccEuvWAMudkyJTqQkxHalmEZpVFHA== +"@aws-cdk/integ-runner@^2.60.0": + version "2.72.1" + resolved "https://registry.yarnpkg.com/@aws-cdk/integ-runner/-/integ-runner-2.72.1.tgz#c0ef2968182205aa4616305d581ba9d9e8e0266d" + integrity sha512-K+PHvPRrhLbGC33vro5kDNdol5HW/ECORLesxjk5LMXQGDgHqEIIlYgtloVAswlaNSpjopTGrH+/BZYI7Oa8eQ== dependencies: - aws-cdk "2.94.0" - optionalDependencies: - fsevents "2.3.2" + aws-cdk "2.72.1" "@aws-cdk/integ-tests-alpha@latest": version "2.94.0-alpha.0" @@ -1401,10 +1399,10 @@ aws-cdk-lib@2.9.0: semver "^7.3.5" yaml "1.10.2" -aws-cdk@2.94.0: - version "2.94.0" - resolved "https://registry.yarnpkg.com/aws-cdk/-/aws-cdk-2.94.0.tgz#2bf7bc649f41e13b864fb8cfdbf42218786df95e" - integrity sha512-9bJkzxFDYZDwPDfZi/DSUODn4HFRzuXWPhpFgIIgRykfT18P+iAIJ1AEhaaCmlqrrog5yQgN+2iYd9BwDsiBeg== +aws-cdk@2.72.1: + version "2.72.1" + resolved "https://registry.yarnpkg.com/aws-cdk/-/aws-cdk-2.72.1.tgz#5c8dc41239ed7f47d2dd2f54afb980df2a58a24b" + integrity sha512-Noihlxyurq9ecz/aTx+j3raeedI0hcPaYFKqS1CkFDoOEvLHIuIEB6regoJHWy9GER/yYYgKu68c7xYo3LaZPA== optionalDependencies: fsevents "2.3.2" @@ -2261,15 +2259,6 @@ dotgitignore@^2.1.0: find-up "^3.0.0" minimatch "^3.0.4" -downlevel-dts@^0.11.0: - version "0.11.0" - resolved "https://registry.yarnpkg.com/downlevel-dts/-/downlevel-dts-0.11.0.tgz#514a2d723009c5845730c1db6c994484c596ed9c" - integrity sha512-vo835pntK7kzYStk7xUHDifiYJvXxVhUapt85uk2AI94gUUAQX9HNRtrcMHNSc3YHJUEHGbYIGsM99uIbgAtxw== - dependencies: - semver "^7.3.2" - shelljs "^0.8.3" - typescript next - eastasianwidth@^0.2.0: version "0.2.0" resolved "https://registry.yarnpkg.com/eastasianwidth/-/eastasianwidth-0.2.0.tgz#696ce2ec0aa0e6ea93a397ffcf24aa7840c827cb" @@ -4138,7 +4127,7 @@ jsii-reflect@^1.80.0, jsii-reflect@^1.88.0: oo-ascii-tree "^1.88.0" yargs "^16.2.0" -jsii-rosetta@^1.80.0, jsii-rosetta@^1.88.0: +jsii-rosetta@1.x, jsii-rosetta@^1.80.0, jsii-rosetta@^1.88.0: version "1.88.0" resolved "https://registry.yarnpkg.com/jsii-rosetta/-/jsii-rosetta-1.88.0.tgz#1189fb2aa538082d3099b104e2d51daf2cf485e7" integrity sha512-6xRRkwWUKFqDTnjgCXkB6v9dxA51KUD4Cd7InLB4qirMBDuMtyYhYVNc1yJbHPYs9gkN5/ao0dFk+1CQxt7T7g== @@ -4156,25 +4145,6 @@ jsii-rosetta@^1.80.0, jsii-rosetta@^1.88.0: workerpool "^6.4.2" yargs "^16.2.0" -jsii-rosetta@^5.1.11: - version "5.1.11" - resolved "https://registry.yarnpkg.com/jsii-rosetta/-/jsii-rosetta-5.1.11.tgz#0beac0b3d07798e9a26bfb32012f4201371f26bb" - integrity sha512-kZfHby0gqmwvpGUOgFhevoge4Fek1+zdGYs+nb7SIhxJL8s5amdUEUXoUB8evB/0unMvINSjhMbyiW+8h2JG6Q== - dependencies: - "@jsii/check-node" "1.88.0" - "@jsii/spec" "^1.88.0" - "@xmldom/xmldom" "^0.8.10" - chalk "^4" - commonmark "^0.30.0" - fast-glob "^3.3.1" - jsii "~5.1.5" - semver "^7.5.4" - semver-intersect "^1.4.0" - stream-json "^1.8.0" - typescript "~5.1.6" - workerpool "^6.4.2" - yargs "^17.7.2" - jsii@1.88.0: version "1.88.0" resolved "https://registry.yarnpkg.com/jsii/-/jsii-1.88.0.tgz#f8b56420d47c6230dafb5d78a601bd5696e4f69c" @@ -4213,25 +4183,6 @@ jsii@1.x: typescript "~3.9.10" yargs "^16.2.0" -jsii@~5.1.5: - version "5.1.12" - resolved "https://registry.yarnpkg.com/jsii/-/jsii-5.1.12.tgz#0ac6d92d52c6732a6e0e3e27f9f07453318715f2" - integrity sha512-iY3zLosUEKbeua6IAGJXjFxibiiI0xHFjyYPyewOc56MBRHC7nczWSVGRP+Jgwyo7HWXs4TvJKLG6w8zSuAZrg== - dependencies: - "@jsii/check-node" "1.88.0" - "@jsii/spec" "^1.88.0" - case "^1.6.3" - chalk "^4" - downlevel-dts "^0.11.0" - fast-deep-equal "^3.1.3" - log4js "^6.9.1" - semver "^7.5.4" - semver-intersect "^1.4.0" - sort-json "^2.0.1" - spdx-license-list "^6.6.0" - typescript "~5.1.6" - yargs "^17.7.2" - json-buffer@3.0.1: version "3.0.1" resolved "https://registry.yarnpkg.com/json-buffer/-/json-buffer-3.0.1.tgz#9338802a30d3b6605fbe0613e094008ca8c05a13" @@ -5682,7 +5633,7 @@ shebang-regex@^3.0.0: resolved "https://registry.yarnpkg.com/shebang-regex/-/shebang-regex-3.0.0.tgz#ae16f1644d873ecad843b0307b143362d4c42172" integrity sha512-7++dFhtcx3353uBaq8DDR4NuxBetBzC7ZQOhmTQInHEd6bSrXdiEyzCvG07Z44UYdLShWUyXt5M/yhz8ekcb1A== -shelljs@^0.8.3, shelljs@^0.8.5: +shelljs@^0.8.5: version "0.8.5" resolved "https://registry.yarnpkg.com/shelljs/-/shelljs-0.8.5.tgz#de055408d8361bed66c669d2f000538ced8ee20c" integrity sha512-TiwcRcrkhHvbrZbnRcFYMLl30Dfov3HKqzp5tO5b4pt6G/SezKcYhmDg15zXVBswHmctSAQKznqNW2LO5tTDow== @@ -6330,21 +6281,11 @@ typescript@^4.9.5: resolved "https://registry.yarnpkg.com/typescript/-/typescript-4.9.5.tgz#095979f9bcc0d09da324d58d03ce8f8374cbe65a" integrity sha512-1FXk9E2Hm+QzZQ7z+McJiHL4NW1F2EzMu9Nq9i3zAaGqibafqYwCVU6WyWAuyQRRzOlxou8xZSyXLEN8oKj24g== -typescript@next: - version "5.3.0-dev.20230903" - resolved "https://registry.yarnpkg.com/typescript/-/typescript-5.3.0-dev.20230903.tgz#418860c2efe9f85bc9474d9b00db0cf95f14aaac" - integrity sha512-E6LOaE+pWeqBPUkvCjVrcgUgk/TrbWcAyL+YbEX1fM7MKdgq71dIqihS8eubBZx5y1oiTgmf6A7xyb+ySHCeaw== - typescript@~3.9.10: version "3.9.10" resolved "https://registry.yarnpkg.com/typescript/-/typescript-3.9.10.tgz#70f3910ac7a51ed6bef79da7800690b19bf778b8" integrity sha512-w6fIxVE/H1PkLKcCPsFqKE7Kv7QUwhU8qQY2MueZXWx5cPZdwFupLgKK3vntcK98BtNHZtAF4LA/yl2a7k8R6Q== -typescript@~5.1.6: - version "5.1.6" - resolved "https://registry.yarnpkg.com/typescript/-/typescript-5.1.6.tgz#02f8ac202b6dad2c0dd5e0913745b47a37998274" - integrity sha512-zaWCozRZ6DLEWAWFrVDz1H6FVXzUSfTy5FUMWsQlU8Ym5JP9eO4xkTIROFCQvhQf61z6O/G6ugw3SgAnvvm+HA== - uglify-js@^3.1.4: version "3.17.4" resolved "https://registry.yarnpkg.com/uglify-js/-/uglify-js-3.17.4.tgz#61678cf5fa3f5b7eb789bb345df29afb8257c22c"