GitHub Action
AniList readme workflow
Simple workflow that will add your latest activity into your readme!
This was made by a person who primarily uses TypeScript and doesn't know how to use Python.
Simply add this to your README.md
# 🌸 My recent AniList activity
<!-- ANILIST_ACTIVITY:start -->
<!-- ANILIST_ACTIVITY:end -->and setup the workflow file at .github/workflows/anilist.yml like this:
name: AniList readme workflow
on:
schedule:
# Runs every hour
- cron: "0 * * * *"
workflow_dispatch: # for manual debuging
jobs:
update-readme-with-anilist:
name: Update this repo's README with latest AniList activites
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: AniList readme workflow
uses: pxseu/anilist-readme@senpai # latest version
with:
user_id: YOUR_USER_ID # or
user_name: YOUR_USER_NAME| Option | Description | Default | Required |
|---|---|---|---|
user_id |
Your AniList user id | "" | True |
user_name |
Your AniList username | "" | True |
max_post_count |
A number from 1 to 50 limiting the ammount of posts | "5" | False |
preferred_language |
The language of the list content (e.g. Romaji, English, Native) | "english" | False |
timezone |
Timezone of the list content (e.g. Europe/Berlin) | "UTC" | False |
date_format |
Date format of the list content (e.g. {D}/{M or MW}/{Y} {h}:{m}) | "{h}:{m} {D} {MW} {Y}" | False |
readme_path |
Path to the readme file to edit | "./README.md" | False |
gh_token |
Authorized github token | ${{ github.token }} | False |
commit_message |
A message to use when commiting | "Update AniList activity in README.md" | False |
commit_username |
The username for the commiter | "GitHub Action" | False |
commit_email |
The email for the commiter | "action@github.com" | False |
Note: Eiter
user_idoruser_nameis required!
I recommend you leave the defaultcommit_usernameandcommit_email
Fordate_formatmonths: {M} will result in a number (e.g '3') & {MW} will result in a string (e.g 'March')
If you're unsure what's your User ID on AniList follow the quide below
If you change your username frequently or you're unsure what your user id is, you can use the AniList API to get it.
Head on over to https://anilist.co/graphiql and input the query below and replace YOUR_USERNAME with your username.
query {
User(name: "YOUR_USERNAME") {
id
name
}
}The query above will return your username and your id which you can use for this action.
You can find it on my profile!