From ff1fd50788ee647d9d2808ed9ed9ecef8bbcdaad Mon Sep 17 00:00:00 2001 From: Moulaye Zein Haidara <106992257+zeinhaidara@users.noreply.github.com> Date: Wed, 11 Nov 2026 14:26:37 -0500 Subject: [PATCH] Standardize documentation, licensing and workflow permissions --- .github/workflows/ci.yml | 3 +++ .gitignore | 1 + LICENSE | 21 +++++++++++++++++++++ README.md | 11 +++++------ 4 files changed, 30 insertions(+), 6 deletions(-) create mode 100644 LICENSE diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index a4d62df..48a120a 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -5,6 +5,9 @@ on: branches: [main] pull_request: +permissions: + contents: read + jobs: lint-and-test: runs-on: ubuntu-latest diff --git a/.gitignore b/.gitignore index b568a25..c0ef81c 100644 --- a/.gitignore +++ b/.gitignore @@ -7,3 +7,4 @@ __pycache__/ .pytest_cache/ .ruff_cache/ *.egg-info/ +*.tfplan diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..480e650 --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2026 Moulaye Zein Haidara + +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/README.md b/README.md index 39b7cab..147921c 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,6 @@ -# cloud-tagging-cli +# Cloud resource tagging CLI -A CLI that checks cloud resources against a standard tagging policy and -bulk-fixes the violations it can fix safely. +A Python CLI that checks and bulk-fixes AWS resource tags. Azure and GCP remain interface-only stubs that raise `NotImplementedError`. Validation uses fakes in CI. ## Problem @@ -11,7 +10,7 @@ at all. This tool defines one standard-tags policy, reports who's out of line (`check`), and brings them into line (`apply`), without ever guessing a value it can't justify. -## Scope, honestly +## Scope Only **AWS** has a real adapter, built on the [Resource Groups Tagging API](https://docs.aws.amazon.com/resourcegroupstaggingapi/latest/APIReference/) @@ -85,7 +84,7 @@ tags: case: upper ``` -## Limits +## Known limitations - Only AWS has working code against a real API shape; Azure/GCP are stubs. - `apply` never guesses a disallowed or missing-with-no-default value — it @@ -110,7 +109,7 @@ tags. When the diff is empty, no `set_tags`/`TagResources` call is made. Running `apply --apply` twice in a row produces zero additional API calls on the second run — covered by `test_apply_is_idempotent_on_second_run`. -## Testing status +## Validation level Tested: rule engine (all four violation kinds, including negative cases), config loading (valid + four malformed-config negative cases), the AWS