Skip to content

feat: allow users to indicate files dir#509

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

feat: allow users to indicate files dir#509
jorgepiloto merged 2 commits intomainfrom
feat/doc-style-files

Conversation

@jorgepiloto
Copy link
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 jorgepiloto requested a review from a team as a code owner June 18, 2024 15:20
@ansys-reviewer-bot
Copy link
Contributor

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

@ansys-reviewer-bot review

@github-actions github-actions bot added the enhancement General improvements to existing features label Jun 18, 2024
Copy link
Member

@RobPasMue RobPasMue left a comment

Choose a reason for hiding this comment

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

LGTM!

Copy link
Contributor

@SMoraisAnsys SMoraisAnsys left a comment

Choose a reason for hiding this comment

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

LGTM, this will be valuable for sure !

@jorgepiloto
Copy link
Member Author

Merging and patching later.

@jorgepiloto jorgepiloto merged commit ed8d62b into main Jun 19, 2024
@jorgepiloto 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>
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