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

chore(docs): azure devops variable name inconsistency #2902

Merged
merged 1 commit into from
Dec 30, 2022
Merged

chore(docs): azure devops variable name inconsistency #2902

merged 1 commit into from
Dec 30, 2022

Conversation

demetriusmoro
Copy link
Contributor

@demetriusmoro demetriusmoro commented Dec 30, 2022

Syncing doc environment variable name with the current code, as seen here (2022-12-30): https://github.com/demetriusmoro/atlantis/blob/main/cmd/server.go#L178

  • Current var name in the doc (wrong): ATLANTIS_AZUREDEVOPS_BASIC_AUTH
  • Current var name in code (correct): ATLANTIS_AZUREDEVOPS_WEBHOOK_PASSWORD

what

Fixing a variable name typo in the docs, to make it same than the actual code that reads this parameter.

why

The current variable name in the docs is not an actual valid parameter, people reading just the docs will get confused.

tests

Doesn't actually have test, its is a doc-only related fix, the related code works as expected.

references

@demetriusmoro demetriusmoro requested a review from a team as a code owner December 30, 2022 19:21
Copy link
Member

@nitrocode nitrocode left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice find. Seems like a reasonable change. Please feel free to propose more doc changes. They need more TLC.

@nitrocode nitrocode added the docs Documentation label Dec 30, 2022
@nitrocode nitrocode merged commit 9595b23 into runatlantis:main Dec 30, 2022
@nitrocode nitrocode changed the title fix: syncing doc variable name with current code chore(docs): azure devops variable name inconsistency Dec 30, 2022
@demetriusmoro demetriusmoro deleted the fix/doc-env-var-name branch December 30, 2022 19:41
@nitrocode nitrocode added this to the 0.20.0 milestone Jan 13, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants