diff --git a/.gitattributes b/.gitattributes index 31cfd93..1299013 100644 --- a/.gitattributes +++ b/.gitattributes @@ -7,7 +7,7 @@ /.github/workflows/build.yml linguist-generated /.github/workflows/pull-request-lint.yml linguist-generated /.github/workflows/release.yml linguist-generated -/.github/workflows/upgrade-master.yml linguist-generated +/.github/workflows/upgrade-main.yml linguist-generated /.gitignore linguist-generated /.mergify.yml linguist-generated /.npmignore linguist-generated diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 8741dcb..0475824 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -4,7 +4,7 @@ name: release on: push: branches: - - master + - main workflow_dispatch: {} jobs: release: diff --git a/.github/workflows/upgrade-master.yml b/.github/workflows/upgrade-main.yml similarity index 94% rename from .github/workflows/upgrade-master.yml rename to .github/workflows/upgrade-main.yml index 3b91ea0..09e420c 100644 --- a/.github/workflows/upgrade-master.yml +++ b/.github/workflows/upgrade-main.yml @@ -1,6 +1,6 @@ # ~~ Generated by projen. To modify, edit .projenrc.js and run "npx projen". -name: upgrade-master +name: upgrade-main on: workflow_dispatch: {} schedule: @@ -17,7 +17,7 @@ jobs: - name: Checkout uses: actions/checkout@v3 with: - ref: master + ref: main - name: Install dependencies run: yarn install --check-files --frozen-lockfile - name: Upgrade dependencies @@ -46,7 +46,7 @@ jobs: - name: Checkout uses: actions/checkout@v3 with: - ref: master + ref: main - name: Download patch uses: actions/download-artifact@v3 with: @@ -72,8 +72,8 @@ jobs: ------ - *Automatically created by projen via the "upgrade-master" workflow* - branch: github-actions/upgrade-master + *Automatically created by projen via the "upgrade-main" workflow* + branch: github-actions/upgrade-main title: "chore(deps): upgrade dependencies" body: |- Upgrades project dependencies. See details in [workflow run]. @@ -82,7 +82,7 @@ jobs: ------ - *Automatically created by projen via the "upgrade-master" workflow* + *Automatically created by projen via the "upgrade-main" workflow* author: github-actions committer: github-actions signoff: true diff --git a/.gitignore b/.gitignore index 1020acc..e31dd32 100644 --- a/.gitignore +++ b/.gitignore @@ -39,7 +39,7 @@ junit.xml /dist/version.txt !/.github/workflows/release.yml !/.mergify.yml -!/.github/workflows/upgrade-master.yml +!/.github/workflows/upgrade-main.yml !/.github/pull_request_template.md !/test/ !/tsconfig.dev.json diff --git a/.projen/files.json b/.projen/files.json index feba423..ffcd5fd 100644 --- a/.projen/files.json +++ b/.projen/files.json @@ -6,7 +6,7 @@ ".github/workflows/build.yml", ".github/workflows/pull-request-lint.yml", ".github/workflows/release.yml", - ".github/workflows/upgrade-master.yml", + ".github/workflows/upgrade-main.yml", ".gitignore", ".mergify.yml", ".projen/deps.json", diff --git a/.projen/tasks.json b/.projen/tasks.json index 4f88db0..57e5a46 100644 --- a/.projen/tasks.json +++ b/.projen/tasks.json @@ -176,7 +176,7 @@ }, "release": { "name": "release", - "description": "Prepare a release from \"master\" branch", + "description": "Prepare a release from \"main\" branch", "env": { "RELEASE": "true" }, diff --git a/.projenrc.js b/.projenrc.js index bf7bbe6..20f9e58 100644 --- a/.projenrc.js +++ b/.projenrc.js @@ -1,6 +1,6 @@ const { awscdk } = require('projen'); const project = new awscdk.AwsCdkConstructLibrary({ - defaultReleaseBranch: 'master', + defaultReleaseBranch: 'main', author: 'JNE', cdkVersion: '2.1.0', name: 'cdk-appconfig', diff --git a/README.md b/README.md index d8cd6a1..4e128aa 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,16 @@ # cdk-appconfig -## Hello ! +## Motivation ! This simple project was inspired from [this stackoverflow question](https://stackoverflow.com/questions/67579029/aws-cdk-lambda-appconfig-typescript-example-please/74724158#74724158), where I shared [this answer](https://stackoverflow.com/a/74724158). When I [read docs on the AppConfig construct library](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_appconfig-readme.html), I soon realized that it was ripe for L2 and L3 constructs. Hence this library. The library is published under the following names: +## API Documentation +* Please refer projen autogenerated API docs [here](API.md) + +## Releases |Language|Repository |--------|----------- |JavaScript/TypeScript|[cdk-appconfig](https://www.npmjs.com/package/cdk-appconfig) \ No newline at end of file