You're viewing an older version of this GitHub Action. Do you want to see the latest version instead?
GitHub Action
Notes Summary README
v1.0.3
This GitHub Action generates a README.md
summary for your notes repository. You can use the workflow to generate a list of items in your repository.
First, setup your repository with this file structure:
βββ README.md
βββ .github
β βββ workflows
β βββ readme.yml
βββ notes
βββ 2019
β βββ note-name.md
β βββ another-note-name.md
βββ 2020
βββ a-third-note-name.md
Add the following comment in your README.md
file. This will be replaced with a summary of the notes you've participated it:
<!--notes--><!--/notes-->
Finally, create the GitHub Actions workflow in .github/workflows/readme.yml
:
name: Readme CI
on:
push:
branches: [master]
schedule:
- cron: "0 0 * * *"
jobs:
release:
name: Update README
runs-on: ubuntu-18.04
steps:
- name: Checkout
uses: actions/checkout@v2
- name: Update note summary
uses: AnandChowdhary/notes-summary@master
with:
token: "${{ secrets.GITHUB_TOKEN }}"
Your README.md
file should then contains a summary of the notes in the notes
directory:
You can see this example repository: https://github.com/AnandChowdhary/notes
- Code: MIT Β© Anand Chowdhary
- "GitHub" is a trademark of GitHub, Inc.