diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS new file mode 100644 index 0000000..609b3ce --- /dev/null +++ b/.github/CODEOWNERS @@ -0,0 +1,4 @@ +# These owners will be the default owners for everything in the repo +# unless a later match takes precedence, and will be requested for +# review when someone opens a pull request. +* @paulushcgcj @DerekRoberts \ No newline at end of file diff --git a/.github/intention.json b/.github/intention.json new file mode 100644 index 0000000..636be70 --- /dev/null +++ b/.github/intention.json @@ -0,0 +1,22 @@ +{ + "event": { + "provider": "placeholderprovider", + "reason": "Job triggered", + "url": "JOB_URL" + }, + "actions": [ + { + "action": "package-provision", + "id": "provision", + "provision": ["approle/secret-id"], + "service": { + "name": "placeholdername", + "project": "placeholderclient", + "environment": "placeholderenv" + } + } + ], + "user": { + "id": "placeholderuser" + } +} diff --git a/.github/labeler.yml b/.github/labeler.yml new file mode 100644 index 0000000..75d1b9b --- /dev/null +++ b/.github/labeler.yml @@ -0,0 +1,8 @@ +actions: + - .github/* + +source: + - action.yml + +documentation: + - *.md diff --git a/.github/workflows/pr-open.yml b/.github/workflows/pr-open.yml index 3872836..adb6eb0 100644 --- a/.github/workflows/pr-open.yml +++ b/.github/workflows/pr-open.yml @@ -8,18 +8,80 @@ concurrency: cancel-in-progress: true jobs: + pr-validation: + name: Pull Request Validation + runs-on: ubuntu-latest + permissions: + contents: read + pull-requests: write + steps: + - uses: actions/checkout@v3 + + - name: Pull request size and stability labels + uses: actions/labeler@v4 + continue-on-error: true + with: + repo-token: "${{ secrets.GITHUB_TOKEN }}" + + - name: Conventional Label + uses: bcoe/conventional-release-labels@v1 + continue-on-error: true + with: + token: ${{ secrets.GITHUB_TOKEN }} + ignored_types: '["chore","pr"]' + type_labels: '{"feat": "feature", "fix": "fix", "bug": "fix", "doc": "documentation", "ci": "ci", "chore": "chore", "breaking": "breaking", "BREAKING CHANGE": "breaking"}' + + - name: Checkout branch + uses: actions/checkout@v3 + with: + ref: refs/heads/${{ github.head_ref }} + + - name: Conventional Changelog Update + continue-on-error: true + uses: TriPSs/conventional-changelog-action@v3 + id: changelog + with: + github-token: ${{ github.token }} + output-file: 'CHANGELOG.md' + skip-version-file: 'true' + skip-commit: 'true' + git-push: 'false' + git-branch: refs/heads/${{ github.head_ref }} + + - name: Checkout pr + uses: actions/checkout@v3 + with: + ref: ${{ github.ref }} + + - name: Comment PR + continue-on-error: true + uses: thollander/actions-comment-pull-request@v2 + if: ${{ steps.changelog.outputs.skipped == 'false' }} + with: + message: | + # Current changelog + + ${{ steps.changelog.outputs.clean_changelog }} + comment_tag: '# Current changelog' + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + retags: permissions: packages: write runs-on: ubuntu-22.04 steps: - uses: actions/checkout@v3 + - name: Test Retags id: broker uses: ./ with: broker_jwt: ${{ secrets.BROKER_JWT }} provision_role_id: ${{ secrets.PROVISION_ROLE }} + project_name: client + app_name: app-client + environment: development + - name: Import Secrets id: secrets uses: hashicorp/vault-action@v2.5.0 @@ -28,5 +90,7 @@ jobs: token: ${{ steps.broker.outputs.vault_token }} exportEnv: 'false' secrets: | - apps/data/dev/client/app-client/db_proxy_read_only db_username | VAULT_DB_USER; - apps/data/dev/client/app-client/db_proxy_read_only db_password | VAULT_DB_PASS; + apps/data/${{ secrets.SECRET_PATH}} sample | SAMPLE; + + - name: Checks + run: echo ${{ steps.secrets.outputs.SAMPLE }} \ No newline at end of file diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..261eeb9 --- /dev/null +++ b/LICENSE @@ -0,0 +1,201 @@ + 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. diff --git a/README.md b/README.md index 96fd8c9..2d965ee 100644 --- a/README.md +++ b/README.md @@ -12,10 +12,6 @@ This is useful in CI/CD pipelines where you need to access a secret, get a vault This tool is currently based on the existing documentation provided by 1team. -Package name: `//:` - -Pull with: `docker pull ghcr.io///:` - # Usage ```yaml @@ -28,6 +24,15 @@ Pull with: `docker pull ghcr.io///:` # Role ID for Provision provision_role_id: The id of the role to be used during provisioning + + # Project name on vault + project_name: Name of the project on vault, Ex. client + + # Application name on vault + app_name: Name of the app on vault, Ex. app-client + + # Vault environment + environment: Name of the vault environment, Ex. development ### Usually a bad idea / not recommended @@ -81,6 +86,9 @@ jobs: with: broker_jwt: ${{ secrets.BROKER_JWT }} provision_role_id: ${{ secrets.PROVISION_ROLE }} + project_name: super + app_name: app-super + environment: development - name: Import Secrets id: secrets uses: hashicorp/vault-action@v2.5.0 @@ -126,6 +134,9 @@ jobs: with: broker_jwt: ${{ secrets.BROKER_JWT }} provision_role_id: ${{ secrets.PROVISION_ROLE }} + project_name: super + app_name: app-super + environment: development - name: Import Secrets id: secrets uses: hashicorp/vault-action@v2.5.0 diff --git a/action.yml b/action.yml index 632084a..3eebfdc 100644 --- a/action.yml +++ b/action.yml @@ -12,6 +12,15 @@ inputs: provision_role_id: description: The id of the role to be used during provisioning required: true + project_name: + description: Name of the project on vault, Ex. client + required: true + app_name: + description: Name of the app on vault, Ex. app-client + required: true + environment: + description: Name of the vault environment, Ex. development + required: true ### Usually a bad idea / not recommended diff_branch: @@ -46,9 +55,13 @@ runs: shell: bash run: | # Read the intention file and replace the event url and the user id - PAYLOAD=$(cat .github/openshift/intention.json | \ + PAYLOAD=$(cat .github/intention.json | \ jq ".event.url=\"${GITHUB_SERVER_URL}${GITHUB_ACTION_PATH}\" | \ - .user.id=\"${GITHUB_ACTOR}\"") + .user.id=\"${GITHUB_ACTOR}\" | \ + .event.provider=\"${{ github.repository }}-github-action\" | \ + .actions[0].service.name=\"${{ inputs.app_name }}\" | \ + .actions[0].service.project=\"${{ inputs.project_name }}\" | \ + .actions[0].service.environment=\"${{ inputs.environment }}\"") # Open an intention to the broker INTENTION=$(curl -s -X POST ${{ inputs.broker_url }}/v1/intention/open \