From 48d40884e5ff02a9771b1ed32b845ac537afa322 Mon Sep 17 00:00:00 2001 From: Anton Novikov Date: Wed, 7 May 2025 16:00:59 +0200 Subject: [PATCH 1/5] Refactor README.md. Add LICENSE. --- LICENSE | 201 ++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 149 +++++++++++++++++++++++++++++++++++ docs/CODEOWNERS | 2 +- 3 files changed, 351 insertions(+), 1 deletion(-) create mode 100644 LICENSE create mode 100644 README.md 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 new file mode 100644 index 0000000..43eecbe --- /dev/null +++ b/README.md @@ -0,0 +1,149 @@ +# Gitlabflow CD Action + +[![Release](https://img.shields.io/github/v/release/edenlabllc/gitlabflow.cd.action.svg?style=for-the-badge)](https://github.com/edenlabllc/gitlabflow.cd.action/releases/latest) +[![Software License](https://img.shields.io/github/license/edenlabllc/gitlabflow.cd.action.svg?style=for-the-badge)](LICENSE) +[![Powered By: Edenlab](https://img.shields.io/badge/powered%20by-edenlab-8A2BE2.svg?style=for-the-badge)](https://edenlab.io) + +Reusable GitHub Action for provisioning and destroying clusters, synchronizing releases, and updating project +dependencies using RMK β€” with multi-cloud and multi-environment support. + +## 🚦 What it does + +This action encapsulates CD logic for tenant bootstrap repositories using [RMK](https://github.com/edenlabllc/rmk). +It supports a wide range of infrastructure and deployment operations, triggered by workflow inputs or environment +settings. + +**Key features:** + +- Cluster provisioning (`rmk cluster capi *`) +- Cluster destruction with optional `[skip cluster destroy]` support +- Release sync and version updates +- Project dependency version updates +- Helmfile validation +- Slack notifications (optional) +- AWS, Azure, GCP support via structured credentials + +## βœ… Supported commands + +Controlled by the `rmk_command` input: + +| Command | Purpose | +|---------------------|----------------------------------------------| +| `provision` | Provision a cluster and sync releases | +| `destroy` | Tear down a cluster (with CAPI safety logic) | +| `release_sync` | Apply release definitions | +| `release_update` | Update release version/tag for a repository | +| `project_update` | Patch dependency version in `project.yaml` | +| `helmfile_validate` | Validate Helmfile templates | + +## 🧠 Why use this + +Managing infra per repo is error-prone and hard to maintain. This action: + +- Centralizes CD logic across all tenants and environments. +- Supports GitHub-native CD with workflow-level configuration. +- Tracks outputs for automation and audit. +- Minimizes boilerplate: run, pass inputs, and let RMK do the work. + +## βš™οΈ Usage + +Used in `workflow_dispatch` workflows inside tenant bootstrap repositories. + +### Example + +```yaml +name: Cluster provisioner + +on: + workflow_dispatch: + inputs: + rmk_command: + description: 'Choose command: provision or destroy' + required: true + default: provision + type: choice + options: + - provision + - destroy + rmk_version: + description: RMK version + required: false + default: latest + +env: + RMK_CLUSTER_PROVIDER: aws + +jobs: + cluster-provision: + runs-on: ubuntu-22.04 + steps: + - name: Checkout + uses: actions/checkout@v4 + - name: Run Gitlabflow CD Action + uses: edenlabllc/gitlabflow.cd.action@v2 + with: + github_token_repo_full_access: ${{ secrets.GH_TOKEN_REPO_FULL_ACCESS }} + cluster_provider_credentials: ${{ secrets.CLUSTER_PROVIDER_CREDENTIALS }} + rmk_cluster_provider: ${{ env.RMK_CLUSTER_PROVIDER }} + rmk_command: ${{ inputs.rmk_command }} + rmk_version: ${{ inputs.rmk_version }} +``` + +See [`examples/`](./examples) for more templates. + +## πŸ” Required secrets + +| Name | Purpose | +|--------------------------------|--------------------------------------------| +| `GH_TOKEN_REPO_FULL_ACCESS` | GitHub PAT with access to private repos | +| `CLUSTER_PROVIDER_CREDENTIALS` | JSON object with cloud credentials per env | +| `SLACK_WEBHOOK` | (Optional) Slack Incoming Webhook URL | + +## 🌍 Cloud providers + +Defined inside `cluster_provider_credentials` as structured JSON: + +- **AWS**: + `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY`, `AWS_REGION` +- **Azure**: + `AZURE_CLIENT_ID`, `AZURE_CLIENT_SECRET`, `AZURE_SUBSCRIPTION_ID`, `AZURE_TENANT_ID`, `AZURE_LOCATION` +- **GCP**: + Full service account JSON under `GOOGLE_APPLICATION_CREDENTIALS` and `GCP_REGION` + +Each environment (e.g. `develop`, `staging`, `production`) may define multiple providers. + +## πŸ“€ Outputs + +Returned by the action depending on command: + +| Output name | Description | +|------------------------------------|-------------------------------------------| +| `environment` | Current CD environment | +| `git_branch` | Git branch name | +| `rmk_release_version` | Release version (for `release_update`) | +| `rmk_release_repository_full_name` | Full image repo (for `release_update`) | +| `rmk_project_dependency_name` | Dependency name (for `project_update`) | +| `rmk_project_dependency_version` | Dependency version (for `project_update`) | + +## πŸ”” Slack notifications + +Enable by setting: + +```yaml +with: + rmk_slack_notifications: true + rmk_slack_webhook: ${{ secrets.SLACK_WEBHOOK }} + rmk_slack_channel: "#cd-events" + rmk_slack_message_details: | + GitHub Actions Run: https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }} + Triggered by: ${{ github.actor }} +``` + +Notifications are sent for **Success**, **Failure**, and **Skip** (e.g. `[skip cluster destroy]` in commit message). + +## πŸ“‚ Internals + +- [`action.yml`](./action.yml) β€” defines inputs and outputs. +- [`main.py`](./main.py) β€” executes command logic. +- `commands/` β€” contains all supported RMK command implementations. +- [`examples/`](./examples) β€” ready-to-use workflow templates. diff --git a/docs/CODEOWNERS b/docs/CODEOWNERS index 8f2a70b..d79a0d3 100644 --- a/docs/CODEOWNERS +++ b/docs/CODEOWNERS @@ -1,3 +1,3 @@ # These owners will be the default owners for everything in # the repo and will be requested for review when someone opens a pull request. -* @anovikov-el @apanasiuk-el +* @anovikov-el @apanasiuk-el @vadim-bogdanovsky From 192984df3df590246fb4f696fa406f5385676c95 Mon Sep 17 00:00:00 2001 From: Anton Novikov Date: Wed, 7 May 2025 16:08:03 +0200 Subject: [PATCH 2/5] Refactor README.md. Add LICENSE. --- README.md | 16 +++------------- 1 file changed, 3 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 43eecbe..0af4199 100644 --- a/README.md +++ b/README.md @@ -99,18 +99,9 @@ See [`examples/`](./examples) for more templates. | `CLUSTER_PROVIDER_CREDENTIALS` | JSON object with cloud credentials per env | | `SLACK_WEBHOOK` | (Optional) Slack Incoming Webhook URL | -## 🌍 Cloud providers +## 🌍Cluster provider credentials -Defined inside `cluster_provider_credentials` as structured JSON: - -- **AWS**: - `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY`, `AWS_REGION` -- **Azure**: - `AZURE_CLIENT_ID`, `AZURE_CLIENT_SECRET`, `AZURE_SUBSCRIPTION_ID`, `AZURE_TENANT_ID`, `AZURE_LOCATION` -- **GCP**: - Full service account JSON under `GOOGLE_APPLICATION_CREDENTIALS` and `GCP_REGION` - -Each environment (e.g. `develop`, `staging`, `production`) may define multiple providers. +See the [`action.yaml`](action.yml)'s `cluster_provider_credentials` action input for more details. ## πŸ“€ Outputs @@ -133,7 +124,7 @@ Enable by setting: with: rmk_slack_notifications: true rmk_slack_webhook: ${{ secrets.SLACK_WEBHOOK }} - rmk_slack_channel: "#cd-events" + rmk_slack_channel: "#rmk-test-cd" rmk_slack_message_details: | GitHub Actions Run: https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }} Triggered by: ${{ github.actor }} @@ -145,5 +136,4 @@ Notifications are sent for **Success**, **Failure**, and **Skip** (e.g. `[skip c - [`action.yml`](./action.yml) β€” defines inputs and outputs. - [`main.py`](./main.py) β€” executes command logic. -- `commands/` β€” contains all supported RMK command implementations. - [`examples/`](./examples) β€” ready-to-use workflow templates. From d81cd124adb03d8ed5d73db7373dc141fb5530d1 Mon Sep 17 00:00:00 2001 From: Anton Novikov Date: Wed, 7 May 2025 16:10:23 +0200 Subject: [PATCH 3/5] Remove all emojis from README.md. --- README.md | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 0af4199..c23b667 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,7 @@ Reusable GitHub Action for provisioning and destroying clusters, synchronizing releases, and updating project dependencies using RMK β€” with multi-cloud and multi-environment support. -## 🚦 What it does +## What it does This action encapsulates CD logic for tenant bootstrap repositories using [RMK](https://github.com/edenlabllc/rmk). It supports a wide range of infrastructure and deployment operations, triggered by workflow inputs or environment @@ -23,7 +23,7 @@ settings. - Slack notifications (optional) - AWS, Azure, GCP support via structured credentials -## βœ… Supported commands +## Supported commands Controlled by the `rmk_command` input: @@ -36,7 +36,7 @@ Controlled by the `rmk_command` input: | `project_update` | Patch dependency version in `project.yaml` | | `helmfile_validate` | Validate Helmfile templates | -## 🧠 Why use this +## Why use this Managing infra per repo is error-prone and hard to maintain. This action: @@ -45,7 +45,7 @@ Managing infra per repo is error-prone and hard to maintain. This action: - Tracks outputs for automation and audit. - Minimizes boilerplate: run, pass inputs, and let RMK do the work. -## βš™οΈ Usage +## Usage Used in `workflow_dispatch` workflows inside tenant bootstrap repositories. @@ -91,7 +91,7 @@ jobs: See [`examples/`](./examples) for more templates. -## πŸ” Required secrets +## Required secrets | Name | Purpose | |--------------------------------|--------------------------------------------| @@ -99,11 +99,11 @@ See [`examples/`](./examples) for more templates. | `CLUSTER_PROVIDER_CREDENTIALS` | JSON object with cloud credentials per env | | `SLACK_WEBHOOK` | (Optional) Slack Incoming Webhook URL | -## 🌍Cluster provider credentials +## Cluster provider credentials See the [`action.yaml`](action.yml)'s `cluster_provider_credentials` action input for more details. -## πŸ“€ Outputs +## Outputs Returned by the action depending on command: @@ -116,7 +116,7 @@ Returned by the action depending on command: | `rmk_project_dependency_name` | Dependency name (for `project_update`) | | `rmk_project_dependency_version` | Dependency version (for `project_update`) | -## πŸ”” Slack notifications +## Slack notifications Enable by setting: @@ -132,8 +132,8 @@ with: Notifications are sent for **Success**, **Failure**, and **Skip** (e.g. `[skip cluster destroy]` in commit message). -## πŸ“‚ Internals +## Internals -- [`action.yml`](./action.yml) β€” defines inputs and outputs. -- [`main.py`](./main.py) β€” executes command logic. -- [`examples/`](./examples) β€” ready-to-use workflow templates. +- [`action.yml`](./action.yml) β€” defines action inputs and outputs. +- [`main.py`](./main.py) β€” executes action logic. +- [`examples/`](./examples) β€” example ready-to-use workflow templates. From 73afeb8947a0b4a8881da5b87386aa3d73d4bf17 Mon Sep 17 00:00:00 2001 From: Anton Novikov Date: Wed, 7 May 2025 16:35:56 +0200 Subject: [PATCH 4/5] Remove all emojis from README.md. --- README.md | 16 ++++------------ 1 file changed, 4 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index c23b667..65b030e 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,7 @@ settings. **Key features:** -- Cluster provisioning (`rmk cluster capi *`) +- Cluster provisioning - Cluster destruction with optional `[skip cluster destroy]` support - Release sync and version updates - Project dependency version updates @@ -79,6 +79,7 @@ jobs: steps: - name: Checkout uses: actions/checkout@v4 + - name: Run Gitlabflow CD Action uses: edenlabllc/gitlabflow.cd.action@v2 with: @@ -101,20 +102,11 @@ See [`examples/`](./examples) for more templates. ## Cluster provider credentials -See the [`action.yaml`](action.yml)'s `cluster_provider_credentials` action input for more details. +See the [`action.yaml`](action.yml)'s `cluster_provider_credentials` section for more details. ## Outputs -Returned by the action depending on command: - -| Output name | Description | -|------------------------------------|-------------------------------------------| -| `environment` | Current CD environment | -| `git_branch` | Git branch name | -| `rmk_release_version` | Release version (for `release_update`) | -| `rmk_release_repository_full_name` | Full image repo (for `release_update`) | -| `rmk_project_dependency_name` | Dependency name (for `project_update`) | -| `rmk_project_dependency_version` | Dependency version (for `project_update`) | +See the [`action.yaml`](action.yml)'s `outputs` section for more details. ## Slack notifications From 70da5e422e76220021f3a79a78209f7913db46ed Mon Sep 17 00:00:00 2001 From: Anton Novikov Date: Wed, 7 May 2025 16:42:28 +0200 Subject: [PATCH 5/5] Remove all emojis from README.md. --- docs/CODEOWNERS | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/CODEOWNERS b/docs/CODEOWNERS index d79a0d3..8f2a70b 100644 --- a/docs/CODEOWNERS +++ b/docs/CODEOWNERS @@ -1,3 +1,3 @@ # These owners will be the default owners for everything in # the repo and will be requested for review when someone opens a pull request. -* @anovikov-el @apanasiuk-el @vadim-bogdanovsky +* @anovikov-el @apanasiuk-el