Skip to content

Commit

Permalink
Add Github Action details to CI.md (#1519)
Browse files Browse the repository at this point in the history
Add Github Action details to CI.md

SUMMARY


We have the CI jobs from Zuul to GithubActions. This PR adds the documentation related to CI.
ISSUE TYPE


Docs Pull Request

COMPONENT NAME

ADDITIONAL INFORMATION

Reviewed-by: Mark Chappell
Reviewed-by: Alina Buzachis
  • Loading branch information
GomathiselviS authored May 10, 2023
1 parent d72b87f commit c979afc
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 2 deletions.
13 changes: 13 additions & 0 deletions CI.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# 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, changelog check and doc related checks. The following table lists the python and ansible versions against which these jobs are run.

| 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 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| <TBA> | <TBA> |
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand All @@ -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
Expand Down

0 comments on commit c979afc

Please sign in to comment.