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

Jump to bottom

feat: add deprecation warning #411

Merged
merged 4 commits into from
Feb 23, 2024
Merged

feat: add deprecation warning #411

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
dfef1ae
feat: add deprecation warning
jorgepiloto Feb 23, 2024
4392ada
dbg: ci/cd
jorgepiloto Feb 23, 2024
0de3ed2
fix: extra quote
jorgepiloto Feb 23, 2024
6629b48
fix: check for any vale v2 version
jorgepiloto Feb 23, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
30 changes: 30 additions & 0 deletions doc-style/action.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,36 @@ runs:
uses: actions/checkout@v4
if: inputs.checkout == 'true'

# TODO: remove this deprecation in ansys/actions@v6

- name: "Build deprecation warning"
if: startswith(inputs.vale-version, '2.')
shell: bash
run: |
deprecation_text="
Ansys Actions v6 will include by default Vale version v3. For
migrating, please update your 'doc/.vale.ini' file and 'doc/styles'
directory as in this pull-request https://github.com/ansys/pymechanical/pull/613
"
echo "DEPRECATION_TEXT=$(echo $deprecation_text)" >> $GITHUB_ENV
- uses: ansys/actions/_logging@main
if: startswith(inputs.vale-version, '2.')
jorgepiloto marked this conversation as resolved.
Show resolved Hide resolved
with:
level: "WARNING"
message: >
Ansys Actions v6 will include by default Vale version v3. For
migrating, please update your "doc/.vale.ini" file and "doc/styles"
directory as in this pull-request https://github.com/ansys/pymechanical/pull/613
- name: "Raise deprecation warning outside of the CI/CD logs"
shell: bash
if: startswith(inputs.vale-version, '2.')
run: |
echo "::warning ::${DEPRECATION_TEXT}"
# TODO: end

- name: "Run Vale"
uses: errata-ai/vale-action@reviewdog
env:
Expand Down