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

Cleanup headers and imports #1738

Conversation

tremble
Copy link
Contributor

@tremble tremble commented Mar 6, 2023

SUMMARY

Mass update of imports, docs fragments and file headers

ISSUE TYPE
  • Docs Pull Request
  • Feature Pull Request
COMPONENT NAME
ADDITIONAL INFORMATION

Header cleanup based upon:

https://docs.ansible.com/ansible/devel/dev_guide/developing_modules_documenting.html#python-shebang-utf-8-coding

Begin your Ansible module with #!/usr/bin/python - this “shebang” allows ansible_python_interpreter to work. Follow the shebang immediately with # -*- coding: utf-8 -*- to clarify that the file is UTF-8 encoded.

and
https://docs.ansible.com/ansible/devel/dev_guide/developing_modules_documenting.html#copyright-and-license

After the shebang and UTF-8 coding, add a copyright line with the original copyright holder and a license declaration. The license declaration should be ONLY one line, not the full GPL prefix.
...
Additions to the module (for instance, rewrites) are not permitted to add additional copyright lines other than the default copyright statement if missing:

@github-actions
Copy link

github-actions bot commented Mar 6, 2023

Docs Build 📝

Thank you for contribution!✨

This PR has been merged and your docs changes will be incorporated when they are next published.

@softwarefactory-project-zuul
Copy link
Contributor

Build failed.
https://ansible.softwarefactory-project.io/zuul/buildset/dc4780c1c86649b988a6428f1e1a83b9

✔️ ansible-galaxy-importer SUCCESS in 4m 17s
✔️ build-ansible-collection SUCCESS in 31m 39s
✔️ ansible-test-sanity-docker-devel SUCCESS in 8m 38s (non-voting)
✔️ ansible-test-sanity-docker-milestone SUCCESS in 12m 16s (non-voting)
✔️ ansible-test-sanity-docker-stable-2.12 SUCCESS in 11m 32s
✔️ ansible-test-sanity-docker-stable-2.13 SUCCESS in 8m 32s
✔️ ansible-test-sanity-docker-stable-2.14 SUCCESS in 10m 03s
✔️ ansible-test-units-amazon-aws-python36 SUCCESS in 7m 46s
✔️ ansible-test-units-amazon-aws-python38 SUCCESS in 6m 38s
✔️ ansible-test-units-amazon-aws-python39 SUCCESS in 5m 44s
✔️ ansible-test-units-amazon-aws-python310 SUCCESS in 8m 45s
ansible-test-changelog FAILURE in 11m 08s
✔️ ansible-test-splitter SUCCESS in 13m 36s
integration-community.aws-1 TIMED_OUT in 1h 00m 37s
✔️ integration-community.aws-2 SUCCESS in 21m 29s
✔️ integration-community.aws-3 SUCCESS in 7m 58s
✔️ integration-community.aws-4 SUCCESS in 39m 14s
✔️ integration-community.aws-5 SUCCESS in 5m 46s
✔️ integration-community.aws-6 SUCCESS in 25m 45s
✔️ integration-community.aws-7 SUCCESS in 22m 56s
✔️ integration-community.aws-8 SUCCESS in 45m 16s
✔️ integration-community.aws-9 SUCCESS in 24m 41s
integration-community.aws-10 RETRY_LIMIT in 1m 28s
✔️ integration-community.aws-11 SUCCESS in 22m 51s
✔️ integration-community.aws-12 SUCCESS in 19m 53s
✔️ integration-community.aws-13 SUCCESS in 28m 39s
✔️ integration-community.aws-14 SUCCESS in 22m 44s
integration-community.aws-15 FAILURE in 32m 09s
integration-community.aws-16 RETRY_LIMIT in 1m 27s
✔️ integration-community.aws-17 SUCCESS in 25m 21s
✔️ integration-community.aws-18 SUCCESS in 39m 43s
integration-community.aws-19 FAILURE in 10m 47s
✔️ integration-community.aws-20 SUCCESS in 16m 56s
✔️ integration-community.aws-21 SUCCESS in 13m 07s
Skipped 1 job

@tremble tremble changed the title Cleanup/headers 20230306 Cleanup headers and imports Mar 7, 2023
@softwarefactory-project-zuul
Copy link
Contributor

Build failed.
https://ansible.softwarefactory-project.io/zuul/buildset/377cc5eb992f451d98ca3b6b16f360f7

✔️ ansible-galaxy-importer SUCCESS in 4m 27s
✔️ build-ansible-collection SUCCESS in 23m 19s
✔️ ansible-test-sanity-docker-devel SUCCESS in 12m 49s (non-voting)
✔️ ansible-test-sanity-docker-milestone SUCCESS in 12m 03s (non-voting)
✔️ ansible-test-sanity-docker-stable-2.12 SUCCESS in 11m 04s
✔️ ansible-test-sanity-docker-stable-2.13 SUCCESS in 9m 51s
✔️ ansible-test-sanity-docker-stable-2.14 SUCCESS in 11m 28s
✔️ ansible-test-units-amazon-aws-python36 SUCCESS in 8m 02s
✔️ ansible-test-units-amazon-aws-python38 SUCCESS in 7m 47s
✔️ ansible-test-units-amazon-aws-python39 SUCCESS in 7m 29s
✔️ ansible-test-units-amazon-aws-python310 SUCCESS in 8m 22s
✔️ ansible-test-changelog SUCCESS in 9m 26s
✔️ ansible-test-splitter SUCCESS in 10m 17s
✔️ integration-community.aws-1 SUCCESS in 40m 04s
✔️ integration-community.aws-2 SUCCESS in 24m 13s
✔️ integration-community.aws-3 SUCCESS in 9m 09s
✔️ integration-community.aws-4 SUCCESS in 45m 02s
✔️ integration-community.aws-5 SUCCESS in 24m 14s
✔️ integration-community.aws-6 SUCCESS in 29m 31s
✔️ integration-community.aws-7 SUCCESS in 24m 44s
✔️ integration-community.aws-8 SUCCESS in 44m 26s
✔️ integration-community.aws-9 SUCCESS in 26m 18s
✔️ integration-community.aws-10 SUCCESS in 27m 19s
✔️ integration-community.aws-11 SUCCESS in 22m 34s
✔️ integration-community.aws-12 SUCCESS in 20m 04s
✔️ integration-community.aws-13 SUCCESS in 28m 39s
✔️ integration-community.aws-14 SUCCESS in 21m 24s
✔️ integration-community.aws-15 SUCCESS in 26m 33s
✔️ integration-community.aws-16 SUCCESS in 54m 08s
✔️ integration-community.aws-17 SUCCESS in 24m 50s
✔️ integration-community.aws-18 SUCCESS in 39m 13s
integration-community.aws-19 FAILURE in 8m 21s
✔️ integration-community.aws-20 SUCCESS in 18m 34s
✔️ integration-community.aws-21 SUCCESS in 14m 10s
Skipped 1 job

@tremble
Copy link
Contributor Author

tremble commented Mar 7, 2023

recheck

@tremble tremble marked this pull request as ready for review March 7, 2023 13:47
@tremble tremble requested a review from alinabuzachis March 7, 2023 13:48
@softwarefactory-project-zuul
Copy link
Contributor

Build failed.
https://ansible.softwarefactory-project.io/zuul/buildset/41d1a209e86d4aab8fc7916c6ef2b2fe

ansible-galaxy-importer FAILURE in 3m 52s
✔️ build-ansible-collection SUCCESS in 26m 29s
✔️ ansible-test-sanity-docker-devel SUCCESS in 12m 26s (non-voting)
✔️ ansible-test-sanity-docker-milestone SUCCESS in 10m 15s (non-voting)
✔️ ansible-test-sanity-docker-stable-2.12 SUCCESS in 11m 54s
✔️ ansible-test-sanity-docker-stable-2.13 SUCCESS in 8m 41s
✔️ ansible-test-sanity-docker-stable-2.14 SUCCESS in 10m 17s
✔️ ansible-test-units-amazon-aws-python36 SUCCESS in 8m 44s
✔️ ansible-test-units-amazon-aws-python38 SUCCESS in 5m 41s
✔️ ansible-test-units-amazon-aws-python39 SUCCESS in 5m 58s
✔️ ansible-test-units-amazon-aws-python310 SUCCESS in 8m 55s
✔️ ansible-test-changelog SUCCESS in 9m 39s
✔️ ansible-test-splitter SUCCESS in 10m 28s
✔️ integration-community.aws-1 SUCCESS in 30m 30s
✔️ integration-community.aws-2 SUCCESS in 26m 21s
✔️ integration-community.aws-3 SUCCESS in 7m 18s
✔️ integration-community.aws-4 SUCCESS in 47m 16s
✔️ integration-community.aws-5 SUCCESS in 20m 36s
✔️ integration-community.aws-6 SUCCESS in 27m 13s
✔️ integration-community.aws-7 SUCCESS in 21m 44s
✔️ integration-community.aws-8 SUCCESS in 41m 41s
✔️ integration-community.aws-9 SUCCESS in 25m 42s
✔️ integration-community.aws-10 SUCCESS in 30m 25s
✔️ integration-community.aws-11 SUCCESS in 20m 29s
✔️ integration-community.aws-12 SUCCESS in 21m 59s
✔️ integration-community.aws-13 SUCCESS in 30m 41s
✔️ integration-community.aws-14 SUCCESS in 21m 06s
✔️ integration-community.aws-15 SUCCESS in 31m 29s
✔️ integration-community.aws-16 SUCCESS in 45m 48s
✔️ integration-community.aws-17 SUCCESS in 24m 28s
✔️ integration-community.aws-18 SUCCESS in 43m 21s
✔️ integration-community.aws-19 SUCCESS in 9m 53s
✔️ integration-community.aws-20 SUCCESS in 17m 56s
✔️ integration-community.aws-21 SUCCESS in 14m 32s
Skipped 1 job

@tremble tremble added the mergeit Merge the PR (SoftwareFactory) label Mar 8, 2023
@softwarefactory-project-zuul
Copy link
Contributor

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

✔️ ansible-galaxy-importer SUCCESS in 4m 54s
✔️ build-ansible-collection SUCCESS in 22m 47s
✔️ ansible-test-sanity-docker-devel SUCCESS in 13m 50s (non-voting)
✔️ ansible-test-sanity-docker-milestone SUCCESS in 13m 43s (non-voting)
✔️ ansible-test-sanity-docker-stable-2.12 SUCCESS in 13m 58s
✔️ ansible-test-sanity-docker-stable-2.13 SUCCESS in 15m 00s
✔️ ansible-test-sanity-docker-stable-2.14 SUCCESS in 13m 47s
✔️ ansible-test-units-amazon-aws-python36 SUCCESS in 6m 17s
✔️ ansible-test-units-amazon-aws-python38 SUCCESS in 8m 25s
✔️ ansible-test-units-amazon-aws-python39 SUCCESS in 6m 29s
✔️ ansible-test-units-amazon-aws-python310 SUCCESS in 9m 28s
✔️ ansible-test-changelog SUCCESS in 8m 08s
✔️ ansible-test-splitter SUCCESS in 9m 25s
✔️ integration-community.aws-1 SUCCESS in 29m 51s
✔️ integration-community.aws-2 SUCCESS in 25m 35s
✔️ integration-community.aws-3 SUCCESS in 5m 53s
✔️ integration-community.aws-4 SUCCESS in 42m 47s
✔️ integration-community.aws-5 SUCCESS in 6m 31s
✔️ integration-community.aws-6 SUCCESS in 25m 16s
✔️ integration-community.aws-7 SUCCESS in 31m 12s
✔️ integration-community.aws-8 SUCCESS in 45m 13s
✔️ integration-community.aws-9 SUCCESS in 24m 06s
✔️ integration-community.aws-10 SUCCESS in 28m 09s
✔️ integration-community.aws-11 SUCCESS in 31m 32s
✔️ integration-community.aws-12 SUCCESS in 25m 06s
✔️ integration-community.aws-13 SUCCESS in 26m 30s
✔️ integration-community.aws-14 SUCCESS in 27m 25s
✔️ integration-community.aws-15 SUCCESS in 36m 57s
✔️ integration-community.aws-16 SUCCESS in 47m 12s
✔️ integration-community.aws-17 SUCCESS in 36m 37s
✔️ integration-community.aws-18 SUCCESS in 46m 49s
✔️ integration-community.aws-19 SUCCESS in 17m 43s
✔️ integration-community.aws-20 SUCCESS in 26m 49s
✔️ integration-community.aws-21 SUCCESS in 22m 56s
Skipped 1 job

@softwarefactory-project-zuul softwarefactory-project-zuul bot merged commit a4f20bf into ansible-collections:main Mar 8, 2023
@tremble tremble deleted the cleanup/headers-20230306 branch September 29, 2023 08:27
abikouo pushed a commit to abikouo/community.aws that referenced this pull request Oct 24, 2023
Cleanup headers and imports

SUMMARY
Mass update of imports, docs fragments and file headers

Many of the amazon.aws module_utils and docs fragments got moved about, update community.aws to reflect this.
Consistently apply the comment headers as documented at https://docs.ansible.com/ansible/devel/dev_guide/developing_modules_documenting.html#python-shebang-utf-8-coding

ISSUE TYPE

Docs Pull Request
Feature Pull Request

COMPONENT NAME
ADDITIONAL INFORMATION
Header cleanup based upon:
https://docs.ansible.com/ansible/devel/dev_guide/developing_modules_documenting.html#python-shebang-utf-8-coding

Begin your Ansible module with #!/usr/bin/python - this “shebang” allows ansible_python_interpreter to work. Follow the shebang immediately with # -*- coding: utf-8 -*- to clarify that the file is UTF-8 encoded.

and
https://docs.ansible.com/ansible/devel/dev_guide/developing_modules_documenting.html#copyright-and-license

After the shebang and UTF-8 coding, add a copyright line with the original copyright holder and a license declaration. The license declaration should be ONLY one line, not the full GPL prefix.
...
Additions to the module (for instance, rewrites) are not permitted to add additional copyright lines other than the default copyright statement if missing:

Reviewed-by: Alina Buzachis

This commit was initially merged in https://github.com/ansible-collections/community.aws
See: ansible-collections@a4f20bf
abikouo pushed a commit to abikouo/community.aws that referenced this pull request Oct 24, 2023
Cleanup headers and imports

SUMMARY
Mass update of imports, docs fragments and file headers

Many of the amazon.aws module_utils and docs fragments got moved about, update community.aws to reflect this.
Consistently apply the comment headers as documented at https://docs.ansible.com/ansible/devel/dev_guide/developing_modules_documenting.html#python-shebang-utf-8-coding

ISSUE TYPE

Docs Pull Request
Feature Pull Request

COMPONENT NAME
ADDITIONAL INFORMATION
Header cleanup based upon:
https://docs.ansible.com/ansible/devel/dev_guide/developing_modules_documenting.html#python-shebang-utf-8-coding

Begin your Ansible module with #!/usr/bin/python - this “shebang” allows ansible_python_interpreter to work. Follow the shebang immediately with # -*- coding: utf-8 -*- to clarify that the file is UTF-8 encoded.

and
https://docs.ansible.com/ansible/devel/dev_guide/developing_modules_documenting.html#copyright-and-license

After the shebang and UTF-8 coding, add a copyright line with the original copyright holder and a license declaration. The license declaration should be ONLY one line, not the full GPL prefix.
...
Additions to the module (for instance, rewrites) are not permitted to add additional copyright lines other than the default copyright statement if missing:

Reviewed-by: Alina Buzachis

This commit was initially merged in https://github.com/ansible-collections/community.aws
See: ansible-collections@a4f20bf
abikouo pushed a commit to abikouo/community.aws that referenced this pull request Oct 24, 2023
Cleanup headers and imports

SUMMARY
Mass update of imports, docs fragments and file headers

Many of the amazon.aws module_utils and docs fragments got moved about, update community.aws to reflect this.
Consistently apply the comment headers as documented at https://docs.ansible.com/ansible/devel/dev_guide/developing_modules_documenting.html#python-shebang-utf-8-coding

ISSUE TYPE

Docs Pull Request
Feature Pull Request

COMPONENT NAME
ADDITIONAL INFORMATION
Header cleanup based upon:
https://docs.ansible.com/ansible/devel/dev_guide/developing_modules_documenting.html#python-shebang-utf-8-coding

Begin your Ansible module with #!/usr/bin/python - this “shebang” allows ansible_python_interpreter to work. Follow the shebang immediately with # -*- coding: utf-8 -*- to clarify that the file is UTF-8 encoded.

and
https://docs.ansible.com/ansible/devel/dev_guide/developing_modules_documenting.html#copyright-and-license

After the shebang and UTF-8 coding, add a copyright line with the original copyright holder and a license declaration. The license declaration should be ONLY one line, not the full GPL prefix.
...
Additions to the module (for instance, rewrites) are not permitted to add additional copyright lines other than the default copyright statement if missing:

Reviewed-by: Alina Buzachis

This commit was initially merged in https://github.com/ansible-collections/community.aws
See: ansible-collections@a4f20bf
abikouo pushed a commit to abikouo/community.aws that referenced this pull request Oct 24, 2023
Cleanup headers and imports

SUMMARY
Mass update of imports, docs fragments and file headers

Many of the amazon.aws module_utils and docs fragments got moved about, update community.aws to reflect this.
Consistently apply the comment headers as documented at https://docs.ansible.com/ansible/devel/dev_guide/developing_modules_documenting.html#python-shebang-utf-8-coding

ISSUE TYPE

Docs Pull Request
Feature Pull Request

COMPONENT NAME
ADDITIONAL INFORMATION
Header cleanup based upon:
https://docs.ansible.com/ansible/devel/dev_guide/developing_modules_documenting.html#python-shebang-utf-8-coding

Begin your Ansible module with #!/usr/bin/python - this “shebang” allows ansible_python_interpreter to work. Follow the shebang immediately with # -*- coding: utf-8 -*- to clarify that the file is UTF-8 encoded.

and
https://docs.ansible.com/ansible/devel/dev_guide/developing_modules_documenting.html#copyright-and-license

After the shebang and UTF-8 coding, add a copyright line with the original copyright holder and a license declaration. The license declaration should be ONLY one line, not the full GPL prefix.
...
Additions to the module (for instance, rewrites) are not permitted to add additional copyright lines other than the default copyright statement if missing:

Reviewed-by: Alina Buzachis

This commit was initially merged in https://github.com/ansible-collections/community.aws
See: ansible-collections@a4f20bf
abikouo pushed a commit to abikouo/community.aws that referenced this pull request Oct 24, 2023
Cleanup headers and imports

SUMMARY
Mass update of imports, docs fragments and file headers

Many of the amazon.aws module_utils and docs fragments got moved about, update community.aws to reflect this.
Consistently apply the comment headers as documented at https://docs.ansible.com/ansible/devel/dev_guide/developing_modules_documenting.html#python-shebang-utf-8-coding

ISSUE TYPE

Docs Pull Request
Feature Pull Request

COMPONENT NAME
ADDITIONAL INFORMATION
Header cleanup based upon:
https://docs.ansible.com/ansible/devel/dev_guide/developing_modules_documenting.html#python-shebang-utf-8-coding

Begin your Ansible module with #!/usr/bin/python - this “shebang” allows ansible_python_interpreter to work. Follow the shebang immediately with # -*- coding: utf-8 -*- to clarify that the file is UTF-8 encoded.

and
https://docs.ansible.com/ansible/devel/dev_guide/developing_modules_documenting.html#copyright-and-license

After the shebang and UTF-8 coding, add a copyright line with the original copyright holder and a license declaration. The license declaration should be ONLY one line, not the full GPL prefix.
...
Additions to the module (for instance, rewrites) are not permitted to add additional copyright lines other than the default copyright statement if missing:

Reviewed-by: Alina Buzachis

This commit was initially merged in https://github.com/ansible-collections/community.aws
See: ansible-collections@a4f20bf
abikouo pushed a commit to abikouo/community.aws that referenced this pull request Oct 24, 2023
Cleanup headers and imports

SUMMARY
Mass update of imports, docs fragments and file headers

Many of the amazon.aws module_utils and docs fragments got moved about, update community.aws to reflect this.
Consistently apply the comment headers as documented at https://docs.ansible.com/ansible/devel/dev_guide/developing_modules_documenting.html#python-shebang-utf-8-coding

ISSUE TYPE

Docs Pull Request
Feature Pull Request

COMPONENT NAME
ADDITIONAL INFORMATION
Header cleanup based upon:
https://docs.ansible.com/ansible/devel/dev_guide/developing_modules_documenting.html#python-shebang-utf-8-coding

Begin your Ansible module with #!/usr/bin/python - this “shebang” allows ansible_python_interpreter to work. Follow the shebang immediately with # -*- coding: utf-8 -*- to clarify that the file is UTF-8 encoded.

and
https://docs.ansible.com/ansible/devel/dev_guide/developing_modules_documenting.html#copyright-and-license

After the shebang and UTF-8 coding, add a copyright line with the original copyright holder and a license declaration. The license declaration should be ONLY one line, not the full GPL prefix.
...
Additions to the module (for instance, rewrites) are not permitted to add additional copyright lines other than the default copyright statement if missing:

Reviewed-by: Alina Buzachis

This commit was initially merged in https://github.com/ansible-collections/community.aws
See: ansible-collections@a4f20bf
abikouo pushed a commit to abikouo/community.aws that referenced this pull request Oct 24, 2023
Cleanup headers and imports

SUMMARY
Mass update of imports, docs fragments and file headers

Many of the amazon.aws module_utils and docs fragments got moved about, update community.aws to reflect this.
Consistently apply the comment headers as documented at https://docs.ansible.com/ansible/devel/dev_guide/developing_modules_documenting.html#python-shebang-utf-8-coding

ISSUE TYPE

Docs Pull Request
Feature Pull Request

COMPONENT NAME
ADDITIONAL INFORMATION
Header cleanup based upon:
https://docs.ansible.com/ansible/devel/dev_guide/developing_modules_documenting.html#python-shebang-utf-8-coding

Begin your Ansible module with #!/usr/bin/python - this “shebang” allows ansible_python_interpreter to work. Follow the shebang immediately with # -*- coding: utf-8 -*- to clarify that the file is UTF-8 encoded.

and
https://docs.ansible.com/ansible/devel/dev_guide/developing_modules_documenting.html#copyright-and-license

After the shebang and UTF-8 coding, add a copyright line with the original copyright holder and a license declaration. The license declaration should be ONLY one line, not the full GPL prefix.
...
Additions to the module (for instance, rewrites) are not permitted to add additional copyright lines other than the default copyright statement if missing:

Reviewed-by: Alina Buzachis

This commit was initially merged in https://github.com/ansible-collections/community.aws
See: ansible-collections@a4f20bf
abikouo pushed a commit to abikouo/community.aws that referenced this pull request Oct 24, 2023
Cleanup headers and imports

SUMMARY
Mass update of imports, docs fragments and file headers

Many of the amazon.aws module_utils and docs fragments got moved about, update community.aws to reflect this.
Consistently apply the comment headers as documented at https://docs.ansible.com/ansible/devel/dev_guide/developing_modules_documenting.html#python-shebang-utf-8-coding

ISSUE TYPE

Docs Pull Request
Feature Pull Request

COMPONENT NAME
ADDITIONAL INFORMATION
Header cleanup based upon:
https://docs.ansible.com/ansible/devel/dev_guide/developing_modules_documenting.html#python-shebang-utf-8-coding

Begin your Ansible module with #!/usr/bin/python - this “shebang” allows ansible_python_interpreter to work. Follow the shebang immediately with # -*- coding: utf-8 -*- to clarify that the file is UTF-8 encoded.

and
https://docs.ansible.com/ansible/devel/dev_guide/developing_modules_documenting.html#copyright-and-license

After the shebang and UTF-8 coding, add a copyright line with the original copyright holder and a license declaration. The license declaration should be ONLY one line, not the full GPL prefix.
...
Additions to the module (for instance, rewrites) are not permitted to add additional copyright lines other than the default copyright statement if missing:

Reviewed-by: Alina Buzachis

This commit was initially merged in https://github.com/ansible-collections/community.aws
See: ansible-collections@a4f20bf
abikouo pushed a commit to abikouo/community.aws that referenced this pull request Oct 24, 2023
Cleanup headers and imports

SUMMARY
Mass update of imports, docs fragments and file headers

Many of the amazon.aws module_utils and docs fragments got moved about, update community.aws to reflect this.
Consistently apply the comment headers as documented at https://docs.ansible.com/ansible/devel/dev_guide/developing_modules_documenting.html#python-shebang-utf-8-coding

ISSUE TYPE

Docs Pull Request
Feature Pull Request

COMPONENT NAME
ADDITIONAL INFORMATION
Header cleanup based upon:
https://docs.ansible.com/ansible/devel/dev_guide/developing_modules_documenting.html#python-shebang-utf-8-coding

Begin your Ansible module with #!/usr/bin/python - this “shebang” allows ansible_python_interpreter to work. Follow the shebang immediately with # -*- coding: utf-8 -*- to clarify that the file is UTF-8 encoded.

and
https://docs.ansible.com/ansible/devel/dev_guide/developing_modules_documenting.html#copyright-and-license

After the shebang and UTF-8 coding, add a copyright line with the original copyright holder and a license declaration. The license declaration should be ONLY one line, not the full GPL prefix.
...
Additions to the module (for instance, rewrites) are not permitted to add additional copyright lines other than the default copyright statement if missing:

Reviewed-by: Alina Buzachis

This commit was initially merged in https://github.com/ansible-collections/community.aws
See: ansible-collections@a4f20bf
abikouo pushed a commit to abikouo/community.aws that referenced this pull request Oct 24, 2023
Cleanup headers and imports

SUMMARY
Mass update of imports, docs fragments and file headers

Many of the amazon.aws module_utils and docs fragments got moved about, update community.aws to reflect this.
Consistently apply the comment headers as documented at https://docs.ansible.com/ansible/devel/dev_guide/developing_modules_documenting.html#python-shebang-utf-8-coding

ISSUE TYPE

Docs Pull Request
Feature Pull Request

COMPONENT NAME
ADDITIONAL INFORMATION
Header cleanup based upon:
https://docs.ansible.com/ansible/devel/dev_guide/developing_modules_documenting.html#python-shebang-utf-8-coding

Begin your Ansible module with #!/usr/bin/python - this “shebang” allows ansible_python_interpreter to work. Follow the shebang immediately with # -*- coding: utf-8 -*- to clarify that the file is UTF-8 encoded.

and
https://docs.ansible.com/ansible/devel/dev_guide/developing_modules_documenting.html#copyright-and-license

After the shebang and UTF-8 coding, add a copyright line with the original copyright holder and a license declaration. The license declaration should be ONLY one line, not the full GPL prefix.
...
Additions to the module (for instance, rewrites) are not permitted to add additional copyright lines other than the default copyright statement if missing:

Reviewed-by: Alina Buzachis

This commit was initially merged in https://github.com/ansible-collections/community.aws
See: ansible-collections@a4f20bf
abikouo pushed a commit to abikouo/community.aws that referenced this pull request Oct 24, 2023
Cleanup headers and imports

SUMMARY
Mass update of imports, docs fragments and file headers

Many of the amazon.aws module_utils and docs fragments got moved about, update community.aws to reflect this.
Consistently apply the comment headers as documented at https://docs.ansible.com/ansible/devel/dev_guide/developing_modules_documenting.html#python-shebang-utf-8-coding

ISSUE TYPE

Docs Pull Request
Feature Pull Request

COMPONENT NAME
ADDITIONAL INFORMATION
Header cleanup based upon:
https://docs.ansible.com/ansible/devel/dev_guide/developing_modules_documenting.html#python-shebang-utf-8-coding

Begin your Ansible module with #!/usr/bin/python - this “shebang” allows ansible_python_interpreter to work. Follow the shebang immediately with # -*- coding: utf-8 -*- to clarify that the file is UTF-8 encoded.

and
https://docs.ansible.com/ansible/devel/dev_guide/developing_modules_documenting.html#copyright-and-license

After the shebang and UTF-8 coding, add a copyright line with the original copyright holder and a license declaration. The license declaration should be ONLY one line, not the full GPL prefix.
...
Additions to the module (for instance, rewrites) are not permitted to add additional copyright lines other than the default copyright statement if missing:

Reviewed-by: Alina Buzachis

This commit was initially merged in https://github.com/ansible-collections/community.aws
See: ansible-collections@a4f20bf
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.

2 participants