diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index b2096af..78b7542 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -57,10 +57,16 @@ jobs: contents: write if: always() && needs.build.outputs.self_mutation_happened && !(github.event.pull_request.head.repo.full_name != github.repository) steps: + - name: Generate token + id: generate_token + uses: tibdex/github-app-token@7ce9ffdcdeb2ba82b01b51d6584a6a85872336d4 + with: + app_id: ${{ secrets.PROJEN_APP_ID }} + private_key: ${{ secrets.PROJEN_APP_PRIVATE_KEY }} - name: Checkout uses: actions/checkout@v3 with: - token: ${{ secrets.PROJEN_GITHUB_TOKEN }} + token: ${{ steps.generate_token.outputs.token }} ref: ${{ github.event.pull_request.head.ref }} repository: ${{ github.event.pull_request.head.repo.full_name }} - name: Download patch diff --git a/.github/workflows/pull-request-lint.yml b/.github/workflows/pull-request-lint.yml index 4e53389..f13a07a 100644 --- a/.github/workflows/pull-request-lint.yml +++ b/.github/workflows/pull-request-lint.yml @@ -25,4 +25,6 @@ jobs: feat fix chore + docs + ci requireScope: false diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 0475824..b2cfa6b 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -2,9 +2,6 @@ name: release on: - push: - branches: - - main workflow_dispatch: {} jobs: release: @@ -41,6 +38,8 @@ jobs: with: name: build-artifact path: dist + - name: Publish tag + run: npx projen publish:git container: image: jsii/superchain:1-buster-slim-node14 release_github: diff --git a/.github/workflows/upgrade-main.yml b/.github/workflows/upgrade-main.yml index b58a1f3..c19a565 100644 --- a/.github/workflows/upgrade-main.yml +++ b/.github/workflows/upgrade-main.yml @@ -44,10 +44,16 @@ jobs: pull-requests: write if: ${{ needs.upgrade.outputs.patch_created }} steps: + - name: Generate token + id: generate_token + uses: tibdex/github-app-token@7ce9ffdcdeb2ba82b01b51d6584a6a85872336d4 + with: + app_id: ${{ secrets.PROJEN_APP_ID }} + private_key: ${{ secrets.PROJEN_APP_PRIVATE_KEY }} - name: Checkout uses: actions/checkout@v3 with: - token: ${{ secrets.PROJEN_GITHUB_TOKEN }} + token: ${{ steps.generate_token.outputs.token }} ref: main - name: Download patch uses: actions/download-artifact@v3 @@ -64,7 +70,7 @@ jobs: id: create-pr uses: peter-evans/create-pull-request@v3 with: - token: ${{ secrets.PROJEN_GITHUB_TOKEN }} + token: ${{ steps.generate_token.outputs.token }} commit-message: |- chore(deps): upgrade dependencies diff --git a/.npmignore b/.npmignore index 2b90937..3f51db7 100644 --- a/.npmignore +++ b/.npmignore @@ -1,4 +1,23 @@ # ~~ Generated by projen. To modify, edit .projenrc.js and run "npx projen". +.npmrc +.nvmrc +.versionrc +.gitattributes +*.tgz +*.gz +*.zip +cdk.out +.cdk.staging +/examples +PUBLISHING.md +.vscode +.projenrc.ts +projenrc +/images +API.md +CHANGELOG.md +CONTRIBUTING.md +SECURITY.md /.projen/ /test-reports/ junit.xml diff --git a/.projen/tasks.json b/.projen/tasks.json index c242b0e..873c767 100644 --- a/.projen/tasks.json +++ b/.projen/tasks.json @@ -174,6 +174,28 @@ "name": "pre-compile", "description": "Prepare the project for compilation" }, + "publish:git": { + "name": "publish:git", + "description": "Prepends the release changelog onto the project changelog, creates a release commit, and tags the release", + "env": { + "CHANGELOG": "dist/dist/changelog.md", + "RELEASE_TAG_FILE": "dist/dist/releasetag.txt", + "PROJECT_CHANGELOG_FILE": "CHANGELOG.md", + "VERSION_FILE": "dist/dist/version.txt" + }, + "steps": [ + { + "builtin": "release/update-changelog" + }, + { + "builtin": "release/tag-version" + }, + { + "exec": "git push --follow-tags origin main" + } + ], + "condition": "! git log --oneline -1 | grep -q \"chore(release):\"" + }, "release": { "name": "release", "description": "Prepare a release from \"main\" branch", diff --git a/.projenrc.ts b/.projenrc.ts index dbf01fb..c0f43d6 100644 --- a/.projenrc.ts +++ b/.projenrc.ts @@ -1,20 +1,79 @@ -const { awscdk } = require('projen'); +import { awscdk, github, release } from 'projen'; const project = new awscdk.AwsCdkConstructLibrary({ - author: 'briancaffey', + author: 'Brian Caffey', + authorEmail: 'briancaffey2010@gmail.com', projenrcTs: true, - authorAddress: 'briancaffey2010@gmail.com', + projenrcTsOptions: { + filename: '.projenrc.ts', + }, + authorAddress: '', + authorUrl: 'https://briancaffey.github.io', + license: 'MIT', + copyrightOwner: 'Brian Caffey', cdkVersion: '2.49.0', defaultReleaseBranch: 'main', name: 'cdk-django', repositoryUrl: 'git@github.com:briancaffey/cdk-django.git', + + // Automation + githubOptions: { + projenCredentials: github.GithubCredentials.fromApp(), + pullRequestLintOptions: { + semanticTitleOptions: { + types: ['feat', 'fix', 'chore', 'docs', 'ci'], + }, + }, + }, // https://github.com/projen/projen/issues/1941 bundledDeps: ['@types/jest@27.4.1'], - gitignore: ['cdk.out', 'notes', 'app.yml', 'base.yml', 'cdk.context.json'], majorVersion: 1, + releaseTrigger: { + isContinuous: false, + } as release.ReleaseTrigger, + // ignore + gitignore: ['cdk.out', 'notes', 'app.yml', 'base.yml', 'cdk.context.json'], + npmignore: [ + '.npmrc', + '.nvmrc', + '.versionrc', + '.gitattributes', + '*.tgz', + '*.gz', + '*.zip', + 'cdk.out', + '.cdk.staging', + '/examples', + 'PUBLISHING.md', + '.vscode', + '.projenrc.ts', + 'projenrc', + '/images', + 'API.md', + 'CHANGELOG.md', + 'CONTRIBUTING.md', + 'SECURITY.md', + ], // deps: [], /* Runtime dependencies of this module. */ // description: undefined, /* The description is just a string that helps people understand the purpose of the package. */ // devDeps: [], /* Build dependencies for this module. */ // packageName: undefined, /* The "name" in package.json. */ }); + +// release only via manual trigger +project.release?.publisher?.publishToGit({ + changelogFile: 'dist/dist/changelog.md', + versionFile: 'dist/dist/version.txt', + releaseTagFile: 'dist/dist/releasetag.txt', + projectChangelogFile: 'CHANGELOG.md', + gitBranch: 'main', +}); +project.tryFindObjectFile('.github/workflows/release.yml')?.addToArray( + 'jobs.release.steps', + { + name: 'Publish tag', + run: 'npx projen publish:git', + }, +); + project.synth(); \ No newline at end of file diff --git a/LICENSE b/LICENSE index d645695..f16fe73 100644 --- a/LICENSE +++ b/LICENSE @@ -1,202 +1,19 @@ - - Apache License - Version 2.0, January 2004 - http://www.apache.org/licenses/ - - TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION - - 1. Definitions. - - "License" shall mean the terms and conditions for use, reproduction, - and distribution as defined by Sections 1 through 9 of this document. - - "Licensor" shall mean the copyright owner or entity authorized by - the copyright owner that is granting the License. - - "Legal Entity" shall mean the union of the acting entity and all - other entities that control, are controlled by, or are under common - control with that entity. For the purposes of this definition, - "control" means (i) the power, direct or indirect, to cause the - direction or management of such entity, whether by contract or - otherwise, or (ii) ownership of fifty percent (50%) or more of the - outstanding shares, or (iii) beneficial ownership of such entity. - - "You" (or "Your") shall mean an individual or Legal Entity - exercising permissions granted by this License. - - "Source" form shall mean the preferred form for making modifications, - including but not limited to software source code, documentation - source, and configuration files. - - "Object" form shall mean any form resulting from mechanical - transformation or translation of a Source form, including but - not limited to compiled object code, generated documentation, - and conversions to other media types. - - "Work" shall mean the work of authorship, whether in Source or - Object form, made available under the License, as indicated by a - copyright notice that is included in or attached to the work - (an example is provided in the Appendix below). - - "Derivative Works" shall mean any work, whether in Source or Object - form, that is based on (or derived from) the Work and for which the - editorial revisions, annotations, elaborations, or other modifications - represent, as a whole, an original work of authorship. For the purposes - of this License, Derivative Works shall not include works that remain - separable from, or merely link (or bind by name) to the interfaces of, - the Work and Derivative Works thereof. - - "Contribution" shall mean any work of authorship, including - the original version of the Work and any modifications or additions - to that Work or Derivative Works thereof, that is intentionally - submitted to Licensor for inclusion in the Work by the copyright owner - or by an individual or Legal Entity authorized to submit on behalf of - the copyright owner. For the purposes of this definition, "submitted" - means any form of electronic, verbal, or written communication sent - to the Licensor or its representatives, including but not limited to - communication on electronic mailing lists, source code control systems, - and issue tracking systems that are managed by, or on behalf of, the - Licensor for the purpose of discussing and improving the Work, but - excluding communication that is conspicuously marked or otherwise - designated in writing by the copyright owner as "Not a Contribution." - - "Contributor" shall mean Licensor and any individual or Legal Entity - on behalf of whom a Contribution has been received by Licensor and - subsequently incorporated within the Work. - - 2. Grant of Copyright License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - copyright license to reproduce, prepare Derivative Works of, - publicly display, publicly perform, sublicense, and distribute the - Work and such Derivative Works in Source or Object form. - - 3. Grant of Patent License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - (except as stated in this section) patent license to make, have made, - use, offer to sell, sell, import, and otherwise transfer the Work, - where such license applies only to those patent claims licensable - by such Contributor that are necessarily infringed by their - Contribution(s) alone or by combination of their Contribution(s) - with the Work to which such Contribution(s) was submitted. If You - institute patent litigation against any entity (including a - cross-claim or counterclaim in a lawsuit) alleging that the Work - or a Contribution incorporated within the Work constitutes direct - or contributory patent infringement, then any patent licenses - granted to You under this License for that Work shall terminate - as of the date such litigation is filed. - - 4. Redistribution. You may reproduce and distribute copies of the - Work or Derivative Works thereof in any medium, with or without - modifications, and in Source or Object form, provided that You - meet the following conditions: - - (a) You must give any other recipients of the Work or - Derivative Works a copy of this License; and - - (b) You must cause any modified files to carry prominent notices - stating that You changed the files; and - - (c) You must retain, in the Source form of any Derivative Works - that You distribute, all copyright, patent, trademark, and - attribution notices from the Source form of the Work, - excluding those notices that do not pertain to any part of - the Derivative Works; and - - (d) If the Work includes a "NOTICE" text file as part of its - distribution, then any Derivative Works that You distribute must - include a readable copy of the attribution notices contained - within such NOTICE file, excluding those notices that do not - pertain to any part of the Derivative Works, in at least one - of the following places: within a NOTICE text file distributed - as part of the Derivative Works; within the Source form or - documentation, if provided along with the Derivative Works; or, - within a display generated by the Derivative Works, if and - wherever such third-party notices normally appear. The contents - of the NOTICE file are for informational purposes only and - do not modify the License. You may add Your own attribution - notices within Derivative Works that You distribute, alongside - or as an addendum to the NOTICE text from the Work, provided - that such additional attribution notices cannot be construed - as modifying the License. - - You may add Your own copyright statement to Your modifications and - may provide additional or different license terms and conditions - for use, reproduction, or distribution of Your modifications, or - for any such Derivative Works as a whole, provided Your use, - reproduction, and distribution of the Work otherwise complies with - the conditions stated in this License. - - 5. Submission of Contributions. Unless You explicitly state otherwise, - any Contribution intentionally submitted for inclusion in the Work - by You to the Licensor shall be under the terms and conditions of - this License, without any additional terms or conditions. - Notwithstanding the above, nothing herein shall supersede or modify - the terms of any separate license agreement you may have executed - with Licensor regarding such Contributions. - - 6. Trademarks. This License does not grant permission to use the trade - names, trademarks, service marks, or product names of the Licensor, - except as required for reasonable and customary use in describing the - origin of the Work and reproducing the content of the NOTICE file. - - 7. Disclaimer of Warranty. Unless required by applicable law or - agreed to in writing, Licensor provides the Work (and each - Contributor provides its Contributions) on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or - implied, including, without limitation, any warranties or conditions - of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A - PARTICULAR PURPOSE. You are solely responsible for determining the - appropriateness of using or redistributing the Work and assume any - risks associated with Your exercise of permissions under this License. - - 8. Limitation of Liability. In no event and under no legal theory, - whether in tort (including negligence), contract, or otherwise, - unless required by applicable law (such as deliberate and grossly - negligent acts) or agreed to in writing, shall any Contributor be - liable to You for damages, including any direct, indirect, special, - incidental, or consequential damages of any character arising as a - result of this License or out of the use or inability to use the - Work (including but not limited to damages for loss of goodwill, - work stoppage, computer failure or malfunction, or any and all - other commercial damages or losses), even if such Contributor - has been advised of the possibility of such damages. - - 9. Accepting Warranty or Additional Liability. While redistributing - the Work or Derivative Works thereof, You may choose to offer, - and charge a fee for, acceptance of support, warranty, indemnity, - or other liability obligations and/or rights consistent with this - License. However, in accepting such obligations, You may act only - on Your own behalf and on Your sole responsibility, not on behalf - of any other Contributor, and only if You agree to indemnify, - defend, and hold each Contributor harmless for any liability - incurred by, or claims asserted against, such Contributor by reason - of your accepting any such warranty or additional liability. - - END OF TERMS AND CONDITIONS - - APPENDIX: How to apply the Apache License to your work. - - To apply the Apache License to your work, attach the following - boilerplate notice, with the fields enclosed by brackets "[]" - replaced with your own identifying information. (Don't include - the brackets!) The text should be enclosed in the appropriate - comment syntax for the file format. We also recommend that a - file or class name and description of purpose be included on the - same "printed page" as the copyright notice for easier - identification within third-party archives. - - Copyright [yyyy] [name of copyright owner] - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. +Copyright (c) 2023 Brian Caffey + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/package.json b/package.json index ee99a87..2031ab3 100644 --- a/package.json +++ b/package.json @@ -20,6 +20,7 @@ "post-compile": "npx projen post-compile", "post-upgrade": "npx projen post-upgrade", "pre-compile": "npx projen pre-compile", + "publish:git": "npx projen publish:git", "release": "npx projen release", "test": "npx projen test", "test:watch": "npx projen test:watch", @@ -29,8 +30,9 @@ "projen": "npx projen" }, "author": { - "name": "briancaffey", + "name": "Brian Caffey", "email": "briancaffey2010@gmail.com", + "url": "https://briancaffey.github.io", "organization": false }, "devDependencies": { @@ -72,7 +74,7 @@ "cdk" ], "main": "lib/index.js", - "license": "Apache-2.0", + "license": "MIT", "version": "0.0.0", "jest": { "testMatch": [