From abe7f28f1c938d0b5f2c7c2231cd26bd2b5aeb92 Mon Sep 17 00:00:00 2001 From: Keith Manning Date: Sun, 2 Aug 2020 17:05:14 -0400 Subject: [PATCH 1/2] Realphabetize the Plugins in README --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 887cf6bb..23459380 100644 --- a/README.md +++ b/README.md @@ -93,10 +93,10 @@ validate.then(deployQa) The example above gives you a bare-bones pipeline, and there may be Jenkinsfile features that you'd like to take advantage of. Some of these features have been pre-defined as Plugins for this library. Pre-defined plugins can be enabled by simply calling their static `init()` method. ### Default Plugins +* [BuildWithParametersPlugin](./docs/BuildWithParametersPlugin.md): use this plugin to manage the "Build with Parameters" feature of pipelines. * [ConfirmApplyPlugin](./docs/ConfirmApplyPlugin.md): pause and review the plan, before applying any changes. * [ConditionalApplyPlugin](./docs/ConditionalApplyPlugin.md): only allow apply on master branch. * [DefaultEnvironmentPlugin](./docs/DefaultEnvironmentPlugin.md): automatically set `TF_VAR_environment` variable. -* [BuildWithParametersPlugin](./docs/BuildWithParametersPlugin.md): use this plugin to manage the "Build with Parameters" feature of pipelines. * [TerraformPlugin](./docs/TerraformPlugin.md): apply version-specific terraform behavior based on the version of terraform in use. ### Credentials and Configuration Management * [CredentialsPlugin](./docs/CredentialsPlugin.md): Inject Jenkins credentials into your stages. @@ -115,12 +115,12 @@ The example above gives you a bare-bones pipeline, and there may be Jenkinsfile * [AgentNodePlugin](./docs/AgentNodePlugin.md): Run your pipeline on agents that are configured with Docker. * [AnsiColorPlugin](./docs/AnsiColorPlugin.md): Enable ansi-color output. * [CrqPlugin](./docs/CrqPlugin.md): Use the manheim_remedier gem to open automated Change Requests. +* [DestroyPlugin](./docs/DestroyPlugin.md): Use this to change the pipeline functionality to `terraform destroy`. (Requires manual confirmation) * [GithubPRPlanPlugin](./docs/GithubPRPlanPlugin.md): Use this to post Terraform plan results in the comments of a Github PullRequest. +* [PlanOnlyPlugin](./docs/PlanOnlyPlugin.md): Use this to change the pipeline functionality to `terraform plan` only. * [TargetPlugin](./docs/TargetPlugin.md): set `-target` parameter for terraform plan and apply. * [TerraformDirectoryPlugin](./docs/TerraformDirectoryPlugin.md): Change the default directory containing your terraform code. * [TerraformLandscapePlugin](./docs/TerraformLandscapePlugin.md): Enable terraform-landscape plan output. -* [DestroyPlugin](./docs/DestroyPlugin.md): Use this to change the pipeline functionality to `terraform destroy`. (Requires manual confirmation) -* [PlanOnlyPlugin](./docs/PlanOnlyPlugin.md): Use this to change the pipeline functionality to `terraform plan` only. ## Write your own Plugin From 94debb6fe5372480c516abdd11e744e13ecc52be Mon Sep 17 00:00:00 2001 From: Keith Manning Date: Sun, 2 Aug 2020 17:09:04 -0400 Subject: [PATCH 2/2] Update CHANGELOG --- CHANGELOG.md | 1 + 1 file changed, 1 insertion(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 05cc8380..682fdaa4 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,6 @@ # Unreleased +* [Issue #275](https://github.com/manheim/terraform-pipeline/issues/275) Alphabetize Plugins in the README * [Issue #256](https://github.com/manheim/terraform-pipeline/issues/256) Make it easy to apply "standard tags" * [Issue #268](https://github.com/manheim/terraform-pipeline/issues/268) Fix broken README links * [Issue #265](https://github.com/manheim/terraform-pipeline/issues/265) Make code coverage more visible - add codecov badge to README