Skip to content

chore: update documentation, add pre-commit workflow#48

Open
burigolucas wants to merge 3 commits into
redhat-cop:mainfrom
burigolucas:docs/update-documentation-automation
Open

chore: update documentation, add pre-commit workflow#48
burigolucas wants to merge 3 commits into
redhat-cop:mainfrom
burigolucas:docs/update-documentation-automation

Conversation

@burigolucas

Copy link
Copy Markdown
Contributor

Description

This PR adds a new workflow to run the pre-commit hooks on every PR (internal and external) to ensure commits satisfy the pre-commit hook configuration in case the contributor has not enabled it locally. In addition, the pre-commit hooks now include a hook to update the documentation and check whether it is up-to-date. This should avoid out-dated documentation landing in the main branch.

Type of Change

  • feat: A new feature
  • fix: A bug fix
  • docs: Documentation changes
  • style: Formatting, missing semi colons, etc; no code change
  • refactor: Refactoring production code
  • test: Adding missing tests, refactoring tests; no production code change
  • chore: Updating configs, etc; no production code change

Pull Request Title

Note: Please ensure your PR title follows Conventional Commits.
Example: feat: add role

  • I have formatted my PR title correctly.

@burigolucas burigolucas requested a review from sabre1041 as a code owner June 11, 2026 08:02
@burigolucas burigolucas force-pushed the docs/update-documentation-automation branch from 387e513 to 4f3837b Compare June 11, 2026 08:05
@burigolucas burigolucas force-pushed the docs/update-documentation-automation branch 2 times, most recently from 25a736b to 5896f8b Compare June 11, 2026 08:39
@burigolucas burigolucas force-pushed the docs/update-documentation-automation branch from 5896f8b to f9dc74b Compare June 11, 2026 08:41
@burigolucas burigolucas changed the title chore: update documentation, add pre-commit workflow not valid chore: update documentation, add pre-commit workflow Jun 11, 2026
@burigolucas burigolucas changed the title not valid chore: update documentation, add pre-commit workflow chore: update documentation, add pre-commit workflow Jun 11, 2026
@burigolucas burigolucas deployed to external-ci June 11, 2026 08:59 — with GitHub Actions Active
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant