https://github.com/nobe4/girssa
Github RSS Action
https://github.com/nobe4/girssa
Last synced: 11 months ago
JSON representation
Github RSS Action
- Host: GitHub
- URL: https://github.com/nobe4/girssa
- Owner: nobe4
- License: mit
- Created: 2022-06-05T09:40:22.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2024-01-17T14:38:00.000Z (over 2 years ago)
- Last Synced: 2025-04-22T22:18:11.458Z (over 1 year ago)
- Language: JavaScript
- Homepage:
- Size: 2.93 MB
- Stars: 4
- Watchers: 2
- Forks: 0
- Open Issues: 22
-
Metadata Files:
- Readme: README.md
- Contributing: docs/CONTRIBUTING.md
- License: LICENSE
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
```
_____ _____ _____ _____ _____
/ ____||_ _|| __ \ / ____|/ ____| /\
| | __ | | | |__) || (___ | (___ / \
| | |_ | | | | _ / \___ \ \___ \ / /\ \
| |__| | _| |_ | | \ \ ____) |____) |/ ____ \
\_____||_____||_| \_\|_____/|_____//_/ \_\
GitHub RSS Action
```
[](https://github.com/nobe4/girssa/actions/workflows/check-dist.yml)
[](https://github.com/nobe4/girssa/actions/workflows/codeql-analysis.yml)
[](https://github.com/nobe4/girssa/actions/workflows/test.yml)
[](https://github.com/nobe4/girssa/actions/workflows/coverage.yml)
# Girssa
Girssa is a minimalist and easy to use [RSS](https://en.wikipedia.org/wiki/RSS) reader.
It leverages GitHub in two ways: _actions_ for automation and _issues_ for storage.
To use it: write a [_sources_](./docs/sources.example.json) file and install the action in a repository.
Done :sparkles:
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.
```yaml
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@
```
:warning: GitHub actions can cost you. Make sure to check [the billing doc](https://docs.github.com/en/actions/learn-github-actions/usage-limits-billing-and-administration) to not have any bad surprise :money_with_wings:.
### Sources
See [`sources`](./docs/SOURCES.md)
### Configuration
You can configure Girssa with some options, see [`action.yml`](./action.yml) for details.
E.g.:
```yaml
jobs:
run:
runs-on: ubuntu-latest
steps:
- uses: nobe4/girssa@
with:
repository:
token:
noop: true
```
## Contributing
See [the contributing guide](./docs/CONTRIBUTING.md)
## License
See [LICENSE](./LICENSE)