Rename CodeBuild/CodeCommit/CodePipeline modules (#1308)

Rename CodeBuild/CodeCommit/CodePipeline modules

SUMMARY
In line with the new naming guidelines renames the CodeBuild/CodeCommit/CodePipeline modules
ISSUE TYPE

Feature Pull Request

COMPONENT NAME
plugins/modules/aws_codebuild.py
plugins/modules/aws_codecommit.py
plugins/modules/aws_codepipeline.py
plugins/modules/codebuild_project.py
plugins/modules/codecommit_repository.py
plugins/modules/codepipeline.py
ADDITIONAL INFORMATION

Reviewed-by: Alina Buzachis <None>

README.md

@@ -47,9 +47,6 @@ Name | Description
 [community.aws.autoscaling_policy](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.autoscaling_policy_module.rst)|Create or delete AWS scaling policies for Autoscaling groups
 [community.aws.autoscaling_scheduled_action](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.autoscaling_scheduled_action_module.rst)|Create, modify and delete ASG scheduled scaling actions
 [community.aws.aws_application_scaling_policy](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.aws_application_scaling_policy_module.rst)|Manage Application Auto Scaling Scaling Policies
-[community.aws.aws_codebuild](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.aws_codebuild_module.rst)|Create or delete an AWS CodeBuild project
-[community.aws.aws_codecommit](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.aws_codecommit_module.rst)|Manage repositories in AWS CodeCommit
-[community.aws.aws_codepipeline](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.aws_codepipeline_module.rst)|Create or delete AWS CodePipelines
 [community.aws.aws_elasticbeanstalk_app](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.aws_elasticbeanstalk_app_module.rst)|Create, update, and delete an elastic beanstalk application
 [community.aws.aws_inspector_target](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.aws_inspector_target_module.rst)|Create, Update and Delete Amazon Inspector Assessment Targets
 [community.aws.aws_msk_cluster](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.aws_msk_cluster_module.rst)|Manage Amazon MSK clusters
@@ -75,6 +72,9 @@ Name | Description
 [community.aws.cloudwatchlogs_log_group](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.cloudwatchlogs_log_group_module.rst)|create or delete log_group in CloudWatchLogs
 [community.aws.cloudwatchlogs_log_group_info](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.cloudwatchlogs_log_group_info_module.rst)|Get information about log_group in CloudWatchLogs
 [community.aws.cloudwatchlogs_log_group_metric_filter](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.cloudwatchlogs_log_group_metric_filter_module.rst)|Manage CloudWatch log group metric filter
+[community.aws.codebuild_project](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.codebuild_project_module.rst)|Create or delete an AWS CodeBuild project
+[community.aws.codecommit_repository](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.codecommit_repository_module.rst)|Manage repositories in AWS CodeCommit
+[community.aws.codepipeline](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.codepipeline_module.rst)|Create or delete AWS CodePipelines
 [community.aws.config_aggregation_authorization](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.config_aggregation_authorization_module.rst)|Manage cross-account AWS Config authorizations
 [community.aws.config_aggregator](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.config_aggregator_module.rst)|Manage AWS Config aggregations across multiple accounts
 [community.aws.config_delivery_channel](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.config_delivery_channel_module.rst)|Manage AWS Config delivery channels

changelogs/fragments/1308-rename-code.yml

@@ -0,0 +1,4 @@
+minor_changes:
+- aws_codebuild - the ``aws_codebuild`` module has been renamed to ``codebuild_project``, ``aws_codebuild`` remains as an alias (https://github.com/ansible-collections/community.aws/pull/1308).
+- aws_codecommit - the ``aws_codecommit`` module has been renamed to ``codecommit_repository``, ``aws_codecommit`` remains as an alias (https://github.com/ansible-collections/community.aws/pull/1308).
+- aws_codepipeline - the ``aws_codepipeline`` module has been renamed to ``codepipeline``, ``aws_codepipeline`` remains as an alias (https://github.com/ansible-collections/community.aws/pull/1308).

docs/community.aws.aws_codebuild_module.rst → docs/community.aws.codebuild_project_module.rst

@@ -1,9 +1,9 @@
-.. _community.aws.aws_codebuild_module:
+.. _community.aws.codebuild_project_module:
 
 
-***************************
-community.aws.aws_codebuild
-***************************
+*******************************
+community.aws.codebuild_project
+*******************************
 
 **Create or delete an AWS CodeBuild project**
 
@@ -18,6 +18,7 @@ Version added: 1.0.0
 Synopsis
 --------
 - Create or delete a CodeBuild projects on AWS, used for building code artifacts from source code.
+- Prior to release 5.0.0 this module was called ``community.aws.aws_codebuild``. The usage did not change.
 
 
 
@@ -70,7 +71,7 @@ Parameters
                 <td>
                 </td>
                 <td>
-                        <div>Information about the build output artifact location. When choosing type S3, set the bucket name here.</div>
+                        <div>Information about the build output artifact location. When choosing <em>type</em> <code>S3</code>, set the bucket name here.</div>
                 </td>
             </tr>
             <tr>
@@ -419,7 +420,8 @@ Parameters
                 <td>
                 </td>
                 <td>
-                        <div>Enables running the Docker daemon inside a Docker container. Set to true only if the build project is be used to build Docker images.</div>
+                        <div>Enables running the Docker daemon inside a Docker container.</div>
+                        <div>Set to <code>true</code> only if the build project is be used to build Docker images.</div>
                 </td>
             </tr>
             <tr>
@@ -588,7 +590,7 @@ Parameters
                 <td>
                 </td>
                 <td>
-                        <div>The build spec declaration to use for the builds in this build project. Leave empty if part of the code project.</div>
+                        <div>The build spec declaration to use for the builds in this build project. Leave empty if part of the CodeBuild project.</div>
                 </td>
             </tr>
             <tr>
@@ -640,7 +642,7 @@ Parameters
                 <td>
                 </td>
                 <td>
-                        <div>Information about the location of the source code to be built. For type CODEPIPELINE location should not be specified.</div>
+                        <div>Information about the location of the source code to be built. For <em>type</em> <code>CODEPIPELINE</code> location should not be specified.</div>
                 </td>
             </tr>
             <tr>
@@ -677,7 +679,7 @@ Parameters
                         </ul>
                 </td>
                 <td>
-                        <div>Create or remove code build project.</div>
+                        <div>Create or remove CodeBuild project.</div>
                 </td>
             </tr>
             <tr>
@@ -803,7 +805,7 @@ Examples
 
     # Note: These examples do not set authentication details, see the AWS Guide for details.
 
-    - community.aws.aws_codebuild:
+    - community.aws.codebuild_project:
         name: my_project
         description: My nice little project
         service_role: "arn:aws:iam::123123:role/service-role/code-build-service-role"
@@ -868,7 +870,7 @@ Common return values are documented `here <https://docs.ansible.com/ansible/late
                 </td>
                 <td>always</td>
                 <td>
-                            <div>ARN of the CodeBuild project</div>
+                            <div>ARN of the CodeBuild project.</div>
                     <br/>
                         <div style="font-size: smaller"><b>Sample:</b></div>
                         <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">arn:aws:codebuild:us-east-1:123123123:project/vod-api-app-builder</div>
@@ -903,7 +905,7 @@ Common return values are documented `here <https://docs.ansible.com/ansible/late
                 </td>
                 <td>when configured</td>
                 <td>
-                            <div>Output location for build artifacts</div>
+                            <div>Output location for build artifacts.</div>
                     <br/>
                 </td>
             </tr>
@@ -955,7 +957,7 @@ Common return values are documented `here <https://docs.ansible.com/ansible/late
                 </td>
                 <td>always</td>
                 <td>
-                            <div>Timestamp of the create time of the project</div>
+                            <div>Timestamp of the create time of the project.</div>
                     <br/>
                         <div style="font-size: smaller"><b>Sample:</b></div>
                         <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">2018-04-17T16:56:03.245000+02:00</div>
@@ -973,7 +975,7 @@ Common return values are documented `here <https://docs.ansible.com/ansible/late
                 </td>
                 <td>always</td>
                 <td>
-                            <div>A description of the build project</div>
+                            <div>A description of the CodeBuild project.</div>
                     <br/>
                         <div style="font-size: smaller"><b>Sample:</b></div>
                         <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">My nice little project</div>
@@ -991,7 +993,7 @@ Common return values are documented `here <https://docs.ansible.com/ansible/late
                 </td>
                 <td>always</td>
                 <td>
-                            <div>Environment settings for the build</div>
+                            <div>Environment settings for the build.</div>
                     <br/>
                 </td>
             </tr>
@@ -1007,7 +1009,7 @@ Common return values are documented `here <https://docs.ansible.com/ansible/late
                 </td>
                 <td>always</td>
                 <td>
-                            <div>Name of the CodeBuild project</div>
+                            <div>Name of the CodeBuild project.</div>
                     <br/>
                         <div style="font-size: smaller"><b>Sample:</b></div>
                         <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">my_project</div>
@@ -1112,7 +1114,7 @@ Common return values are documented `here <https://docs.ansible.com/ansible/late
                 </td>
                 <td>when configured</td>
                 <td>
-                            <div>The git clone depth</div>
+                            <div>The git clone depth.</div>
                     <br/>
                 </td>
             </tr>
@@ -1163,7 +1165,7 @@ Common return values are documented `here <https://docs.ansible.com/ansible/late
                 </td>
                 <td>always</td>
                 <td>
-                            <div>The type of the repository</div>
+                            <div>The type of the repository.</div>
                     <br/>
                         <div style="font-size: smaller"><b>Sample:</b></div>
                         <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">CODEPIPELINE</div>
@@ -1199,7 +1201,7 @@ Common return values are documented `here <https://docs.ansible.com/ansible/late
                 </td>
                 <td>always</td>
                 <td>
-                            <div>The timeout of a build in minutes</div>
+                            <div>The timeout of a build in minutes.</div>
                     <br/>
                         <div style="font-size: smaller"><b>Sample:</b></div>
                         <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">60</div>

docs/community.aws.aws_codecommit_module.rst → docs/community.aws.codecommit_repository_module.rst

@@ -1,9 +1,9 @@
-.. _community.aws.aws_codecommit_module:
+.. _community.aws.codecommit_repository_module:
 
 
-****************************
-community.aws.aws_codecommit
-****************************
+***********************************
+community.aws.codecommit_repository
+***********************************
 
 **Manage repositories in AWS CodeCommit**
 
@@ -19,6 +19,7 @@ Synopsis
 --------
 - Supports creation and deletion of CodeCommit repositories.
 - See https://aws.amazon.com/codecommit/ for more information about CodeCommit.
+- Prior to release 5.0.0 this module was called ``community.aws.aws_codecommit``. The usage did not change.
 
 
 
@@ -139,7 +140,7 @@ Parameters
                 <td>
                 </td>
                 <td>
-                        <div>description or comment of repository.</div>
+                        <div>Description or comment of repository.</div>
                         <div style="font-size: small; color: darkgreen"><br/>aliases: comment</div>
                 </td>
             </tr>
@@ -172,7 +173,7 @@ Parameters
                 <td>
                 </td>
                 <td>
-                        <div>name of repository.</div>
+                        <div>Name of repository.</div>
                 </td>
             </tr>
             <tr>
@@ -284,12 +285,12 @@ Examples
 .. code-block:: yaml
 
     # Create a new repository
-    - community.aws.aws_codecommit:
+    - community.aws.codecommit_repository:
         name: repo
         state: present
 
     # Delete a repository
-    - community.aws.aws_codecommit:
+    - community.aws.codecommit_repository:
         name: repo
         state: absent
 

docs/community.aws.aws_codepipeline_module.rst → docs/community.aws.codepipeline_module.rst

@@ -1,9 +1,9 @@
-.. _community.aws.aws_codepipeline_module:
+.. _community.aws.codepipeline_module:
 
 
-******************************
-community.aws.aws_codepipeline
-******************************
+**************************
+community.aws.codepipeline
+**************************
 
 **Create or delete AWS CodePipelines**
 
@@ -18,6 +18,7 @@ Version added: 1.0.0
 Synopsis
 --------
 - Create or delete a CodePipeline on AWS.
+- Prior to release 5.0.0 this module was called ``community.aws.aws_codepipeline``. The usage did not change.
 
 
 
@@ -204,7 +205,7 @@ Parameters
                 <td>
                 </td>
                 <td>
-                        <div>Name of the pipeline</div>
+                        <div>Name of the CodePipeline.</div>
                 </td>
             </tr>
             <tr>
@@ -252,7 +253,7 @@ Parameters
                 <td>
                 </td>
                 <td>
-                        <div>ARN of the IAM role to use when executing the pipeline</div>
+                        <div>ARN of the IAM role to use when executing the CodePipeline.</div>
                 </td>
             </tr>
             <tr>
@@ -322,7 +323,7 @@ Parameters
                 <td>
                 </td>
                 <td>
-                        <div>Name of the stage (step) in the codepipeline</div>
+                        <div>Name of the stage (step) in the CodePipeline.</div>
                 </td>
             </tr>
 
@@ -342,7 +343,7 @@ Parameters
                         </ul>
                 </td>
                 <td>
-                        <div>Create or remove code pipeline</div>
+                        <div>Create or remove CodePipeline.</div>
                 </td>
             </tr>
             <tr>
@@ -376,7 +377,7 @@ Parameters
                 <td>
                 </td>
                 <td>
-                        <div>Version number of the pipeline. This number is automatically incremented when a pipeline is updated.</div>
+                        <div>Version number of the CodePipeline. This number is automatically incremented when a CodePipeline is updated.</div>
                 </td>
             </tr>
     </table>
@@ -387,7 +388,7 @@ Notes
 -----
 
 .. note::
-   - for details of the parameters and returns see http://boto3.readthedocs.io/en/latest/reference/services/codepipeline.html
+   - For details of the parameters and returns see http://boto3.readthedocs.io/en/latest/reference/services/codepipeline.html.
    - If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence ``AWS_URL`` or ``EC2_URL``, ``AWS_PROFILE`` or ``AWS_DEFAULT_PROFILE``, ``AWS_ACCESS_KEY_ID`` or ``AWS_ACCESS_KEY`` or ``EC2_ACCESS_KEY``, ``AWS_SECRET_ACCESS_KEY`` or ``AWS_SECRET_KEY`` or ``EC2_SECRET_KEY``, ``AWS_SECURITY_TOKEN`` or ``EC2_SECURITY_TOKEN``, ``AWS_REGION`` or ``EC2_REGION``, ``AWS_CA_BUNDLE``
    - When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ``~/.aws/credentials``). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information.
    - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files.
@@ -491,7 +492,7 @@ Common return values are documented `here <https://docs.ansible.com/ansible/late
                 </td>
                 <td>success</td>
                 <td>
-                            <div>Returns the dictionary describing the code pipeline configuration.</div>
+                            <div>Returns the dictionary describing the CodePipeline configuration.</div>
                     <br/>
                 </td>
             </tr>
@@ -597,7 +598,7 @@ Common return values are documented `here <https://docs.ansible.com/ansible/late
                 </td>
                 <td>always</td>
                 <td>
-                            <div>ARN of the IAM role attached to the code pipeline</div>
+                            <div>ARN of the IAM role attached to the CodePipeline</div>
                     <br/>
                         <div style="font-size: smaller"><b>Sample:</b></div>
                         <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">arn:aws:iam::123123123:role/codepipeline-service-role</div>
@@ -615,7 +616,7 @@ Common return values are documented `here <https://docs.ansible.com/ansible/late
                 </td>
                 <td>always</td>
                 <td>
-                            <div>List of stages configured for this pipeline</div>
+                            <div>List of stages configured for this CodePipeline</div>
                     <br/>
                 </td>
             </tr>
@@ -631,7 +632,8 @@ Common return values are documented `here <https://docs.ansible.com/ansible/late
                 </td>
                 <td>always</td>
                 <td>
-                            <div>The version number of the pipeline. This number is auto incremented when pipeline params are changed.</div>
+                            <div>The version number of the CodePipeline.</div>
+                            <div>This number is auto incremented when CodePipeline params are changed.</div>
                     <br/>
                 </td>
             </tr>