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

feat(docs): Add vale style checker #419

Merged
merged 13 commits into from
Nov 21, 2024
Merged

feat(docs): Add vale style checker #419

merged 13 commits into from
Nov 21, 2024

Conversation

merkata
Copy link
Contributor

@merkata merkata commented Sep 24, 2024

Applicable spec:

Overview

Adds the vale action with the Canonical vale styles.

The Canonical styles are hosted at praecepta and we're making use of the recommended workflow that is supplied in the README.md. In addition to our operator-workflows, data-platform-doc-tools is using the same workflow.

The vale action being used is the official one.

Rationale

Vale is gaining adoption as a doc style checker, hence including it in our workflow to test things out (currently it will not fail the action).

Workflow Changes

The test.yaml contains a style checker job after woke.

Checklist

  • [x ] The contributing guide was applied
  • [x ] The PR is tagged with appropriate label (urgent, trivial, complex)

@merkata merkata requested a review from a team as a code owner September 24, 2024 10:44
@merkata
Copy link
Contributor Author

merkata commented Sep 24, 2024

@arturo-seijas @erinecon @gregory-schiano this is mergeable now, note that for github runners I have to explicitly install tree and ruby-rubygems for now. Using this for a while should give us insights into what to improve in the docs/ folders of our charms and also contribute back to https://github.com/canonical/praecepta that hosts the Canonical styles.
Idea is to test this early on and see how that works, no roadmap item or anything, pure dev fun atm.

.github/workflows/test.yaml Outdated Show resolved Hide resolved
merkata and others added 2 commits October 11, 2024 17:12
Co-authored-by: Christopher Bartz <[email protected]>
Signed-off-by: Mariyan Dimitrov <[email protected]>
@cbartz
Copy link
Contributor

cbartz commented Nov 14, 2024

@erinecon Can you please comment if this is desired? Its seems to me related to https://warthogs.atlassian.net/browse/ISD-2717 .

@erinecon
Copy link

@erinecon Can you please comment if this is desired? Its seems to me related to https://warthogs.atlassian.net/browse/ISD-2717 .

Yes, this is desired! Thanks for following up on this PR.

@cbartz cbartz self-assigned this Nov 21, 2024
@cbartz
Copy link
Contributor

cbartz commented Nov 21, 2024

Copy link
Contributor

@cbartz cbartz left a comment

Choose a reason for hiding this comment

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

LGTM

@cbartz cbartz merged commit e61bc10 into main Nov 21, 2024
84 checks passed
@cbartz cbartz deleted the feat/add-vale branch November 21, 2024 18:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants