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

docs: update docs #8

Merged
merged 2 commits into from
Jan 31, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 11 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,21 @@
## [Unreleased]


<a name="0.4.1"></a>
## [0.4.1] - 2021-01-31
### Docs
- update docs


<a name="0.4.0"></a>
## [0.4.0] - 2021-01-31
### Feat
- **azuredevops:** send request
- **azuredevops:** added azure devops output

### Pull Requests
- Merge pull request [#7](https://github.com/bcochofel/terraplanfeed/issues/7) from bcochofel/azuredevops


<a name="0.3.4"></a>
## [0.3.4] - 2021-01-30
Expand Down Expand Up @@ -119,7 +128,8 @@
- Merge pull request [#1](https://github.com/bcochofel/terraplanfeed/issues/1) from bcochofel/package_skel


[Unreleased]: https://github.com/bcochofel/terraplanfeed/compare/0.4.0...HEAD
[Unreleased]: https://github.com/bcochofel/terraplanfeed/compare/0.4.1...HEAD
[0.4.1]: https://github.com/bcochofel/terraplanfeed/compare/0.4.0...0.4.1
[0.4.0]: https://github.com/bcochofel/terraplanfeed/compare/0.3.4...0.4.0
[0.3.4]: https://github.com/bcochofel/terraplanfeed/compare/0.3.3...0.3.4
[0.3.3]: https://github.com/bcochofel/terraplanfeed/compare/0.3.2...0.3.3
Expand Down
16 changes: 13 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@ This tool aims to parse Terraform plan files (in JSON format) and gives feedback

Outputs can be:
* stdout: stdout
* azuredevops: Azure DevOps pull request comment
* github: Github pull request comment (not yet implemented)
* azuredevops: Azure DevOps pull request comment (not yet implemented)

To create the Terraform plan file:

Expand All @@ -31,7 +31,6 @@ To write to stdout you just need to pass a JSON file:
Summary of changes:
===================


(Create): <known after apply> (module.failover_rg.azurerm_resource_group.rg)
(Create): <known after apply> (module.failover_rg.module.naming.random_string.first_letter)
(Create): <known after apply> (module.failover_rg.module.naming.random_string.main)
Expand All @@ -45,10 +44,21 @@ Summary of changes:
(Create): <known after apply> (module.sql.module.naming_failover.random_string.first_letter)
(Create): <known after apply> (module.sql.module.naming_failover.random_string.main)

```

To use this on Azure DevOps you need the following environment variables:
* SYSTEM_TEAMFOUNDATIONSERVERURI
* SYSTEM_TEAMPROJECT
* BUILD_REPOSITORY_ID
* SYSTEM_PULLREQUEST_PULLREQUESTID
* SYSTEM_ACCESSTOKEN

these environment variables are present when you run Azure DevOps pipelines.

**Note:** The `SYSTEM_PULLREQUEST_PULLREQUESTID` is only present when you run
pipeline in a pull request.

```
If any of these environment variables are not present, output defaults to stdout

# Run and test locally

Expand Down
2 changes: 1 addition & 1 deletion terraplanfeed/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,4 @@
Modules:
terraform
"""
__version__ = "0.4.0"
__version__ = "0.4.1"