Skip to content

Generate mind map automatically (via GHA) - #348

Merged
spier merged 54 commits into
mainfrom
auto-generate-mindmap
Sep 1, 2021
Merged

Generate mind map automatically (via GHA)#348
spier merged 54 commits into
mainfrom
auto-generate-mindmap

Conversation

@spier

@spier spier commented Aug 30, 2021 •
edited
Loading

Copy link
Copy Markdown
Member

This is part of the solution for #162.

Assuming that a fully automated solution would consist of these steps:

  1. consolidate the categories from all patterns/*.md files into innersource-program-mind-map.md (this is different from how this is working today)
  2. generating the mindmap HTML (innersource-program-mind-map.html)
  3. generating a screenshot from that HTML, that can be used in our book

This PR solves 2 + 3.

Tasks

  • update README
  • decide what to do with book/innersource-program-mind-map.PNG => we are now just keeping this file in the folder /pattern-categorization, and link to it from /book
  • limit GHA execution to cases where the source files for markmap have been changed
  • make the GHA execution faster (possibly with caching dependencies via actions/setup-node) - tried this for a bit but without major time savings

Update

I noticed that solution step (1) above wasn't necessarily intended as part of #162.
Hence I will leave it out of this PR, and instead file a new issue that describes the idea behind (1) in more detail.

@spier spier added the ⚙️ Type - Meta Improving how we collaborate in this repo is the main focus of this issue / PR label Aug 31, 2021
@spier spier changed the title [WIP] Trying out GHA to generate mindmap automatically [WIP] Using GHA to generate mindmap automatically Aug 31, 2021
@spier spier self-assigned this Aug 31, 2021
@spier spier changed the title [WIP] Using GHA to generate mindmap automatically [WIP] Generate mindmap automatically (GHA) Aug 31, 2021
@spier spier changed the title [WIP] Generate mindmap automatically (GHA) Generate mind map automatically (via GHA) Sep 1, 2021
@spier
spier marked this pull request as ready for review September 1, 2021 10:36
@spier

spier commented Sep 1, 2021

Copy link
Copy Markdown
Member Author

@fwan2000 you may find this interesting. I found a way to use a GitHub action to autogenerate the mindmap on any change to the source file. See here.

@spier
spier merged commit fb5d31e into main Sep 1, 2021
@spier
spier deleted the auto-generate-mindmap branch September 1, 2021 10:44
This was referenced Sep 1, 2021
Closed
Open
@lenucksi

lenucksi commented Sep 1, 2021

Copy link
Copy Markdown
Member

Cool stuff! 🎉

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@cewilliams cewilliams Awaiting requested review from cewilliams cewilliams is a code owner
@lenucksi lenucksi Awaiting requested review from lenucksi lenucksi is a code owner
@NewMexicoKid NewMexicoKid Awaiting requested review from NewMexicoKid NewMexicoKid is a code owner

Assignees

@spier spier

Labels

⚙️ Type - Meta Improving how we collaborate in this repo is the main focus of this issue / PR

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@spier @lenucksi