FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

feat: allow users to indicate files dir by jorgepiloto · Pull Request #509 · ansys/actions · GitHub

Repository navigation

feat: allow users to indicate files dir - #509

Merged
jorgepiloto merged 2 commits into
mainfrom
feat/doc-style-files
Jun 19, 2024
Merged

jorgepiloto merged 2 commits into
mainfrom
feat/doc-style-files

Conversation

Copy link
Copy Markdown
Member

After a discussion on #432, we thought about allowing users to specify the location of their documentation files. With these changes, projects with doc/ and examples/ folders can now run:

  doc-style:
    name: "Doc style ${{ matrix.folder }}"
    runs-on: ubuntu-latest
    strategy:
      matrix:
        folder: ["doc", "examples"]
      fail-fast: false
  steps:
    - uses: ansys/actions/doc-style@v6
      with:
        files: ${{ matrix.folder }}
        vale-config: ${{ matrix.folder }}/.vale.ini
        token: ${{ secrets.GITHUB_TOKEN }}

jorgepiloto requested a review from a team as a code owner June 18, 2024 15:20

Copy link
Copy Markdown
Contributor

Thanks for opening a Pull Request. If you want to perform a review write a comment saying:

@ansys-reviewer-bot review

github-actions Bot added the enhancement General improvements to existing features label Jun 18, 2024

RobPasMue left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

LGTM!

SMoraisAnsys left a comment •
edited
Loading

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

LGTM, this will be valuable for sure !

Copy link
Copy Markdown
Member Author

Merging and patching later.

jorgepiloto merged commit ed8d62b into main Jun 19, 2024
jorgepiloto deleted the feat/doc-style-files branch June 19, 2024 13:01
germa89 added a commit to ansys/pymapdl that referenced this pull request Jun 24, 2024
* ci: checking documentation style in Examples directory too. As per: ansys/actions#509

* Adding changelog entry: 3191.changed.md

* feat: symbolic link vale configuration in examples directory to documentation vale configuration file.

* Adding changelog entry: 3191.changed.md

* fix: style path in vale file

* Update examples/.vale.ini

Co-authored-by: Camille <78221213+clatapie@users.noreply.github.com>

---------

Co-authored-by: pyansys-ci-bot <pyansys.github.bot@ansys.com>
Co-authored-by: Camille <78221213+clatapie@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement General improvements to existing features

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants


Back | FazBrowse Home | New Git URL