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: allow users to indicate files dir #509

Merged
merged 2 commits into from
Jun 19, 2024
Merged

feat: allow users to indicate files dir #509

merged 2 commits into from
Jun 19, 2024

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
RobPasMue
RobPasMue reviewed Jun 18, 2024
View reviewed changes
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!

SMoraisAnsys
SMoraisAnsys approved these changes Jun 19, 2024
View reviewed changes
Copy link
Contributor

@SMoraisAnsys SMoraisAnsys left a comment •
edited
Loading

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
5 checks passed
@jorgepiloto jorgepiloto deleted the feat/doc-style-files branch June 19, 2024 13:01
jorgepiloto added a commit that referenced this pull request Jun 19, 2024
@jorgepiloto
feat: allow users to indicate files dir (#509)
b3a59f9
germa89 added a commit to ansys/pymapdl that referenced this pull request Jun 20, 2024
@germa89
ci: checking documentation style in Examples directory too. As per: a…
84f0540 
…nsys/actions#509
@germa89 germa89 mentioned this pull request Jun 20, 2024
Merged
10 tasks
germa89 added a commit to ansys/pymapdl that referenced this pull request Jun 24, 2024
@germa89 @pyansys-ci-bot @clatapie
ci: checking documentation style in Examples directory too (#3191)
64285bf 
* 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 <[email protected]>

---------

Co-authored-by: pyansys-ci-bot <[email protected]>
Co-authored-by: Camille <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@RobPasMue RobPasMue RobPasMue approved these changes

@SMoraisAnsys SMoraisAnsys SMoraisAnsys approved these changes

Assignees
No one assigned
Labels
enhancement General improvements to existing features
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@jorgepiloto @RobPasMue @SMoraisAnsys