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.

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

Ask whether vale should be implemented as an optional workflow or within the main CI/CD #134

Open
RobPasMue opened this issue Aug 4, 2022 · 0 comments
Labels
enhancement New features or code improvements

Comments

@RobPasMue
Copy link
Member

📝 Description of the feature

As a follow-up of the PyAnsys meeting, it was recommended to provide Vale as optional such that:

  • We should ask the user if they want to implement vale in CI/CD
  • Otherwise, it will be set up as an optional workflow

vale should be implemented so that the docs teams can run it, but if users don't want it to be part of their main CI/CD workflow, we should also allow it. This would be the perfect balance since the docs team will be able to run vale whenever they need, and it will not harass the developers in every PR.

💡 Steps for implementing the feature

Depending on the user's answer:

  • Provide vale inside the main CI/CD workflow
  • Provide vale as a separate, optional workfow

🔗 Useful links and references

Ask @RobPasMue in case of doubts

@RobPasMue RobPasMue added the enhancement New features or code improvements label Aug 4, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New features or code improvements
Projects
None yet
Development

No branches or pull requests

1 participant