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

fix: update rule type descriptions to be consistent #1277

Merged
merged 1 commit into from
Oct 24, 2023

Conversation

rdimitrov
Copy link
Member

The following PR:

  • Updates part of the rule type guidances which had ## which messed up the rendering when they were used later in alerts
  • Applies the auto-suggestions from the IDE for some grammar things

Fixes #1258

Signed-off-by: Radoslav Dimitrov <radoslav@stacklok.com>
@@ -6,13 +6,13 @@ context:
provider: github
description: Whether the protection rules apply to repository administrators
guidance: |
## Enforce required status checks for repository administrators
Enforce required status checks for repository administrators
Copy link
Contributor

Choose a reason for hiding this comment

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

The original intention was to have something like:

<action>

<description>

Where would be something that the user can action on. It would be highlighted in the UI and in the CLI.

Do we want to add other means of highlighting the action?

Copy link
Member Author

Choose a reason for hiding this comment

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

We already synced about what it causes, but if we have something like that it would help handle those separately -

  guidance:
    actions: | 
      Some text
    guidance: |
      Another text

Copy link
Contributor

@JAORMX JAORMX left a comment

Choose a reason for hiding this comment

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

This works for now. We can make it shiny later

@rdimitrov rdimitrov merged commit f675713 into stacklok:main Oct 24, 2023
12 checks passed
@rdimitrov rdimitrov deleted the fix-guidance branch October 24, 2023 14:45
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.

bug: verify all rule type guidance descriptions follow the same format
2 participants