Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/JasonEtco/rss-to-readme
📡📝 A GitHub Action that updates a section of a README from an RSS feed.
https://github.com/JasonEtco/rss-to-readme
Last synced: 1 day ago
JSON representation
📡📝 A GitHub Action that updates a section of a README from an RSS feed.
- Host: GitHub
- URL: https://github.com/JasonEtco/rss-to-readme
- Owner: JasonEtco
- License: mit
- Created: 2020-05-28T01:03:02.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-11-06T08:07:47.000Z (3 days ago)
- Last Synced: 2024-11-06T09:19:58.251Z (3 days ago)
- Language: TypeScript
- Homepage:
- Size: 1.32 MB
- Stars: 222
- Watchers: 6
- Forks: 21
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- AwesomeGithubProfileTemplates - rss-to-readme - GitHub Action that updates a section of a README from an RSS feed (Resources / Tools)
README
📡📝
RSS to README Action
A GitHub Action that updates a section of a README from an RSS feed.
---
## Usage
You can use this action in a workflow file like any other:
```yml
name: Update this repo's README
on:
schedule:
# Once a day at 8 AM
- cron: 0 8 * * *
jobs:
update:
runs-on: ubuntu-latest
steps:
- uses: JasonEtco/rss-to-readme@v1
with:
feed-url: https://jasonet.co/rss.xml
readme-section: feed
```
### Options
#### `feed-url`:
The URL to an RSS feed. It's assumed that the RSS feed follow the standard format!
#### `readme-section`:
The name of the section of your README to update. This uses [`JasonEtco/readme-box`](https://github.com/JasonEtco/readme-box) to replace a section of the README and update the file. Your README should contain HTML comments like this, where `feed` is the the value of `readme-section`:
```html
### Example RSS feed:
...
```
You can inspect this repo's README to see it in use!
#### `empty-commits`: (default: true)
Set this to `false` to not commit anything when this action run but the section didn't change.
#### `max` (default: 5)
The maximum number of items to show from the RSS feed. Defaults to `5`!
#### `template` (default: `"* [{{ title }}]({{ link }}))"`)
You can provide a [Mustache](https://github.com/janl/mustache.js) template to use when rendering each item in the feed. These will be joined by a newline (`\n`). For example:
```yaml
- uses: JasonEtco/rss-to-readme@v1
with:
feed-url: https://jasonet.co/rss.xml
template: "> {{ excerpt }}\n\n[Read more!]({{ url }})"
```
#### `branch` (default: github.repository.default_branch)
You can provide the target branch to update instead of the default.
#### `path` (default: 'README.md')
Path to the README file to update.
### Example RSS feed:
* [CODEOWNERS-driven file organization](https://jasonet.co/posts/codeowners-driven-organization/)
* [Remix first impressions](https://jasonet.co/posts/remix-first-impressions/)
* [On "Spike work"](https://jasonet.co/posts/on-spike-work/)
* [Assorted thoughts on documentation](https://jasonet.co/posts/thoughts-on-docs/)
* [On "lurking"](https://jasonet.co/posts/on-lurking/)
> This started as a little proof-of-concept for @brianlovin!