A GitHub action that can be used with a TIL repo to autogenerate a README.md.
I came across this post (Using a self-rewriting README powered by GitHub Actions to track TILs) from Simon Willison on Hacker News and thought it was a pretty good idea. The author talks about how he uses TILs to learn in public and how he uses GitHub actions to automatically create a formatted README.md summary of his TILs when he pushes code. I saw this and thought, hey if we use GitHub actions to do this, why not make a GitHub Action?
If you have a TIL repository with TILs organized into folders by category you can add this GitHub action to generate a nice README when you push a new TIL.
Add this Action to your TIL repo. Here's an example:
name: Build README
on:
push:
branches:
- master
paths-ignore:
- README.md
jobs:
build:
runs-on: ubuntu-latest
steps:
- name: Check out repo
uses: actions/checkout@v2
with:
# necessary for github-action-til-autoformat-readme
fetch-depth: 0
- name: Autoformat README
uses: cflynn07/[email protected]
with:
description: |
A collection of concrete writeups of small things I learn daily while working
and researching. My goal is to work in public. I was inspired to start this
repository after reading Simon Wilson's [hacker new post][1], and he was
apparently inspired by Josh Branchaud's [TIL collection][2].
Quick test change. Another test
footer: |
[1]: https://simonwillison.net/2020/Apr/20/self-rewriting-readme/
[2]: https://github.com/jbranchaud/tilYou can see an example of a sample TIL repo with the action here:
cflynn07/til-autoformat-action-example
# TIL
> Today I Learned
A collection of concrete writeups of small things I learn daily while working
and researching. My goal is to work in public. I was inspired to start this
repository after reading Simon Wilson's [hacker new post][1], and he was
apparently inspired by Josh Branchaud's [TIL collection][2].
_4 TILs and counting..._
---
### Categories
- [bang](#bang)
- [bar](#bar)
- [biz](#biz)
### [bang](#bang)
- [Bang1-test here](bang/bang1-test.md)
### [bar](#bar)
- [Bar2 test here](bar/bar2-test.md)
### [biz](#biz)
- [fooballs test hahhaha](biz/fooballs-test.md)
- [bizbabbasdf](biz/fooballs-test2.md)
[1]: https://simonwillison.net/2020/Apr/20/self-rewriting-readme/
[2]: https://github.com/jbranchaud/til
TIL Auto-Format README is not certified by GitHub. It is provided by a third-party and is governed by separate terms of service, privacy policy, and support documentation.
Tags
(1)TIL Auto-Format README is not certified by GitHub. It is provided by a third-party and is governed by separate terms of service, privacy policy, and support documentation.