Skip to content

Commit

Permalink
feat: add deprecation warning
Browse files Browse the repository at this point in the history
  • Loading branch information
jorgepiloto committed Feb 23, 2024
1 parent cf2503b commit dfef1ae
Showing 1 changed file with 30 additions and 0 deletions.
30 changes: 30 additions & 0 deletions doc-style/action.yml
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 deprecation in ansys/actions@v6

- name: "Build deprecation warning"
if: inputs.vale-version == '2.29.6'
shell: bash
run: |
read -r -d '' deprecation_text <<'EOF'
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"
EOF
echo "DEPRECATION_TEXT=$(echo $deprecation_text)" >> $GITHUB_ENV
- uses: ansys/actions/_logging@main
if: inputs.vale-version == '2.29.6'
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
run: |
echo "::warning ::${DEPRECATION_TEXT}"
# TODO: end

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

0 comments on commit dfef1ae

Please sign in to comment.