feat: Add ability to set pr status context with --status-name flag #841
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov Report
@@ Coverage Diff @@
## master #841 +/- ##
==========================================
+ Coverage 71.83% 71.85% +0.01%
==========================================
Files 65 65
Lines 5213 5215 +2
==========================================
+ Hits 3745 3747 +2
Misses 1183 1183
Partials 285 285
Continue to review full report at Codecov.
|
lkysow
requested changes
Nov 27, 2019
| @@ -72,6 +72,7 @@ const ( | |||
| SlackTokenFlag = "slack-token" | |||
| SSLCertFileFlag = "ssl-cert-file" | |||
| SSLKeyFileFlag = "ssl-key-file" | |||
| StatusName = "status-name" | |||
There was a problem hiding this comment.
Suggested change
| StatusName = "status-name" | |
| PRStatusName = "pr-status-name" |
I think adding PR will save some confusion as to what status we're talking about.
| @@ -87,6 +88,7 @@ const ( | |||
| DefaultLogLevel = "info" | |||
| DefaultPort = 4141 | |||
| DefaultTFEHostname = "app.terraform.io" | |||
| DefaultStatusName = "atlantis" | |||
There was a problem hiding this comment.
Suggested change
| DefaultStatusName = "atlantis" | |
| DefaultPRStatusName = "atlantis" |
| @@ -719,6 +720,7 @@ write-git-creds: true | |||
| "TFE_HOSTNAME": "override-my-hostname", | |||
| "TFE_TOKEN": "override-my-token", | |||
| "WRITE_GIT_CREDS": "false", | |||
There was a problem hiding this comment.
Missed adding TestExecute_Flags, TestExecute_ConfigFile
| @@ -762,6 +764,7 @@ write-git-creds: true | |||
| Equals(t, "override-my-hostname", passedConfig.TFEHostname) | |||
| Equals(t, "override-my-token", passedConfig.TFEToken) | |||
| Equals(t, false, passedConfig.WriteGitCreds) | |||
| Equals(t, "override-status-name", passedConfig.StatusName) | |||
There was a problem hiding this comment.
You also need to add status-name: status to line 679 to match the rest of the test
| @@ -39,11 +39,12 @@ type CommitStatusUpdater interface { | |||
|
|
|||
| // DefaultCommitStatusUpdater implements CommitStatusUpdater. | |||
| type DefaultCommitStatusUpdater struct { | |||
| Client vcs.Client | |||
| Client vcs.Client | |||
| StatusName string | |||
There was a problem hiding this comment.
Suggested change
| StatusName string | |
| // PRStatusName is the name used when updating the PR status. | |
| PRStatusName string |
| "os" | ||
| "testing" | ||
|
|
||
| "github.com/hashicorp/go-version" | ||
| "github.com/runatlantis/atlantis/server/events/runtime" | ||
|
|
| @@ -44,6 +44,7 @@ type UserConfig struct { | |||
| SlackToken string `mapstructure:"slack-token"` | |||
| SSLCertFile string `mapstructure:"ssl-cert-file"` | |||
| SSLKeyFile string `mapstructure:"ssl-key-file"` | |||
| StatusName string `mapstructure:"status-name"` | |||
There was a problem hiding this comment.
Suggested change
| StatusName string `mapstructure:"status-name"` | |
| PRStatusName string `mapstructure:"pr-status-name"` |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Hi 👋
Background
I recently commented on #249 with regards to using multiple Atlantis servers against a single repo.
I have a reasonably good setup with an Atlantis server running in a "dev" account and one in a "prd" account (due to no access to a management account or ability to allow cross-account trusted roles). This works well, I can set my dev server to allow applying mergable changes and my prd server allows applying only approved changes with automerging.
The Problem
The PR status gets updated with "atlantis/{plan, apply, ...}" from both servers which makes it difficult to know which server had issues with, or is running a plan / apply and can cause some confusion.
The Solution
A
--status-nameallows users to override the name used in PR status contexts per server.Example
--status-name atlantis-noprodresults in:As always, feedback or recommendation is greatly welcome and appreciated!
Thanks,
Tim