Skip to content

Commit

Permalink
Call dynamic README workflow
Browse files Browse the repository at this point in the history
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.

This workflow has been updated to accommodate repositories that have
main branch rules. To generate the README dynamically, you’ll need to
merge a PR with the README changes. That will trigger the GitHub workflow.
The PR won’t be generated if the footer does not have any differences.
It will only be open if there’s an update to the footer snippet.
  • Loading branch information
Stefanni Brasil committed Apr 15, 2024
1 parent b4022f5 commit 2cf0044
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 14 deletions.
19 changes: 19 additions & 0 deletions .github/workflows/dynamic-readme.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
name: update-templates

on:
push:
branches:
- main
paths:
- README.md
workflow_dispatch:

jobs:
update-templates:
permissions:
contents: write
pull-requests: write
pages: write
uses: thoughtbot/templates/.github/workflows/dynamic-readme.yaml@main
secrets:
token: ${{ secrets.GITHUB_TOKEN }}
17 changes: 3 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -491,21 +491,10 @@ For security issues it's better to contact <[email protected]> (See <https

## License

Clearance is copyright © 2009-2019 thoughtbot. It is free software, and may be
Clearance is copyright © 2009 thoughtbot. It is free software, and may be
redistributed under the terms specified in the [`LICENSE`] file.

[`LICENSE`]: /LICENSE

## About thoughtbot

![thoughtbot](https://thoughtbot.com/brand_assets/93:44.svg)

Clearance is maintained and funded by thoughtbot, inc.
The names and logos for thoughtbot are trademarks of thoughtbot, inc.

We love open source software!
See [our other projects][community] or
[hire us][hire] to design, develop, and grow your product.

[community]: https://thoughtbot.com/community?utm_source=github
[hire]: https://thoughtbot.com/hire-us?utm_source=github
<!-- START /templates/footer.md -->
<!-- END /templates/footer.md -->

0 comments on commit 2cf0044

Please sign in to comment.