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

markdown workflow: support correctly .prettierignore #65

Merged
merged 15 commits into from
Nov 27, 2023
Merged
2 changes: 1 addition & 1 deletion .github/config/.prettierignore
Original file line number Diff line number Diff line change
@@ -1 +1 @@

../../__tests__/*.md
2 changes: 2 additions & 0 deletions .github/config/wordlist.txt
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,6 @@ untagged
chicco
tejo
cosimomeli
prettifier
prettierignore
hiimjako
7 changes: 4 additions & 3 deletions .github/workflows/markdown.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -84,15 +84,16 @@ jobs:
- name: Prettify MD files
uses: zaphiro-technologies/prettier_action@main
with:
prettier_options: --prose-wrap always --write **/*.{md,MD}
prettier_options: --prose-wrap always --write **/*.{md,MD} --ignore-path .github/config/.prettierignore
dry: true
dry_no_fail: true
- name: Lint
uses: DavidAnson/markdownlint-cli2-action@v11
uses: DavidAnson/markdownlint-cli2-action@v13
with:
fix: true
config: ${{ inputs.config-lint-path || '.github/config/.markdownlint.json' }}
globs: ${{ inputs.md-lint-globs || '**/*.{md,MD}' }}
globs: ${{ inputs.md-lint-globs || '**/*.md,**/*.MD,#__tests__/test.md' }}
separator: ${{ inputs.md-lint-globs && '' || ',' }}
- name: Commit markdown-lint changes
run: |
git config --global user.name 'Bot'
Expand Down
3 changes: 2 additions & 1 deletion RELEASE_NOTES.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# github-workflows Release Notes

## 0.0.2-dev - 2023-11-23
## 0.0.2-dev - 2023-11-27

### Features

Expand Down Expand Up @@ -31,6 +31,7 @@
### Bug Fixes

- pr-check workflow: pass correctly `input.labels` (PR #67 by @chicco785)
- markdown workflow: support correctly `.prettierignore` (PR #65 by @chicco785)
- markdown workflow: fix check to enable/disable spellchecker (PR #55 by
@chicco785)
- golang workflow: add shell configuration to enable `pipefail` for benchmark
Expand Down
3 changes: 3 additions & 0 deletions __tests__/test.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# This file should be ignored by prettifier

Very lengthy text should not be fixed at all by the prettier and we all should be able to live happily after this.
Loading