Skip to content

Commit

Permalink
Merge pull request #583 from cghyzel/main
Browse files Browse the repository at this point in the history
Fix formatting issues on label-management & branch-management pages
  • Loading branch information
PavelLinearB committed Sep 5, 2024
2 parents 647591c + 12cde6b commit 54c80ca
Show file tree
Hide file tree
Showing 10 changed files with 103 additions and 8 deletions.
3 changes: 2 additions & 1 deletion docs/automations/standard/branch-management/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,8 @@ Use gitStream to enforce branch naming conventions, review assignment, and other

<a name="enforce-branch-name"></a>
## Enforce Branch Naming Conventions
--8<-- "docs/automations/standard/branch-management/enforce-branch-name/README.md:6:"

--8<-- "docs/automations/standard/branch-management/enforce-branch-name/README.md:example"

## Additional Resources

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ description: Automatically enforce prefixes or keywords in PR branch names.
category: [review, quality]
---
# Enforce Branch Naming Conventions

<!-- --8<-- [start:example]-->
Automatically enforce prefixes or keywords in PR branch names.

![Enforce Branch Naming Conventions](/automations/standard/branch-management/enforce-branch-name/enforce-branch-name.png)
Expand All @@ -30,3 +30,14 @@ Automatically enforce prefixes or keywords in PR branch names.
[:octicons-download-24: Download this example as a CM file.](/downloads/automation-library/standard/branch-management/enforce_branch_name.cm){ .md-button }
</span>
</div>
<!-- --8<-- [end:example]-->

## Additional Resources

--8<-- "docs/snippets/general.md"

**Related Automations**:

--8<-- "docs/snippets/review-assignment-automation.md"

--8<-- "docs/snippets/automation-footer.md"
10 changes: 5 additions & 5 deletions docs/automations/standard/label-management/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,27 +9,27 @@ Use YAML to automate label management on your git repo with gitStream.

<a name="enforce-required-labels"></a>
## Enforce Required Labels
--8<-- "docs/automations/standard/label-management/enforce-labels/README.md:6:"
--8<-- "docs/automations/standard/label-management/enforce-labels/README.md:example"

<a name="label-changed-resources"></a>
## Label Modified Resources
--8<-- "docs/automations/standard/label-management/label-resources-percent/README.md:6:"
--8<-- "docs/automations/standard/label-management/label-resources-percent/README.md:example"

<a name="label-languages"></a>
## Label PRs by Language
--8<-- "docs/automations/standard/label-management/label-prs-by-language/README.md:example"

<a name="label-unresolved-threads"></a>
## Label the Number of Unresolved Code Review Threads
--8<-- "docs/automations/standard/label-management/label-unresolved-threads/README.md:6:"
--8<-- "docs/automations/standard/label-management/label-unresolved-threads/README.md:example"

<a name="suggest-labels"></a>
## Automatically Recommend Labels for New PRs
--8<-- "docs/automations/standard/label-management/suggest-labels/README.md:6:"
--8<-- "docs/automations/standard/label-management/suggest-labels/README.md:example"

<a name="label-approvals"></a>
## Label PRs with the Number of Approvals
--8<-- "docs/automations/standard/label-management/label-approvals/README.md:6:"
--8<-- "docs/automations/standard/label-management/label-approvals/README.md:example"

## Additional Resources

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ description: Automatically enforce the use of required PR labels.
category: [review, quality]
---
# Enforce Required Labels
<!-- --8<-- [start:example]-->
Automatically enforce the use of required PR labels.

<div class="automationImage" markdown="1">
Expand Down Expand Up @@ -32,3 +33,14 @@ Automatically enforce the use of required PR labels.
</span>
</div>
</div>
<!-- --8<-- [end:example]-->

## Additional Resources

--8<-- "docs/snippets/general.md"

**Related Automations**:

--8<-- "docs/snippets/context-automation.md"

--8<-- "docs/snippets/automation-footer.md"
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ description: Automatically label PRs with the number of completed reviews that a
category: [review]
---
# Label the Number of Approvals

<!-- --8<-- [start:example]-->
Automatically label PRs with the number of completed reviews that approve the PR.

<div class="automationImage" markdown="1">
Expand Down Expand Up @@ -32,3 +32,15 @@ Automatically label PRs with the number of completed reviews that approve the PR
</span>
</div>
</div>

<!-- --8<-- [end:example]-->

## Additional Resources

--8<-- "docs/snippets/general.md"

**Related Automations**:

--8<-- "docs/snippets/context-automation.md"

--8<-- "docs/snippets/automation-footer.md"
Original file line number Diff line number Diff line change
Expand Up @@ -28,3 +28,13 @@ Automatically label PRs to indicate what resources are being changed.
</div>

<!-- --8<-- [end:example]-->

## Additional Resources

--8<-- "docs/snippets/general.md"

**Related Automations**:

--8<-- "docs/snippets/context-automation.md"

--8<-- "docs/snippets/automation-footer.md"
Original file line number Diff line number Diff line change
Expand Up @@ -30,3 +30,13 @@ Automatically detect which programming languages are contained in PRs and automa
</div>

<!-- --8<-- [end:example]-->

## Additional Resources

--8<-- "docs/snippets/general.md"

**Related Automations**:

--8<-- "docs/snippets/context-automation.md"

--8<-- "docs/snippets/automation-footer.md"
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ description: Automatically label PRs based on changes to code resources.
category: [review]
---
# Label Changed Resources By Percent
<!-- --8<-- [start:example]-->

Apply a label to all PRs that indicates what percentage of new lines of code modify one or more specified resources.

Expand Down Expand Up @@ -32,3 +33,15 @@ Apply a label to all PRs that indicates what percentage of new lines of code mod
</span>
</div>
</div>

<!-- --8<-- [end:example]-->

## Additional Resources

--8<-- "docs/snippets/general.md"

**Related Automations**:

--8<-- "docs/snippets/context-automation.md"

--8<-- "docs/snippets/automation-footer.md"
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ category: [security]
quickstart: true
---
# Label Unresolved Review Threads
<!-- --8<-- [start:example]-->
Automatically label PRs when there are unresolved code review comments.

<div class="automationImage" markdown="1">
Expand Down Expand Up @@ -32,3 +33,15 @@ Automatically label PRs when there are unresolved code review comments.
</span>
</div>
</div>

<!-- --8<-- [end:example]-->

## Additional Resources

--8<-- "docs/snippets/general.md"

**Related Automations**:

--8<-- "docs/snippets/context-automation.md"

--8<-- "docs/snippets/automation-footer.md"
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ description: Automatically suggest labels to apply to new PRs.
category: [review]
---
# Suggest Labels
<!-- --8<-- [start:example]-->
Automatically suggest labels to apply to new PRs.

<div class="automationImage" markdown="1">
Expand Down Expand Up @@ -31,3 +32,15 @@ Automatically suggest labels to apply to new PRs.
</span>
</div>
</div>

<!-- --8<-- [end:example]-->

## Additional Resources

--8<-- "docs/snippets/general.md"

**Related Automations**:

--8<-- "docs/snippets/context-automation.md"

--8<-- "docs/snippets/automation-footer.md"

0 comments on commit 54c80ca

Please sign in to comment.