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 Vale linter #241

Merged
merged 9 commits into from
Oct 22, 2024
Merged
Show file tree
Hide file tree
Changes from all 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
28 changes: 16 additions & 12 deletions .github/workflows/linting.yml
Original file line number Diff line number Diff line change
@@ -1,35 +1,39 @@
name: Linting
on:
# Note: onlyAnnotateModifiedLines only works correctly on PRs!
# If you need to run checks on push as well, create a separate workflow file.
pull_request:

jobs:
prose:
runs-on: ubuntu-latest
runs-on: ubuntu-22.04 # See https://github.com/errata-ai/vale-action/issues/128 before upgrading
steps:
- name: Checkout
uses: actions/checkout@v2
uses: actions/checkout@v4
with:
fetch-depth: 0

- uses: actions/setup-python@v4
with:
python-version: '3.x'
cache: 'pip'

- name: Install Python dependencies
run: pip3 install -r docs/requirements.txt

- name: Vale
uses: errata-ai/vale-action@master
uses: errata-ai/vale-action@reviewdog
with:
# We can modify these styles as we want
styles: |
https://github.com/errata-ai/Google/releases/latest/download/Google.zip
onlyAnnotateModifiedLines: true
# Please keep version in sync with the version in .gitpod.Dockerfile for a consistent experience
version: 3.7.1
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

build:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v2
uses: actions/checkout@v4

- uses: actions/setup-python@v2
- uses: actions/setup-python@v4
with:
python-version: '3.x'
cache: 'pip'
Expand All @@ -43,4 +47,4 @@ jobs:

- name: Check links
working-directory: docs
run: make checklinks
run: make checklinks
23 changes: 1 addition & 22 deletions .gitpod.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
# Since Gitpod doesn't support caching custom Dockerfiles yet, we temporarily
# use this once which has Python 3.9 and Vale preinstalled.
image:
file: .gitpod.Dockerfile

Expand All @@ -13,23 +11,4 @@ vscode:
- [email protected] # See https://github.com/mautic/user-documentation/pull/334#issuecomment-2405922370 before upgrading.
- trond-snekvik.simple-rst
- errata-ai.vale-server
- eamodio.gitlens

github:
prebuilds:
# enable for the master/default branch (defaults to true)
master: true
# enable for all branches in this repo (defaults to false)
branches: true
# enable for pull requests coming from this repo (defaults to true)
pullRequests: true
# enable for pull requests coming from forks (defaults to false)
pullRequestsFromForks: true
# add a check to pull requests (defaults to true)
addCheck: false
# add a "Review in Gitpod" button as a comment to pull requests (defaults to false)
addComment: false
# add a "Review in Gitpod" button to the pull request's description (defaults to false)
addBadge: true
# add a label once the prebuild is ready to pull requests (defaults to false)
addLabel: false
- eamodio.gitlens
2 changes: 1 addition & 1 deletion .readthedocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ version: 2
build:
os: ubuntu-20.04
tools:
python: "3.9"
python: "3.11"
# You can also specify other tool versions:
# nodejs: "16"
# rust: "1.55"
Expand Down
12 changes: 6 additions & 6 deletions docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
# File: requirements.txt

# Defining the exact version will make sure things don't break
sphinx==6.2.1
sphinx_rtd_theme==1.2.0
sphinx==8.0.2
sphinx_rtd_theme==3.0.0
readthedocs-sphinx-search==0.3.2
rstcheck==6.1.1
myst-parser==1.0.0
linkify-it-py==2.0.0
rstcheck==6.2.4
myst-parser==4.0.0
linkify-it-py==2.0.3
esbonio==0.16.5
attrs==22.2.0
attrs==24.2.0
Loading