README.md

quote-box

Receive a random quote, and pushes to Gist with GitHub Actions.

The quotes' API is provided by Quotable.

Tip

For more “pinned gists” projects, visit
https://github.com/matchai/awesome-pinned-gists.

Usage

Use a GitHub Actions workflow to execute quote-box. Here's an example:

name: Get Quote

on:
  workflow_dispatch:
  schedule:
    - cron: 0 0 * * *                             # execution frequency and time

jobs:
  push:
    runs-on: ubuntu-22.04
    steps:
    - name: Download and Push
      uses: rnmeow/[email protected]
      env:
        GH_TOKEN: ${{ secrets.GH_TOKEN }}         # *
      # Settings
      with:
        gist_id: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx # *
        gist_file_name: Quote                     # *
        tags: technology                          # ref. https://api.quotable.io/tags
        min_length: 10
        max_length: 80
        time_zone: Asia/Taipei

License

(C) 2023, 2024, Connor Kuo. MIT License.