search

InnerSourceCommons / awesome-innersource

Awesome InnerSource Content
Creative Commons Attribution Share Alike 4.0 International
32 stars 2 forks source link

Add auto-generation of TOC #7

Closed spier closed 2 years ago

spier commented 2 years ago

Adding a GHA to automatically update the Table of Contents (TOC).

While I suspect that the sections we use in the README won't change that often, it is nice to automatically keep the ToC up-to-date. That way contributors don't have to know anything about this.

Also add @pmarliz as CODEOWNER, as he is the de-facto-owner of this repo at the moment anyways :)

spier commented 2 years ago

@pmalirz what do you think about this approach to auto-generate the TOC?

The PR isn't 100% working yet.

The issues that I found so far are:

1) The toc.yaml needs to run before the main.yaml. Otherwise awesome-lint complains that the TOC is missing or incorrect. I could merge them into a single file but that would be too easy :) 2) I found that my IDE (VS Code) tries to automatically update the TOC within my editor. Not sure why. Those update might then lead to conflicts with the TOC generated via the GHA.

pmalirz commented 2 years ago

So maybe just maintain it manually. Lets keep it simple, less problems. Magic generators are usually confusing for people. Some parts you have to update and some are updated for you. Especially that in our case toc will be updated rarely so really toc is effortless.

spier commented 2 years ago

Yeah, that's also a good point. Fine by me :)

What do you think about introducing the CODEOWNERS file though? Should I pull that into a new PR?

spier commented 2 years ago

I opened #8 as it was easy. If you like it, you can just go ahead and merge that one.