Skip to content

chore: add support for rumdl#333

Merged
remyleone merged 3 commits into
mainfrom
add_rumdl
Jun 17, 2026
Merged

chore: add support for rumdl#333
remyleone merged 3 commits into
mainfrom
add_rumdl

Conversation

@remyleone

Copy link
Copy Markdown
Member

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

Copilot AI review requested due to automatic review settings June 17, 2026 13:04
Comment thread .github/workflows/lint.yml Fixed

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

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 rumdl job checks out the repository using an unpinned actions/checkout ref, 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 rumdl GitHub Action is configured to run twice (rvben/rumdl@v0 is 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.

Comment thread .github/workflows/unit-tests.yml
Comment thread .github/workflows/unit-tests.yml
Comment thread README.md
remyleone and others added 2 commits June 17, 2026 15:10
…ntain permissions'

Co-authored-by: Copilot Autofix powered by AI <62310815+github-advanced-security[bot]@users.noreply.github.com>
@codecov-commenter

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 7.54%. Comparing base (db52e54) to head (9a9d7c1).
✅ All tests successful. No failed tests found.

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.
📢 Have feedback on the report? Share it here.

@remyleone remyleone added this pull request to the merge queue Jun 17, 2026
Merged via the queue into main with commit f882544 Jun 17, 2026
9 checks passed
@remyleone remyleone deleted the add_rumdl branch June 17, 2026 13:36
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.

5 participants