Skip to content

doc/guides: disable npm funding message#21799

Merged
crasbe merged 1 commit intoRIOT-OS:masterfrom
crasbe:pr/guides_disable_fund
Oct 16, 2025
Merged

doc/guides: disable npm funding message#21799
crasbe merged 1 commit intoRIOT-OS:masterfrom
crasbe:pr/guides_disable_fund

Conversation

@crasbe
Copy link
Copy Markdown
Contributor

@crasbe crasbe commented Oct 16, 2025

Contribution description

The Make output for make doc-starlight is quite spammy due to npm. This PR disables the xxx projects are looking for funding and (optionally) the audit message.

The latter is up for discussion, but since make doc-starlight is creating a local instance, the security impact is low anyways and there are always security messages popping up, except you have updated everything 30 seconds ago.

Testing procedure

Current master:

cbuec@W11nMate:~/RIOTstuff/riot-guides/RIOT$ make doc-starlight
"make" -C doc/starlight dev
make[1]: Entering directory '/home/cbuec/RIOTstuff/riot-guides/RIOT/doc/starlight'
Generating Code of Conduct documentation...
Generating Governance documentation...
Generating Lost and Found documentation...
Generating Coding Conventions documentation...
Generating C++ Coding Conventions documentation...
Installing starlight...

added 453 packages, and audited 454 packages in 6s

224 packages are looking for funding
  run `npm fund` for details

5 moderate severity vulnerabilities

Some issues need review, and may require choosing
a different dependency.

Run `npm audit` for details.
Starlight installed successfully.
Linking RIOT documentation source files...
Starting starlight live server...

> [email protected] dev
> astro dev

13:29:14 [types] Generated 1ms
13:29:14 [content] Syncing content
13:29:17 [content] Synced content

 astro  v5.14.1 ready in 4643 ms

┃ Local    http://localhost:4321/
┃ Network  use --host to expose

13:29:17 watching for file changes...

This PR:

cbuec@W11nMate:~/RIOTstuff/riot-guides/RIOT$ make doc-starlight
"make" -C doc/starlight dev
make[1]: Entering directory '/home/cbuec/RIOTstuff/riot-guides/RIOT/doc/starlight'
Generating Code of Conduct documentation...
Generating Governance documentation...
Generating Lost and Found documentation...
Generating Coding Conventions documentation...
Generating C++ Coding Conventions documentation...
Installing starlight...

added 453 packages, and audited 454 packages in 6s

5 moderate severity vulnerabilities

Some issues need review, and may require choosing
a different dependency.

Run `npm audit` for details.

Starlight installed successfully.
Linking RIOT documentation source files...
Starting starlight live server...

> [email protected] dev
> astro dev

13:30:46 [types] Generated 0ms
13:30:47 [content] Syncing content
13:30:50 [content] Synced content

 astro  v5.14.1 ready in 4695 ms

┃ Local    http://localhost:4321/
┃ Network  use --host to expose

13:30:50 watching for file changes...

This PR (with disabled audit messages):

cbuec@W11nMate:~/RIOTstuff/riot-guides/RIOT$ make doc-starlight
"make" -C doc/starlight dev
make[1]: Entering directory '/home/cbuec/RIOTstuff/riot-guides/RIOT/doc/starlight'
Generating Code of Conduct documentation...
Generating Governance documentation...
Generating Lost and Found documentation...
Generating Coding Conventions documentation...
Generating C++ Coding Conventions documentation...
Installing starlight...

added 453 packages in 6s

Starlight installed successfully.
Linking RIOT documentation source files...
Starting starlight live server...

> [email protected] dev
> astro dev

13:29:56 [types] Generated 0ms
13:29:57 [content] Syncing content
13:30:00 [content] Synced content

 astro  v5.14.1 ready in 4730 ms

┃ Local    http://localhost:4321/
┃ Network  use --host to expose

13:30:00 watching for file changes...

Issues/PRs references

None.

@crasbe crasbe added Type: enhancement The issue suggests enhanceable parts / The PR enhances parts of the codebase / documentation CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR CI: skip compile test If set, CI server will run only non-compile jobs, but no compile jobs or their dependent jobs labels Oct 16, 2025
@github-actions github-actions bot added the Area: doc Area: Documentation label Oct 16, 2025
@crasbe
Copy link
Copy Markdown
Contributor Author

crasbe commented Oct 16, 2025

Also ping @LasseRosenow :)

@riot-ci
Copy link
Copy Markdown

riot-ci commented Oct 16, 2025

Murdock results

✔️ PASSED

e53bb49 doc/guides: disable npm funding message

Success Failures Total Runtime
1 0 1 01m:13s

Artifacts

Copy link
Copy Markdown
Member

@AnnsAnns AnnsAnns left a comment

Choose a reason for hiding this comment

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

Can not be scared by what I can not see. 🙈 🙉

(Makes sense for our static site 👍 Lets wait for @LasseRosenow though before merging just to be sure)

@crasbe crasbe force-pushed the pr/guides_disable_fund branch from a1977b8 to e53bb49 Compare October 16, 2025 11:51
@crasbe crasbe enabled auto-merge October 16, 2025 11:54
@crasbe crasbe added this pull request to the merge queue Oct 16, 2025
Merged via the queue into RIOT-OS:master with commit 28ca3d1 Oct 16, 2025
26 checks passed
@crasbe crasbe deleted the pr/guides_disable_fund branch October 16, 2025 12:26
@benpicco benpicco added this to the Release 2025.10 milestone Dec 3, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Area: doc Area: Documentation CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR CI: skip compile test If set, CI server will run only non-compile jobs, but no compile jobs or their dependent jobs Type: enhancement The issue suggests enhanceable parts / The PR enhances parts of the codebase / documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants