Skip to content

Update Readme.md #14

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

Open
SavchenkoAlexander wants to merge 6 commits into
base: 23.1.2
Choose a base branch
from
Open

Update Readme.md #14

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
a9c7fc9
Update Readme.md
SavchenkoAlexander Mar 3, 2025
4e5000e
README auto update [skip ci]
Mar 3, 2025
abc9c30
Add test value validation section
SavchenkoAlexander Oct 3, 2025
94c2d7e
Merge branch '23.1.2' into SavchenkoAlexander-patch-1
SavchenkoAlexander Oct 3, 2025
ad4e3b5
Update vale linter to check only README.md
SavchenkoAlexander Oct 3, 2025
b5ef55b
update vale linter script
SavchenkoAlexander Oct 3, 2025
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
30 changes: 29 additions & 1 deletion .github/workflows/vale.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ jobs:
steps:
- name: clone repo
uses: actions/checkout@v4

- name: clone vale-styles repo
uses: actions/checkout@v4
with:
Expand All @@ -21,10 +22,37 @@ jobs:
ssh-key: ${{ secrets.VALE_STYLES_ACCESS_KEY }}
- name: copy vale rules to the root repo
run: shopt -s dotglob && cp -r ./vale-styles/vale/* .

- name: Prepare existing README files list
id: prepare
shell: bash
run: |
candidates=(README.md readme.md Readme.md)
files_json_parts=()
for f in "${candidates[@]}"; do
if [[ -f "$f" ]]; then
files_json_parts+=("\"$f\"")
fi
done
if [[ ${#files_json_parts[@]} -eq 0 ]]; then
echo "No README variants found. Skipping Vale."
echo "skip=true" >> "$GITHUB_OUTPUT"
else
files_json="[$(IFS=,; echo "${files_json_parts[*]}")]"
echo "Will lint: $files_json"
echo "valefiles=$files_json" >> "$GITHUB_OUTPUT"
echo "skip=false" >> "$GITHUB_OUTPUT"
fi

- name: vale linter check
if: steps.prepare.outputs.skip == 'false'
uses: DevExpress/vale-action@reviewdog
with:
files: '["README.md", "readme.md", "Readme.md"]'
files: ${{ steps.prepare.outputs.valefiles }}
fail_on_error: true
filter_mode: nofilter
reporter: github-check

- name: Note skipped (no README present)
if: steps.prepare.outputs.skip == 'true'
run: echo "Vale step skipped because no README variant exists."
22 changes: 12 additions & 10 deletions Readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,16 @@
<!-- default badges list -->
[![](https://img.shields.io/badge/Open_in_DevExpress_Support_Center-FF7200?style=flat-square&logo=DevExpress&logoColor=white)](https://supportcenter.devexpress.com/ticket/details/T1245197)
[![](https://img.shields.io/badge/📖_How_to_use_DevExpress_Examples-e9f6fc?style=flat-square)](https://docs.devexpress.com/GeneralInformation/403183)
[![](https://img.shields.io/badge/💬_Leave_Feedback-feecdd?style=flat-square)](#does-this-example-address-your-development-requirementsobjectives)
<!-- default badges end -->
# approvals-test
test repo for pr approvals test
<!-- feedback -->
<!-- default badges list -->
[![](https://img.shields.io/badge/Open_in_DevExpress_Support_Center-FF7200?style=flat-square&logo=DevExpress&logoColor=white)](https://supportcenter.devexpress.com/ticket/details/T1245197)
[![](https://img.shields.io/badge/📖_How_to_use_DevExpress_Examples-e9f6fc?style=flat-square)](https://docs.devexpress.com/GeneralInformation/403183)
[![](https://img.shields.io/badge/💬_Leave_Feedback-feecdd?style=flat-square)](#does-this-example-address-your-development-requirementsobjectives)
<!-- default badges end -->
# approvals-test

Check failure on line 6 in Readme.md

View workflow job for this annotation

GitHub Actions / vale

[vale] Readme.md#L6 

[DX.HeadingCapitalization] 'approvals-test' should match our guidelines for title case
Raw output 
{"message": "[DX.HeadingCapitalization] 'approvals-test' should match our guidelines for title case", "location": {"path": "Readme.md", "range": {"start": {"line": 6, "column": 3}}}, "severity": "ERROR"}
test repo for pr approvals test (vale test)
<!-- feedback -->
## Does this example address your development requirements/objectives?

Check failure on line 9 in Readme.md

View workflow job for this annotation

GitHub Actions / vale

[vale] Readme.md#L9 

[DX.HeadingCapitalization] 'Does this example address your development requirements/objectives?' should match our guidelines for title case
Raw output 
{"message": "[DX.HeadingCapitalization] 'Does this example address your development requirements/objectives?' should match our guidelines for title case", "location": {"path": "Readme.md", "range": {"start": {"line": 9, "column": 4}}}, "severity": "ERROR"}

Check failure on line 9 in Readme.md

View workflow job for this annotation

GitHub Actions / vale

[vale] Readme.md#L9 

[DX.HeadingPunctuation] Don't use end punctuation at the end of headings.
Raw output 
{"message": "[DX.HeadingPunctuation] Don't use end punctuation at the end of headings.", "location": {"path": "Readme.md", "range": {"start": {"line": 9, "column": 69}}}, "severity": "ERROR"}

[<img src="https://www.devexpress.com/support/examples/i/yes-button.svg"/>](https://www.devexpress.com/support/examples/survey.xml?utm_source=github&utm_campaign=approvals-test&~~~was_helpful=yes) [<img src="https://www.devexpress.com/support/examples/i/no-button.svg"/>](https://www.devexpress.com/support/examples/survey.xml?utm_source=github&utm_campaign=approvals-test&~~~was_helpful=no)

(you will be redirected to DevExpress.com to submit your response)
<!-- feedback end -->
(you will be redirected to DevExpress.com to submit your response)
<!-- feedback end -->

Test vale validation
Loading