Advent README Stars
This action adds and maintains a stars report in your README based on your Advent of Code progress.
Example Table
2021 Results
| Day | Part 1 | Part 2 |
|---|---|---|
| Day 1 | |
|
| Day 2 | |
|
Quickstart
Add this line somewhere in your README.md:
<!--- advent_readme_stars table --->
Make a note of your user ID and add your session cookie to your repo as a secret called AOC_SESSION. To see how to find these values, see those sections in the spec below.
Add this action to your repo as .github/workflows/readme-stars.yml, pasting in your user ID and the leaderboard ID to pull data from (or remove this argument to default to your own private leaderboard):
name: Update README ⭐
on:
schedule:
- cron: "51 */4 * * *" # Every 4 hours
workflow_dispatch:
jobs:
update-readme:
runs-on: ubuntu-latest
steps:
- uses: actions/[email protected]
- uses: k2bd/[email protected]
with:
userId: 1234567
leaderboardId: 9876543
sessionCookie: ${{ secrets.AOC_SESSION }}
- uses: stefanzweifel/[email protected]
with:
commit_message: Update README stars
If you want to adjust the cron expression, please remember to schedule your jobs such that you respect the Advent of Code request of running automated requests at a rate of no more than 1 per 15 minutes.
Action Spec
userId
Required
Your Advent of Code user ID. To get this, go to your Go to settings. The user ID is displayed in the first option of the question "What would you like to be called?":
( ) (anonymous user #<your ID>)
( ) ....
sessionCookie
Required
Your Advent of Code session cookie. To get this, press F12 anywhere on the Advent of Code website to open your browser developer tools. Look in your Cookies under the Application or Storage tab, and copy out the session cookie. This should be stored as a repository secret, not pasted directly into the action or any other publicly viewable place.
leaderboardId
Optional - default userId value
Your Advent of Code leaderboard ID. To get this, go to your Go to leaderboard and press 'View'. The leaderboard ID is at the end of the URL:
https://adventofcode.com/2021/leaderboard/private/view/(leaderboard ID)
tableMarker
Optional - default <!--- advent_readme_stars table --->
This is the string that marks the table location in your README file. The action will only work if it finds this marker in your file, on its own line. You should only add it once, and then let the action do its work.
Change this value if, for example, you'd like different actions maintaining different year results. However, remember to schedule your jobs such that you respect the Advent of Code request of running automated requests at a rate of no more than 1 per 15 minutes.
starSymbol
Optional - default
The symbol that will mark completed parts in your table.
year
Optional - default is year of the most recent advent
Year to get results for. By default, it will get results for the year of the most recent advent. That is, this year if it's December, otherwise last year.
headerPrefix
Optional - default ##
Prefix for the section header added before the table. Should be some kind of Markdown header level.
readmeLocation
Optional - default README.md
Location of the README file to edit.
20 Sep 17, 2022
1 Oct 27, 2021
2 Sep 16, 2021
12 Dec 13, 2022
25 Nov 26, 2022
150 Jan 04, 2023
445 Jan 03, 2023
53 Nov 25, 2022
2 Jan 02, 2022
2 Oct 11, 2022
80 Dec 22, 2022
2 Jul 28, 2022
1 Dec 17, 2021
123 Dec 17, 2022
4 Feb 05, 2022
3.4k Jan 01, 2023
2 Feb 09, 2022
2 Dec 10, 2021
4 Dec 13, 2022
31 Jul 30, 2021