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

Add project name to VCS comments #353

Closed
tomer-1 opened this issue Nov 14, 2018 · 2 comments
Closed

Add project name to VCS comments #353

tomer-1 opened this issue Nov 14, 2018 · 2 comments
Labels
quick-win Is obviously something Atlantis should do and will take <4 hrs work

Comments

@tomer-1
Copy link

tomer-1 commented Nov 14, 2018

consider the following atlantis.yaml file:

version: 2
projects:
- name: project1
  dir: src/terraform
  autoplan:
    when_modified: ["*.tf"]
    enabled: true
workflow: workflow1
- name: project2
  dir: src/terraform
  autoplan:
    when_modified: ["*.tf"]
    enabled: true
workflow: workflow2

when creating a PR, you will get following in github:

Ran Plan for 2 projects:

workspace: default dir: src/terraform
workspace: default dir: src/terraform

it makes it very hard to distinguish from atlantis output alone to which environment it was run and where are the errors (if they exist)
i think adding the "project name" and maybe also the "workflow" to the output in github
would make it a lot more readable and traceable.

@lkysow
Copy link
Member

lkysow commented Nov 16, 2018

@tomer-1 agreed. Happy to accept a PR for this.

@lkysow lkysow changed the title comments in git may look hard to distinguish Add project name to VCS comments Nov 19, 2018
@tomer-1
Copy link
Author

tomer-1 commented Nov 19, 2018

awsome, i'll try to sharpen my "go" skills .. :)

@lkysow lkysow added the quick-win Is obviously something Atlantis should do and will take <4 hrs work label Dec 3, 2018
lkysow added a commit that referenced this issue Dec 4, 2018
If projects are configured using an atlantis.yaml with a specific
project name, include that in the output for comments. This is useful
because often the project names are better identifiers than the
directory and workspace names and also because some projects use the
same dir and workspace so the only way to differentiate them is via
their names.

Fixes #353
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
quick-win Is obviously something Atlantis should do and will take <4 hrs work
Projects
None yet
Development

No branches or pull requests

2 participants