_____  _____  _____    _____  _____
 / ____||_   _||  __ \  / ____|/ ____|   /\
| |  __   | |  | |__) || (___ | (___    /  \
| | |_ |  | |  |  _  /  \___ \ \___ \  / /\ \
| |__| | _| |_ | | \ \  ____) |____) |/ ____ \
 \_____||_____||_|  \_\|_____/|_____//_/    \_\

 GitHub        RSS                   Action

Girssa

Girssa is a minimalist and easy to use RSS reader. It leverages GitHub in two ways: actions for automation and issues for storage.

To use it: write a sources file and install the action in a repository.

Done ✨

Girssa sends the RSS items to the repository's issues. You can then consult them freely.

How does it work?

0. The source file is read (sources.read).
1. For each source, the feed is fetched (rss.fetch) and parsed (rss.parse).
2. New items are selected (issues.select).
3. For each new item, an issue is created (issues.create).

Usage and configuration

Usage

You can run Girssa on an automated basis.

name: build rss feed

on:
  workflow_dispatch:
  schedule:
    # Every day at midnight UTC
    - cron: "0 0 * * *"

jobs:
  run:
    runs-on: ubuntu-latest
    steps:
      - uses: nobe4/girssa@<current version>

⚠️ GitHub actions can cost you. Make sure to check the billing doc to not have any bad surprise 💸.

Sources

See sources

Configuration

You can configure Girssa with some options, see action.yml for details.

E.g.:

jobs:
  run:
    runs-on: ubuntu-latest
    steps:
      - uses: nobe4/girssa@<current version>
        with:
          repository: <another/repository>
          token: <token with access to another/repository>
          noop: true

Contributing

See the contributing guide

License

See LICENSE