Skip to content

Adds Anime Lists to a Markdown file. Sources from AniList

License

Notifications You must be signed in to change notification settings

Glup3/anilist-animes-action

Use this GitHub action with your project
Add this Action to an existing workflow or create a new one
View on Marketplace

Repository files navigation

AniList Animes Action

Example Screenshot

Usage

Add the following keywords somewhere in your Markdown file. The GitHub Action will fill those comments with anime/manga lists.

# My Animes / Mangas

<!-- ANILIST_ANIME:START -->
<!-- ANILIST_ANIME:END -->

<!-- ANILIST_MANGA:START -->
<!-- ANILIST_MANGA:END -->

Create a workflow file workflow-file-name.yml under ./github/workflows. This workflow will trigger automatically every week or you can trigger it manually by dispatching it under GitHub Actions.

on:
  schedule:
    # every week
    - cron: 0 0 * * 0

  workflow_dispatch:

jobs:
  update_animes:
    runs-on: ubuntu-latest
    name: Updates README Anime List
    steps:
      - uses: actions/checkout@v2
      - uses: glup3/anilist-animes-action@v1.1.0
        with:
          ANILIST_USERNAME: 'glup3'
          HEADER_TITLE: "Glup3's cool awesome Animes"

Options

Option Default Value Description Required
COMMIT_USERNAME AniList Action BOT Username used for committing to the repository No
COMMIT_EMAIL anilist-action-bot@github.com Email used for committing to the repository No
COMMIT_MESSAGE Updated Markdown with Users Anime List Message used for committing to the repository No
ANILIST_USERNAME AniList Username Yes
MARKDOWN_PATH ./README.md Path to the markdown file No
HEADER_TITLE My Anime Lists Title for the header section No
IMG_HEIGHT 200 Image height (px) in the grid No
IMG_WIDTH 150 Image width (px) in the grid No
ANIME_GRID true Display animes as grid instead of a list No
MANGA_GRID true Display mangas as grid instead of a list No

Task List

  • User's Anime Lists
  • User's Manga Lists
  • Toggle Lists between GRID and LIST
  • Customize Image Size (GRID)

Motivation

I wanted to play around with GitHub Actions & AniList GraphQL API.

Useful commands

Release a new version

ncc build index.js --license licenses.txt
git add .
git commit -m "updated anilist anime action"
git tag -a -m "Action Release v1" v1.0.0
git push --follow-tags

Delete Tag local and remote

git tag
git push --delete origin tagName
git tag -d tagName