Skip to content
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions .github/workflows/style-guide.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
name: Verify style guide compliance on pull request
on: [pull_request]

jobs:
vale:
name: Linting with Vale
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- name: Install Asciidoctor
run: sudo apt-get install -y asciidoctor
- uses: errata-ai/vale-action@reviewdog
with:
filter_mode: diff_context
vale_flags: "--no-exit --minAlertLevel=error"
reporter: github-pr-review
fail_on_error: true
env:
# Required, set by GitHub actions automatically:
# https://docs.github.com/en/actions/security-guides/automatic-token-authentication#about-the-github_token-secret
GITHUB_TOKEN: ${{ secrets.RHDH_BOT_TOKEN }}
REVIEWDOG_GITHUB_API_TOKEN: ${{ secrets.RHDH_BOT_TOKEN }}
1 change: 0 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
titles/*/build
index.html
titles-generated/
.vale.ini
.vale-styles/RedHat
.vscode
.cache/
Expand Down
12 changes: 12 additions & 0 deletions .vale-styles/DeveloperHub/tests/.vale.ini
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
; .vale.ini
; Specifies Vale configuration
; See: https://redhat-documentation.github.io/vale-at-red-hat/docs/user-guide/installing-vale-cli/
;
; Download and search Vale styles in this directory:
StylesPath = ../..
; Minimum alert level to display:
MinAlertLevel = suggestion
; Display alerts on AsciiDoc files:
[*.adoc]
; Apply these styles:
BasedOnStyles = DeveloperHub
18 changes: 18 additions & 0 deletions .vale.ini
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# .vale.ini
# Specifies Vale configuration
# See: https://redhat-documentation.github.io/vale-at-red-hat/docs/user-guide/installing-vale-cli/
#

# Download and search Vale styles in this directory:
StylesPath = ".vale-styles"

# Minimum alert level to display:
MinAlertLevel = suggestion

# Styles to download:
Packages = RedHat

# Display alerts on AsciiDoc files:
[*.adoc]
# Apply these styles:
BasedOnStyles = RedHat,DeveloperHub
Loading