Rename aws_elasticbeanstalk_app elasticbeanstalk_app (ansible-collect…

…ions#1307) Rename aws_elasticbeanstalk_app to elasticbeanstalk_app SUMMARY Drop the aws_ prefix from aws_elasticbeanstalk_app in line with the naming guidelines ISSUE TYPE Feature Pull Request COMPONENT NAME plugins/modules/aws_elasticbeanstalk_app.py plugins/modules/elasticbeanstalk_app.py ADDITIONAL INFORMATION Reviewed-by: Alina Buzachis <None>
abikouo · Jul 5, 2022 · 44f398a · 44f398a
1 parent 19c41d6
commit 44f398a
Show file tree

Hide file tree

Showing 8 changed files with 24 additions and 22 deletions.
diff --git a/README.md b/README.md
@@ -47,7 +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_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
 [community.aws.aws_msk_config](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.aws_msk_config_module.rst)|Manage Amazon MSK cluster configurations.
@@ -132,6 +131,7 @@ Name | Description
 [community.aws.elasticache_parameter_group](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.elasticache_parameter_group_module.rst)|Manage cache parameter groups in Amazon ElastiCache.
 [community.aws.elasticache_snapshot](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.elasticache_snapshot_module.rst)|Manage cache snapshots in Amazon ElastiCache
 [community.aws.elasticache_subnet_group](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.elasticache_subnet_group_module.rst)|manage ElastiCache subnet groups
+[community.aws.elasticbeanstalk_app](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.elasticbeanstalk_app_module.rst)|Create, update, and delete an Elastic Beanstalk application
 [community.aws.elb_application_lb](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.elb_application_lb_module.rst)|Manage an Application Load Balancer
 [community.aws.elb_application_lb_info](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.elb_application_lb_info_module.rst)|Gather information about Application Load Balancers in AWS
 [community.aws.elb_classic_lb_info](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.elb_classic_lb_info_module.rst)|Gather information about EC2 Elastic Load Balancers in AWS

diff --git a/...y.aws.aws_elasticbeanstalk_app_module.rst → ...unity.aws.elasticbeanstalk_app_module.rst b/...y.aws.aws_elasticbeanstalk_app_module.rst → ...unity.aws.elasticbeanstalk_app_module.rst
@@ -1,11 +1,11 @@
-.. _community.aws.aws_elasticbeanstalk_app_module:
+.. _community.aws.elasticbeanstalk_app_module:
 
 
-**************************************
-community.aws.aws_elasticbeanstalk_app
-**************************************
+**********************************
+community.aws.elasticbeanstalk_app
+**********************************
 
-**Create, update, and delete an elastic beanstalk application**
+**Create, update, and delete an Elastic Beanstalk application**
 
 
 Version added: 1.0.0
@@ -17,7 +17,7 @@ Version added: 1.0.0
 
 Synopsis
 --------
-- Creates, updates, deletes beanstalk applications if app_name is provided.
+- Creates, updates, deletes Elastic Beanstalk applications if *app_name* is provided.
 
 
 
@@ -53,7 +53,7 @@ Parameters
                 <td>
                 </td>
                 <td>
-                        <div>Name of the beanstalk application you wish to manage.</div>
+                        <div>Name of the Beanstalk application you wish to manage.</div>
                         <div style="font-size: small; color: darkgreen"><br/>aliases: name</div>
                 </td>
             </tr>
@@ -300,13 +300,13 @@ Examples
 .. code-block:: yaml
 
     # Create or update an application
-    - community.aws.aws_elasticbeanstalk_app:
+    - community.aws.elasticbeanstalk_app:
         app_name: Sample_App
         description: "Hello World App"
         state: present
 
     # Delete application
-    - community.aws.aws_elasticbeanstalk_app:
+    - community.aws.elasticbeanstalk_app:
         app_name: Sample_App
         state: absent
 

diff --git a/meta/runtime.yml b/meta/runtime.yml
@@ -144,6 +144,7 @@ action_groups:
   - eks_cluster
   - efs_tag
   - eks_fargate_profile
+  - elasticbeanstalk_app
   - elasticache
   - elasticache_info
   - elasticache_parameter_group
@@ -311,6 +312,9 @@ plugin_routing:
     aws_eks_cluster:
       # Deprecation for this alias should not *start* prior to 2024-09-01
       redirect: community.aws.eks_cluster
+    aws_elasticbeanstalk_app:
+      # Deprecation for this alias should not *start* prior to 2024-09-01
+      redirect: community.aws.elasticbeanstalk_app
     aws_glue_connection:
       # Deprecation for this alias should not *start* prior to 2024-09-01
       redirect: community.aws.glue_connection

diff --git a/plugins/modules/aws_elasticbeanstalk_app.py → plugins/modules/elasticbeanstalk_app.py b/plugins/modules/aws_elasticbeanstalk_app.py → plugins/modules/elasticbeanstalk_app.py
@@ -8,19 +8,18 @@
 
 DOCUMENTATION = '''
 ---
-module: aws_elasticbeanstalk_app
+module: elasticbeanstalk_app
 version_added: 1.0.0
 
-short_description: Create, update, and delete an elastic beanstalk application
-
+short_description: Create, update, and delete an Elastic Beanstalk application
 
 description:
-    - Creates, updates, deletes beanstalk applications if app_name is provided.
+  - Creates, updates, deletes Elastic Beanstalk applications if I(app_name) is provided.
 
 options:
   app_name:
     description:
-      - Name of the beanstalk application you wish to manage.
+      - Name of the Beanstalk application you wish to manage.
     aliases: [ 'name' ]
     type: str
   description:
@@ -39,23 +38,22 @@
     default: false
     type: bool
 author:
-    - Harpreet Singh (@hsingh)
-    - Stephen Granger (@viper233)
+  - Harpreet Singh (@hsingh)
+  - Stephen Granger (@viper233)
 extends_documentation_fragment:
-- amazon.aws.aws
-- amazon.aws.ec2
-
+  - amazon.aws.aws
+  - amazon.aws.ec2
 '''
 
 EXAMPLES = '''
 # Create or update an application
-- community.aws.aws_elasticbeanstalk_app:
+- community.aws.elasticbeanstalk_app:
     app_name: Sample_App
     description: "Hello World App"
     state: present
 
 # Delete application
-- community.aws.aws_elasticbeanstalk_app:
+- community.aws.elasticbeanstalk_app:
     app_name: Sample_App
     state: absent
 

diff --git a/.../targets/aws_elasticbeanstalk_app/aliases → ...tion/targets/elasticbeanstalk_app/aliases b/.../targets/aws_elasticbeanstalk_app/aliases → ...tion/targets/elasticbeanstalk_app/aliases
diff --git a/...ws_elasticbeanstalk_app/defaults/main.yml → ...ts/elasticbeanstalk_app/defaults/main.yml b/...ws_elasticbeanstalk_app/defaults/main.yml → ...ts/elasticbeanstalk_app/defaults/main.yml
diff --git a/...ts/aws_elasticbeanstalk_app/meta/main.yml → ...argets/elasticbeanstalk_app/meta/main.yml b/...ts/aws_elasticbeanstalk_app/meta/main.yml → ...argets/elasticbeanstalk_app/meta/main.yml
diff --git a/...s/aws_elasticbeanstalk_app/tasks/main.yml → ...rgets/elasticbeanstalk_app/tasks/main.yml b/...s/aws_elasticbeanstalk_app/tasks/main.yml → ...rgets/elasticbeanstalk_app/tasks/main.yml