FlatFilers / Guides

Flatfile's Documentation
7 stars 20 forks source link

Update & automate changelog #1160

Open meritmalling opened 4 days ago

meritmalling commented 4 days ago
meritmalling commented 4 days ago

WIP refactoring how the change log is structured in the guides repo. This piece of work is needed to allow other automations to send easy, incremental updates & the guides repo will know how to handle them.

meritmalling commented 2 days ago

WIP change log package that intakes tags and creates a pr to the guides repo.

meritmalling commented 1 day ago

Here's a lil sketch of the automation as it stands to go in. Just for this week I'm sure we can improve. Feedback very welcome @bangarang @NateFerrero!

Image

meritmalling commented 1 day ago

These two PRs on the guides repo should go in for a full e2e test:

https://github.com/FlatFilers/Guides/pull/1161 (First action on guides in diagram) https://github.com/FlatFilers/Guides/pull/1168 (Second action on guides diagram)

When they go in I'll make and post a loom of the process!

TL:DR on process is that any repo with the changelog package installed/configured will, upon releasing a new package (eg @flatfile/react@8.0.0) will trigger these actions and create a PR in the guides repo. That PR still needs to be reviewed by a human before going in (we all agreed, cause hallucinations suck!) then it merged and goes live!

meritmalling commented 20 hours ago

https://github.com/npm/cli/issues/2610 Is unfortunately causing issues for e2e since these actions run in actions.

ToDos to fix: