From 5cf3d0bd4fafa537c0714e77484611e6a57cf345 Mon Sep 17 00:00:00 2001 From: GomathiselviS Date: Thu, 4 May 2023 12:04:04 -0400 Subject: [PATCH 1/4] Add Github Action details to CI.md --- CI.md | 14 ++++++++++++++ CONTRIBUTING.md | 2 +- README.md | 3 ++- 3 files changed, 17 insertions(+), 2 deletions(-) create mode 100644 CI.md diff --git a/CI.md b/CI.md new file mode 100644 index 00000000000..3c8d7826383 --- /dev/null +++ b/CI.md @@ -0,0 +1,14 @@ +# CI + +## AWS Collections + +GitHub Actions are used to run the Continuous Integration for amazon.aws collection. The workflows used for the CI can be found [here](https://github.com/ansible-collections/amazon.aws/tree/main/.github/workflows). These workflows include jobs to run the unit tests, integration tests, sanity tests, linters, changelo +g check and doc related checks. The following table lists the python and ansible versions against which these jobs are run. + +| Jobs | Python Versions | Ansible Versions | +| ------ | ------ | -----------| +| changelog | 3.9 | devel | +| Linters | 3.9 | devel | +| Sanity | 3.8, 3.9, 3.10, 3.11 | Stable-2.12, 2.13, 2.14 (not on py 3.11), Stable-2.15+ (not on 3.8) | +| Unit tests | 3.9, 3.10 | Stable-2.12+ | +| Integration tests | | | diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 3984c29c40b..17be9b7d700 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -98,7 +98,7 @@ Don't forget to add [a changelog entry](https://docs.ansible.com/ansible/latest/ Then create a pull request. If you're struggling with running integration tests locally, don't worry. -After creating a pull request the CI bot will automatically test for you. +After creating a pull request the GitHub Actions will automatically test for you. ## More information about contributing diff --git a/README.md b/README.md index ef97e0397ef..67bdd629dd0 100644 --- a/README.md +++ b/README.md @@ -87,7 +87,6 @@ You can either call modules by their Fully Qualified Collection Name (FQCN), suc register: instance ``` - ### See Also: * [Amazon Web Services Guide](https://docs.ansible.com/ansible/latest/collections/amazon/aws/docsite/guide_aws.html) @@ -98,6 +97,8 @@ You can either call modules by their Fully Qualified Collection Name (FQCN), suc We welcome community contributions to this collection. If you find problems, please open an issue or create a PR against the [Amazon AWS collection repository](https://github.com/ansible-collections/amazon.aws). See [CONTRIBUTING.md](https://github.com/ansible-collections/amazon.aws/blob/main/CONTRIBUTING.md) for more details. +This collection is tested using GitHub Actions. To know more on testing, refer to [CI.md](https://github.com/ansible-collections/amazon.aws/blob/main/CI,md). + You can also join us on: - Libera.Chat IRC - the ``#ansible-aws`` [irc.libera.chat](https://libera.chat/) channel From e994d83d37823697eb3d48695db79fd6de3d2e28 Mon Sep 17 00:00:00 2001 From: GomathiselviS Date: Mon, 8 May 2023 10:11:51 -0400 Subject: [PATCH 2/4] Updated test description --- CI.md | 17 ++++++++--------- 1 file changed, 8 insertions(+), 9 deletions(-) diff --git a/CI.md b/CI.md index 3c8d7826383..0ebea4344e8 100644 --- a/CI.md +++ b/CI.md @@ -2,13 +2,12 @@ ## AWS Collections -GitHub Actions are used to run the Continuous Integration for amazon.aws collection. The workflows used for the CI can be found [here](https://github.com/ansible-collections/amazon.aws/tree/main/.github/workflows). These workflows include jobs to run the unit tests, integration tests, sanity tests, linters, changelo -g check and doc related checks. The following table lists the python and ansible versions against which these jobs are run. +GitHub Actions are used to run the Continuous Integration for amazon.aws collection. The workflows used for the CI can be found [here](https://github.com/ansible-collections/amazon.aws/tree/main/.github/workflows). These workflows include jobs to run the unit tests, integration tests, sanity tests, linters, changelog check and doc related checks. The following table lists the python and ansible versions against which these jobs are run. -| Jobs | Python Versions | Ansible Versions | -| ------ | ------ | -----------| -| changelog | 3.9 | devel | -| Linters | 3.9 | devel | -| Sanity | 3.8, 3.9, 3.10, 3.11 | Stable-2.12, 2.13, 2.14 (not on py 3.11), Stable-2.15+ (not on 3.8) | -| Unit tests | 3.9, 3.10 | Stable-2.12+ | -| Integration tests | | | +| Jobs | Description | Python Versions | Ansible Versions | +| ------ |-------| ------ | -----------| +| changelog |Checks for the presence of Changelog fragments | 3.9 | devel | +| Linters | Runs `black` and `flake8` on plugins and tests | 3.9 | devel | +| Sanity | Runs absible sanity checks | 3.8, 3.9, 3.10, 3.11 | Stable-2.12, 2.13, 2.14 (not on py 3.11), Stable-2.15+ (not on 3.8) | +| Unit tests | Executes the unit test cases | 3.9, 3.10 | Stable-2.12+ | +| Integration tests | Executest the integration test suites| | | From 4d3628d00bd4d9640edfba8c9a64cb5d4643f267 Mon Sep 17 00:00:00 2001 From: GomathiselviS Date: Mon, 8 May 2023 11:48:50 -0400 Subject: [PATCH 3/4] Fix typo --- CI.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CI.md b/CI.md index 0ebea4344e8..46b19614667 100644 --- a/CI.md +++ b/CI.md @@ -10,4 +10,4 @@ GitHub Actions are used to run the Continuous Integration for amazon.aws collect | Linters | Runs `black` and `flake8` on plugins and tests | 3.9 | devel | | Sanity | Runs absible sanity checks | 3.8, 3.9, 3.10, 3.11 | Stable-2.12, 2.13, 2.14 (not on py 3.11), Stable-2.15+ (not on 3.8) | | Unit tests | Executes the unit test cases | 3.9, 3.10 | Stable-2.12+ | -| Integration tests | Executest the integration test suites| | | +| Integration tests | Executes the integration test suites| | | From 62604a6bbbb96f0fc5b3b6ba91756a82b08caff6 Mon Sep 17 00:00:00 2001 From: GomathiselviS Date: Tue, 9 May 2023 10:06:15 -0400 Subject: [PATCH 4/4] Fixed typo --- CI.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CI.md b/CI.md index 46b19614667..8f1bd6c3371 100644 --- a/CI.md +++ b/CI.md @@ -8,6 +8,6 @@ GitHub Actions are used to run the Continuous Integration for amazon.aws collect | ------ |-------| ------ | -----------| | changelog |Checks for the presence of Changelog fragments | 3.9 | devel | | Linters | Runs `black` and `flake8` on plugins and tests | 3.9 | devel | -| Sanity | Runs absible sanity checks | 3.8, 3.9, 3.10, 3.11 | Stable-2.12, 2.13, 2.14 (not on py 3.11), Stable-2.15+ (not on 3.8) | +| Sanity | Runs ansible sanity checks | 3.8, 3.9, 3.10, 3.11 | Stable-2.12, 2.13, 2.14 (not on py 3.11), Stable-2.15+ (not on 3.8) | | Unit tests | Executes the unit test cases | 3.9, 3.10 | Stable-2.12+ | | Integration tests | Executes the integration test suites| | |