ci: Streamline documentation workflow and update pre-commit hooks#2
Merged
ci: Streamline documentation workflow and update pre-commit hooks#2
Conversation
The documentation workflow duplicates logic across multiple separate steps for linting and link checking, making it verbose and harder to maintain when adding or removing markdown files. Additionally, pre-commit hooks are outdated and markdown linting runs only in CI, delaying feedback until after push. Consolidate markdown link checking into a single loop-based step that discovers files dynamically, reducing duplication and simplifying future maintenance. Move markdownlint from CI to pre-commit hooks to catch formatting issues locally before commit. Update pre-commit hook versions to their latest releases for bug fixes and improvements. Signed-off-by: Javier Tia <javier.tia@linaro.org>
The integration test step in the GitHub Actions workflow is never executed because the required secrets (GITLAB_TOKEN and GITLAB_REPO) are not configured in the repository. This conditional step adds unnecessary complexity to the workflow definition and creates confusion about whether integration tests are actually part of CI. Remove the integration test step from the workflow. Integration tests can be run locally when needed with the appropriate environment variables, but they are not required for the standard CI pipeline. Signed-off-by: Javier Tia <javier.tia@linaro.org>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The documentation workflow duplicates logic across multiple separate steps for linting and link checking, making it verbose and harder to maintain when adding or removing markdown files. Additionally, pre-commit hooks are outdated and markdown linting runs only in CI, delaying feedback until after push.
Consolidate markdown link checking into a single loop-based step that discovers files dynamically, reducing duplication and simplifying future maintenance. Move markdownlint from CI to pre-commit hooks to catch formatting issues locally before commit. Update pre-commit hook versions to their latest releases for bug fixes and improvements.