Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Github Action details to CI.md #1519

Conversation

GomathiselviS
Copy link
Collaborator

@GomathiselviS GomathiselviS commented May 4, 2023

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

@GomathiselviS GomathiselviS changed the title Add Github Action details to CI.md WIP: Add Github Action details to CI.md May 4, 2023
@softwarefactory-project-zuul
Copy link
Contributor

Copy link
Contributor

@tremble tremble left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Generally looks good, some minor musings:

  • Might be good to link to descriptions of the tests
  • I'd split out the different linters (makes adding links easier)
  • We should using sanity tests against 3.6 and 3.7 for at least 6.x

@GomathiselviS
Copy link
Collaborator Author

GomathiselviS commented May 4, 2023

Generally looks good, some minor musings:

  • Might be good to link to descriptions of the tests
  • I'd split out the different linters (makes adding links easier)
  • We should using sanity tests against 3.6 and 3.7 for at least 6.x

@tremble

Regarding the sanity tests against py 3.6 and py 3.7 :
From this document, I see that from ansible 2.12 there is no support for py 3.6 and 3.7 on the controller node. Please correct me if my understanding is wrong.

Regarding the linters, I am waiting for a decision on this comment. For now, I do not see any linters config added to tox.ini. We can add black and flake8 to tox.ini. Let me know what you think.

@softwarefactory-project-zuul
Copy link
Contributor

@GomathiselviS GomathiselviS requested a review from tremble May 5, 2023 18:00
@GomathiselviS GomathiselviS changed the title WIP: Add Github Action details to CI.md Add Github Action details to CI.md May 8, 2023
@softwarefactory-project-zuul
Copy link
Contributor

@softwarefactory-project-zuul
Copy link
Contributor

Copy link
Collaborator

@alinabuzachis alinabuzachis left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I guess we should also probably let know users how to contribute, where are the flow located or something like that

CI.md Outdated
| ------ |-------| ------ | -----------|
| 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) |
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
| 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) |

@GomathiselviS
Copy link
Collaborator Author

I guess we should also probably let know users how to contribute, where are the flow located or something like that

Do you mean contributing to the github_actions? I think any contribution to GHA for amazon.aws will go into the collection's .github folder. I have given the link to this folder and the workflows in CI.md.

@github-actions
Copy link

github-actions bot commented May 9, 2023

Docs Build 📝

Thank you for contribution!✨

The docsite for this PR is available for download as an artifact from this run:
https://github.com/ansible-collections/amazon.aws/actions/runs/4926721931

You can compare to the docs for the main branch here:
https://ansible-collections.github.io/amazon.aws/branch/main

File changes:

  • A collections/amazon/aws/backup_selection_info_module.html
  • A collections/amazon/aws/backup_selection_module.html
  • M collections/amazon/aws/backup_restore_job_info_module.html
  • M collections/amazon/aws/backup_tag_module.html
  • M collections/amazon/aws/index.html
  • M collections/index_module.html
Click to see the diff comparison.

NOTE: only file modifications are shown here. New and deleted files are excluded.
See the file list and check the published docs to see those files.

diff --git a/home/runner/work/amazon.aws/amazon.aws/docsbuild/base/collections/amazon/aws/backup_restore_job_info_module.html b/home/runner/work/amazon.aws/amazon.aws/docsbuild/head/collections/amazon/aws/backup_restore_job_info_module.html
index 8bb6eae..6e29981 100644
--- a/home/runner/work/amazon.aws/amazon.aws/docsbuild/base/collections/amazon/aws/backup_restore_job_info_module.html
+++ b/home/runner/work/amazon.aws/amazon.aws/docsbuild/head/collections/amazon/aws/backup_restore_job_info_module.html
@@ -19,7 +19,7 @@
         <script src="../../../_static/sphinx_highlight.js"></script>
     <script src="../../../_static/js/theme.js"></script>
     <link rel="search" title="Search" href="../../../search.html" />
-    <link rel="next" title="amazon.aws.backup_tag module – Manage tags on backup plan, backup vault, recovery point" href="backup_tag_module.html" />
+    <link rel="next" title="amazon.aws.backup_selection module – Create, delete and modify AWS Backup selection" href="backup_selection_module.html" />
     <link rel="prev" title="amazon.aws.aws_caller_info module – Get information about the user and account being used to make AWS calls" href="aws_caller_info_module.html" /><!-- extra head elements for Ansible beyond RTD Sphinx Theme -->
 
 
@@ -532,7 +532,7 @@ see <a class="reference internal" href="#ansible-collections-amazon-aws-backup-r
 
 <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
         <a href="aws_caller_info_module.html" class="btn btn-neutral float-left" title="amazon.aws.aws_caller_info module – Get information about the user and account being used to make AWS calls" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
-        <a href="backup_tag_module.html" class="btn btn-neutral float-right" title="amazon.aws.backup_tag module – Manage tags on backup plan, backup vault, recovery point" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
+        <a href="backup_selection_module.html" class="btn btn-neutral float-right" title="amazon.aws.backup_selection module – Create, delete and modify AWS Backup selection" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
     </div>
 
   <hr/>
diff --git a/home/runner/work/amazon.aws/amazon.aws/docsbuild/base/collections/amazon/aws/backup_tag_module.html b/home/runner/work/amazon.aws/amazon.aws/docsbuild/head/collections/amazon/aws/backup_tag_module.html
index 9aac17f..2c561c1 100644
--- a/home/runner/work/amazon.aws/amazon.aws/docsbuild/base/collections/amazon/aws/backup_tag_module.html
+++ b/home/runner/work/amazon.aws/amazon.aws/docsbuild/head/collections/amazon/aws/backup_tag_module.html
@@ -20,7 +20,7 @@
     <script src="../../../_static/js/theme.js"></script>
     <link rel="search" title="Search" href="../../../search.html" />
     <link rel="next" title="amazon.aws.backup_tag_info module – List tags on AWS Backup resources" href="backup_tag_info_module.html" />
-    <link rel="prev" title="amazon.aws.backup_restore_job_info module – List information about backup restore jobs" href="backup_restore_job_info_module.html" /><!-- extra head elements for Ansible beyond RTD Sphinx Theme -->
+    <link rel="prev" title="amazon.aws.backup_selection_info module – Describe AWS Backup Plans" href="backup_selection_info_module.html" /><!-- extra head elements for Ansible beyond RTD Sphinx Theme -->
 
 
 
@@ -475,7 +475,7 @@ see <a class="reference internal" href="#ansible-collections-amazon-aws-backup-t
           
 
 <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
-        <a href="backup_restore_job_info_module.html" class="btn btn-neutral float-left" title="amazon.aws.backup_restore_job_info module – List information about backup restore jobs" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
+        <a href="backup_selection_info_module.html" class="btn btn-neutral float-left" title="amazon.aws.backup_selection_info module – Describe AWS Backup Plans" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
         <a href="backup_tag_info_module.html" class="btn btn-neutral float-right" title="amazon.aws.backup_tag_info module – List tags on AWS Backup resources" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
     </div>
 
diff --git a/home/runner/work/amazon.aws/amazon.aws/docsbuild/base/collections/amazon/aws/index.html b/home/runner/work/amazon.aws/amazon.aws/docsbuild/head/collections/amazon/aws/index.html
index f09e8b1..a465a84 100644
--- a/home/runner/work/amazon.aws/amazon.aws/docsbuild/base/collections/amazon/aws/index.html
+++ b/home/runner/work/amazon.aws/amazon.aws/docsbuild/head/collections/amazon/aws/index.html
@@ -217,6 +217,8 @@
 <li><p><a class="reference internal" href="aws_az_info_module.html#ansible-collections-amazon-aws-aws-az-info-module"><span class="std std-ref">aws_az_info module</span></a> – Gather information about availability zones in AWS</p></li>
 <li><p><a class="reference internal" href="aws_caller_info_module.html#ansible-collections-amazon-aws-aws-caller-info-module"><span class="std std-ref">aws_caller_info module</span></a> – Get information about the user and account being used to make AWS calls</p></li>
 <li><p><a class="reference internal" href="backup_restore_job_info_module.html#ansible-collections-amazon-aws-backup-restore-job-info-module"><span class="std std-ref">backup_restore_job_info module</span></a> – List information about backup restore jobs</p></li>
+<li><p><a class="reference internal" href="backup_selection_module.html#ansible-collections-amazon-aws-backup-selection-module"><span class="std std-ref">backup_selection module</span></a> – Create, delete and modify AWS Backup selection</p></li>
+<li><p><a class="reference internal" href="backup_selection_info_module.html#ansible-collections-amazon-aws-backup-selection-info-module"><span class="std std-ref">backup_selection_info module</span></a> – Describe AWS Backup Plans</p></li>
 <li><p><a class="reference internal" href="backup_tag_module.html#ansible-collections-amazon-aws-backup-tag-module"><span class="std std-ref">backup_tag module</span></a> – Manage tags on backup plan, backup vault, recovery point</p></li>
 <li><p><a class="reference internal" href="backup_tag_info_module.html#ansible-collections-amazon-aws-backup-tag-info-module"><span class="std std-ref">backup_tag_info module</span></a> – List tags on AWS Backup resources</p></li>
 <li><p><a class="reference internal" href="backup_vault_module.html#ansible-collections-amazon-aws-backup-vault-module"><span class="std std-ref">backup_vault module</span></a> – Manage AWS Backup Vaults</p></li>
diff --git a/home/runner/work/amazon.aws/amazon.aws/docsbuild/base/collections/index_module.html b/home/runner/work/amazon.aws/amazon.aws/docsbuild/head/collections/index_module.html
index 38257b5..d372b9a 100644
--- a/home/runner/work/amazon.aws/amazon.aws/docsbuild/base/collections/index_module.html
+++ b/home/runner/work/amazon.aws/amazon.aws/docsbuild/head/collections/index_module.html
@@ -127,6 +127,8 @@
 <li><p><a class="reference internal" href="amazon/aws/aws_az_info_module.html#ansible-collections-amazon-aws-aws-az-info-module"><span class="std std-ref">amazon.aws.aws_az_info</span></a> – Gather information about availability zones in AWS</p></li>
 <li><p><a class="reference internal" href="amazon/aws/aws_caller_info_module.html#ansible-collections-amazon-aws-aws-caller-info-module"><span class="std std-ref">amazon.aws.aws_caller_info</span></a> – Get information about the user and account being used to make AWS calls</p></li>
 <li><p><a class="reference internal" href="amazon/aws/backup_restore_job_info_module.html#ansible-collections-amazon-aws-backup-restore-job-info-module"><span class="std std-ref">amazon.aws.backup_restore_job_info</span></a> – List information about backup restore jobs</p></li>
+<li><p><a class="reference internal" href="amazon/aws/backup_selection_module.html#ansible-collections-amazon-aws-backup-selection-module"><span class="std std-ref">amazon.aws.backup_selection</span></a> – Create, delete and modify AWS Backup selection</p></li>
+<li><p><a class="reference internal" href="amazon/aws/backup_selection_info_module.html#ansible-collections-amazon-aws-backup-selection-info-module"><span class="std std-ref">amazon.aws.backup_selection_info</span></a> – Describe AWS Backup Plans</p></li>
 <li><p><a class="reference internal" href="amazon/aws/backup_tag_module.html#ansible-collections-amazon-aws-backup-tag-module"><span class="std std-ref">amazon.aws.backup_tag</span></a> – Manage tags on backup plan, backup vault, recovery point</p></li>
 <li><p><a class="reference internal" href="amazon/aws/backup_tag_info_module.html#ansible-collections-amazon-aws-backup-tag-info-module"><span class="std std-ref">amazon.aws.backup_tag_info</span></a> – List tags on AWS Backup resources</p></li>
 <li><p><a class="reference internal" href="amazon/aws/backup_vault_module.html#ansible-collections-amazon-aws-backup-vault-module"><span class="std std-ref">amazon.aws.backup_vault</span></a> – Manage AWS Backup Vaults</p></li>

@softwarefactory-project-zuul
Copy link
Contributor

@GomathiselviS GomathiselviS added the mergeit Merge the PR (SoftwareFactory) label May 10, 2023
@softwarefactory-project-zuul
Copy link
Contributor

Build succeeded (gate pipeline).
https://ansible.softwarefactory-project.io/zuul/buildset/d4426a21f3384a629a3bb137d95648a5

✔️ ansible-galaxy-importer SUCCESS in 3m 45s
✔️ build-ansible-collection SUCCESS in 12m 19s

@softwarefactory-project-zuul softwarefactory-project-zuul bot merged commit c979afc into ansible-collections:main May 10, 2023
abikouo pushed a commit to abikouo/amazon.aws that referenced this pull request Oct 24, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
mergeit Merge the PR (SoftwareFactory)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants