Skip to content

tools: provide tool to create doxygen maintainer list#21062

Closed
miri64 wants to merge 6 commits intoRIOT-OS:masterfrom
miri64:tools/feat/maintainer-list
Closed

tools: provide tool to create doxygen maintainer list#21062
miri64 wants to merge 6 commits intoRIOT-OS:masterfrom
miri64:tools/feat/maintainer-list

Conversation

@miri64
Copy link
Copy Markdown
Member

@miri64 miri64 commented Dec 3, 2024

Contribution description

This has been long discussed, but never set into action. Given that MAINTAINING.md now references a non-existent wiki page (which was outdated before its deletion), I say it is about time.

This basically takes the information from the RIOT-OS org teams and combines it with the information in CODEOWNERS. Caveat: One needs a token with read:org permission to get the teams.

I tried to match the CODEOWNERS patterns to doxygen groups somehow, but there either too little overlap (only @jia200x who chose documentation as an area of expertise had matching doxygen groups) or too much (e.g., @kaspar030 then received nearly every CPU, because he is interested in pm.c which have an @ingroup for each respective CPU or their periph interface...), so I just gave up on that.

Testing procedure

If all goes well, Murdock should just have a new maintainers-list.html in its Documentation preview.

Issues/PRs references

None so far.

@miri64 miri64 added the Type: new feature The issue requests / The PR implemements a new feature for RIOT label Dec 3, 2024
@github-actions github-actions bot added Area: doc Area: Documentation Area: tools Area: Supplementary tools labels Dec 3, 2024
... rather than outdated wiki page.
@miri64 miri64 force-pushed the tools/feat/maintainer-list branch from 187b795 to 4b31bfd Compare December 3, 2024 19:22
@miri64 miri64 added CI: skip compile test If set, CI server will run only non-compile jobs, but no compile jobs or their dependent jobs CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR labels Dec 4, 2024
@riot-ci
Copy link
Copy Markdown

riot-ci commented Dec 4, 2024

Murdock results

✔️ PASSED

1b02020 gh-actions: add maintainer-list workflow

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

Artifacts

@miri64
Copy link
Copy Markdown
Member Author

miri64 commented Dec 4, 2024

Testing procedure

If all goes well, Murdock should just have a new maintainers-list.html in its Documentation preview.

That did not work. :-( @RIOT-OS/ci can you have a look?

@kaspar030
Copy link
Copy Markdown
Contributor

I don't know how that new html is created or where it ends up, but these lines deal with the preview: https://github.com/RIOT-OS/murdock-scripts/blob/931a4136b6efa7d44539826d665ae2b1561e16e1/build.sh#L281

miri64 added a commit to miri64/RIOT that referenced this pull request Dec 6, 2024
This is just the generated result from RIOT-OS#21062 while that PR is under
development
miri64 added a commit to miri64/RIOT that referenced this pull request Dec 6, 2024
This is just the generated result from RIOT-OS#21062 while that PR is under
development
@github-actions github-actions bot added the Area: CI Area: Continuous Integration of RIOT components label Dec 6, 2024
miri64 added a commit to miri64/RIOT that referenced this pull request Dec 6, 2024
This is just the generated result from RIOT-OS#21062 while that PR is under
development
@miri64 miri64 force-pushed the tools/feat/maintainer-list branch from eee5863 to 5fe56c7 Compare December 6, 2024 14:04
@miri64 miri64 force-pushed the tools/feat/maintainer-list branch from 5fe56c7 to 83b01c8 Compare December 6, 2024 14:07
miri64 added a commit to miri64/RIOT that referenced this pull request Dec 6, 2024
This is just the generated result from RIOT-OS#21062 while that PR is under
development
miri64 added a commit to miri64/RIOT that referenced this pull request Dec 6, 2024
This is just the generated result from RIOT-OS#21062 while that PR is under
development
@miri64
Copy link
Copy Markdown
Member Author

miri64 commented Dec 6, 2024

https://github.com/RIOT-OS/RIOT/actions/runs/12201211174/job/34039104721 is failing for this PR since the build was initiated from my fork (where the secret is not present). However, I did some testing on a feature branch. There it worked: https://github.com/RIOT-OS/RIOT/actions/runs/12200980590

@miri64
Copy link
Copy Markdown
Member Author

miri64 commented Dec 6, 2024

Provided RIOT-OS/riot-os.org#141 which might be a better alternative

@miri64
Copy link
Copy Markdown
Member Author

miri64 commented Dec 9, 2024

Closing in favor of RIOT-OS/riot-os.org#141

@miri64 miri64 closed this Dec 9, 2024
dprigoshij pushed a commit to dprigoshij/RIOT that referenced this pull request Mar 24, 2025
This is just the generated result from RIOT-OS#21062 while that PR is under
development
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Area: CI Area: Continuous Integration of RIOT components Area: doc Area: Documentation Area: tools Area: Supplementary tools 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: new feature The issue requests / The PR implemements a new feature for RIOT

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants