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

Profile rule_types in docs don't match published rule types #1798

Closed
evankanderson opened this issue Dec 1, 2023 · 2 comments
Closed

Profile rule_types in docs don't match published rule types #1798

evankanderson opened this issue Dec 1, 2023 · 2 comments
Labels
bug Something isn't working

Comments

@evankanderson
Copy link
Member

Describe the issue

https://minder-docs.stacklok.dev/how-to/manage_profiles shows a profile with the following rule:

- type: branch_protection
        params:
          branch: main
        def:
          required_pull_request_reviews:
            dismiss_stale_reviews: true
            require_code_owner_reviews: true
            required_approving_review_count: 1
          required_linear_history: true
          allow_force_pushes: false
          allow_deletions: false
          allow_fork_syncing: true

But we split the branch_protection rule type up into a bunch of smaller rules. (I think this helped composability and partial rollout, but it may have made profiles harder to manage...)

We should either update the docs, or provide a branch_protection rule in https://github.com/stacklok/minder-rules-and-profiles/tree/main/rule-types/github

To Reproduce

No response

What version are you using?

No response

@evankanderson evankanderson added the bug Something isn't working label Dec 1, 2023
@jhrozek
Copy link
Contributor

jhrozek commented Feb 6, 2024

cc @dmjb you /will/ hit this issue as you go through the docs, might as well want to fix it :-)

@eleftherias
Copy link
Contributor

Fixed in #2331

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

3 participants