thoughtbot / parity

Shell commands for development, staging, and production parity for Heroku apps
https://thoughtbot.com
MIT License
889 stars 57 forks source link

Call dynamic-readme reusable workflow #206

Closed stefannibrasil closed 6 months ago

stefannibrasil commented 6 months ago

We want to have a way to edit our README footer at one place and have the changes from there be propagated to our repos.

By adding this snippet in the README, we call this reusable workflow: https://github.com/thoughtbot/templates/blob/main/.github/workflows/dynamic-readme.yaml that renders and updates the README footer dynamically.

geoffharcourt commented 6 months ago

@stefannibrasil happy to approve this if you can show me a place where this is already implemented on an active thoughtbot project so I can do some comparison.

stefannibrasil commented 6 months ago

@stefannibrasil happy to approve this if you can show me a place where this is already implemented on an active thoughtbot project so I can do some comparison.

Sure! When I opened these PRs, we hadn't merged any yet. But here are a few examples:

https://github.com/thoughtbot/resolved https://github.com/thoughtbot/laptop https://github.com/thoughtbot/bourbon https://github.com/thoughtbot/gold_miner https://github.com/thoughtbot/shoulda-matchers?tab=readme-ov-file#about-thoughtbot

Happy to share more details. I'm currently drafting a blog post about the flow of workflows, too.

stefannibrasil commented 6 months ago

@geoffharcourt thanks for the review! Parity has this branch rule of requiring a PR to merge changes into main: https://github.com/thoughtbot/parity/actions/runs/8345435909/job/22840334987

Are you okay with removing that rule? We only had 3 repos with this branch so I'm deferring changing the workflow to open a PR as much as possible. Thanks!

geoffharcourt commented 6 months ago

I'm no longer maintaining Parity or using Heroku, so feel free to take over and update the rules!

stefannibrasil commented 6 months ago

ah, got it! Thanks. Done and the footer has been rendered dynamically: https://github.com/thoughtbot/parity

thanks for the review, Geoff!