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.

Sign up for GitHub

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

ci: use PyAnsys doc formattor and code-style checker. #3380

Merged
merged 5 commits into from
Oct 10, 2024
Merged

ci: use PyAnsys doc formattor and code-style checker. #3380

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
5620fa1
ci: use PyAnsys doc formattor and code-style checker.
prmukherj Oct 10, 2024
ce10ce9
Update vale.
prmukherj Oct 10, 2024
f733350
Updates.
prmukherj Oct 10, 2024
ad6376b
Update .vale.ini
prmukherj Oct 10, 2024
0822f63
feat: simplicfy action
RobPasMue Oct 10, 2024
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
9 changes: 8 additions & 1 deletion .github/workflows/ci.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ jobs:
python-version: ${{ env.PYTHON_VERSION }}

- name: Install pre-commit
run: python -m pip install pre-commit
run: python -m pip install 'pre-commit==3.8.0'

- name: Run pre-commit for docformatter
run: pre-commit run --hook-stage manual --all-files --show-diff-on-failure docformatter
Expand All @@ -69,6 +69,13 @@ jobs:
filter_mode: nofilter
fail_on_error: true

code-style:
name: Code style
runs-on: ubuntu-latest
steps:
- name: "Run PyAnsys code style checks"
uses: ansys/actions/code-style@v8

commit-style:
name: "Run commit style checks"
runs-on: ubuntu-latest
Expand Down
1 change: 1 addition & 0 deletions .vale.ini
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ Vocab = ANSYS

# Apply the following styles
BasedOnStyles = Vale, Google
Vale.Terms = NO
prmukherj marked this conversation as resolved.
Show resolved Hide resolved

# Removing Google-specific rule - Not applicable under some circumstances
Google.WordList = NO
Expand Down
Loading