Skip to content

CI: add _readme-gofmt tool to reformat Go code in README#1889

Merged
dolmen merged 1 commit into
masterfrom
dolmen/readme-gofmt-pure-go
May 13, 2026
Merged

CI: add _readme-gofmt tool to reformat Go code in README#1889
dolmen merged 1 commit into
masterfrom
dolmen/readme-gofmt-pure-go

Conversation

@dolmen
Copy link
Copy Markdown
Collaborator

@dolmen dolmen commented May 11, 2026

Summary

Add _readme-gofmt internal tool to replace the use of mdsf, a JS tool.

Changes

  • _readme-gofmt applies 'gofmt -s' to each Go block in README.md. The output is a diff, if any change has been detected.
  • CI scripts/jobs are updated to drop mdsf and use _readme-gofmt

Motivation

Drop use of mdsf, which is installed via npm. So many supply chain attacks via npm these days...

This reduces supply chain concerns with internal tooling in pure Go using only stdlib.

Related changes

Cc: @ alexandear

@dolmen dolmen requested a review from ccoVeille May 11, 2026 14:24
@dolmen dolmen added dependencies Pull requests that update a dependency file internal/cleanup Internal change to ease maintenance without external impact labels May 11, 2026
@dolmen dolmen force-pushed the dolmen/readme-gofmt-pure-go branch 2 times, most recently from c979fed to 7a9f41e Compare May 11, 2026 15:22
Comment thread .ci.readme.fmt.sh Outdated
Comment thread _readme-gofmt/main.go Outdated
Comment thread _readme-gofmt/main.go Outdated
@dolmen dolmen force-pushed the dolmen/readme-gofmt-pure-go branch 2 times, most recently from 1d0fd37 to 96965c2 Compare May 12, 2026 04:58
@dolmen dolmen requested a review from alexandear May 12, 2026 05:00
Add _readme-gofmt tool to replace the use of mdsf, a JS tool.
_readme-gofmt applies 'gofmt -s' to each Go block in README.md.
The output is a diff, if any change has been detected.

This reduces supply chain concerns by dropping an external JS tool which
is replaced with an internal tooling in pure Go.
@dolmen dolmen force-pushed the dolmen/readme-gofmt-pure-go branch from 96965c2 to ef0097b Compare May 12, 2026 05:01
@dolmen dolmen added the github_actions Pull requests that update GitHub Actions code label May 12, 2026
Comment thread _readme-gofmt/main.go
@dolmen dolmen merged commit d204718 into master May 13, 2026
20 checks passed
@dolmen dolmen deleted the dolmen/readme-gofmt-pure-go branch May 14, 2026 17:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

dependencies Pull requests that update a dependency file github_actions Pull requests that update GitHub Actions code internal/cleanup Internal change to ease maintenance without external impact

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants