Conversation
There was a problem hiding this comment.
Pull request overview
This PR introduces Markdown linting via rumdl and aligns existing documentation files with the linter’s expectations, while also consolidating/adjusting CI checks to ensure generated docs are committed.
Changes:
- Add rumdl configuration (
.rumdl.toml) and a new rumdl job in the lint workflow. - Reformat multiple Markdown/MDX docs (code fences, headings, spacing) to satisfy lint rules and keep generated web docs in sync.
- Move the “docs compiled / generated output is committed” check into the existing unit-tests workflow and remove the dedicated workflow.
Reviewed changes
Copilot reviewed 11 out of 11 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
README.md |
Minor Markdown formatting changes (spacing/code fences). |
example/README.md |
Adjust shell command example formatting. |
docs/README.md |
Adjust code fence language and list formatting. |
docs/builders/scaleway.mdx |
Normalize headings and code example sections. |
.web-docs/README.md |
Keep compiled web docs aligned with source docs formatting. |
.web-docs/components/builder/scaleway/README.md |
Keep compiled builder docs aligned with updated formatting. |
.rumdl.toml |
New rumdl rule configuration. |
.github/workflows/unit-tests.yml |
Add “generated files are committed” check after make generate. |
.github/workflows/lint.yml |
Rename workflow + add rumdl job. |
.github/workflows/ensure-docs-compiled.yaml |
Remove standalone docs compilation check workflow. |
.github/DEBUG.md |
Adjust code fence language to shell. |
Comments suppressed due to low confidence (2)
.github/workflows/lint.yml:24
- The
rumdljob checks out the repository using an unpinnedactions/checkoutref, which is inconsistent with the rest of the workflows that pin actions to a specific commit SHA. Pinning avoids unexpected CI changes when the upstream tag moves.
.github/workflows/lint.yml:27 - The
rumdlGitHub Action is configured to run twice (rvben/rumdl@v0is used in two consecutive steps). This duplicates CI work and can produce redundant output; keep a single step to run the linter once.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
…ntain permissions' Co-authored-by: Copilot Autofix powered by AI <62310815+github-advanced-security[bot]@users.noreply.github.com>
pypaut
approved these changes
Jun 17, 2026
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #333 +/- ##
=====================================
Coverage 7.54% 7.54%
=====================================
Files 38 38
Lines 1604 1604
=====================================
Hits 121 121
Misses 1459 1459
Partials 24 24 ☔ View full report in Codecov by Harness. |
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
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.
DELETE THIS TEMPLATE BEFORE SUBMITTING
In order to have a good experience with our community, we recommend that you
read the contributing guidelines for making a PR, and understand the lifecycle
of a Packer Plugin PR:
https://github.com/scaleway/packer-plugin-scaleway/blob/main/.github/CONTRIBUTING.md#opening-an-pull-request
Describe the change you are making here!
Please include tests. We recommend looking at existing tests as an example.
If your PR resolves any open issue(s), please indicate them like this so they will be closed when your PR is merged:
Closes #xxx
Closes #xxx