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: add missing the branch key in the reference for server side repo config #1784

Conversation

minamijoyo
Copy link
Contributor

Fixes #1695

The branch matcher feature has been implemented in #1383 and #1768. There is only an example for it, but not in the reference.

https://github.com/runatlantis/atlantis/pull/1383/files#diff-5dd8dd3b7c37191b78109efaaa1bb73184ff7a1690632d687fed7cd748847f5eR31-R34

Add missing the branch key in the reference for server side repo config.

I also add a warning for mergeable requirement to check the branch setting because I think a typical branch protection rule only restricts a default branch. We should let users know that someone can potentially bypass it without the branch restriction in atlantis.

Fixes runatlantis#1695

The branch matcher feature has been implemented in runatlantis#1383 and runatlantis#1768.
There is only an example for it, but not in the reference.

https://github.com/runatlantis/atlantis/pull/1383/files#diff-5dd8dd3b7c37191b78109efaaa1bb73184ff7a1690632d687fed7cd748847f5eR31-R34

Add missing the `branch` key in the reference for server side repo config.

I also add a warning for `mergeable` requirement to check the `branch`
setting because I think a typical branch protection rule only restricts
a default branch. We should let users know that someone can potentially
bypass it without the `branch` restriction in atlantis.
@minamijoyo minamijoyo requested a review from a team as a code owner September 2, 2021 02:53
Copy link
Member

@chenrui333 chenrui333 left a comment

Choose a reason for hiding this comment

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

lgtm

@chenrui333 chenrui333 changed the title Add missing the branch key in the reference for server side repo config docs: add missing the branch key in the reference for server side repo config Sep 8, 2021
@nishkrishnan nishkrishnan merged commit 289cab0 into runatlantis:master Sep 14, 2021
krrrr38 pushed a commit to krrrr38/atlantis that referenced this pull request Dec 16, 2022
…natlantis#1784)

Fixes runatlantis#1695

The branch matcher feature has been implemented in runatlantis#1383 and runatlantis#1768.
There is only an example for it, but not in the reference.

https://github.com/runatlantis/atlantis/pull/1383/files#diff-5dd8dd3b7c37191b78109efaaa1bb73184ff7a1690632d687fed7cd748847f5eR31-R34

Add missing the `branch` key in the reference for server side repo config.

I also add a warning for `mergeable` requirement to check the `branch`
setting because I think a typical branch protection rule only restricts
a default branch. We should let users know that someone can potentially
bypass it without the `branch` restriction in atlantis.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Missing branch key in the repo section of the docs
3 participants