Add Github Action details to CI.md

ansible-collections · May 8, 2023 · 5cf3d0b · 5cf3d0b
1 parent 800ed8d
commit 5cf3d0b
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 2 deletions.
diff --git a/CI.md 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 |<TBA> | <TBA> |
diff --git 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
@@ -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