https://github.com/kohrongying/readme-the-rss
A Github action to pull RSS feeds into your Github profile README
https://github.com/kohrongying/readme-the-rss
Last synced: about 2 months ago
JSON representation
A Github action to pull RSS feeds into your Github profile README
- Host: GitHub
- URL: https://github.com/kohrongying/readme-the-rss
- Owner: kohrongying
- Created: 2020-08-04T11:08:40.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2023-04-21T07:53:49.000Z (about 2 years ago)
- Last Synced: 2025-02-28T10:18:56.267Z (3 months ago)
- Language: JavaScript
- Homepage: https://github.com/marketplace/actions/readme-the-rss
- Size: 626 KB
- Stars: 19
- Watchers: 2
- Forks: 2
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# README the RSS
Pulls your most recent blog posts through an RSS feed
## How to use
* Add the following section tags to your `README.md` file
```
## My Blog
```
* Create a file in `.github/workflows/blogposts.yml`
```yml
name: Blog post workflow
on:
schedule:
# Runs every day at 3pm UTC (11pm SG)
- cron: '0 15 * * *'
jobs:
pull_blog_rss:
name: Update with latest blog posts
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Get RSS Feed
uses: kohrongying/readme-the-rss@master
with:
feed_url: https://blog.rongying.co/feed.xml
count: 6 # default 5
- name: Commit file changes
run: |
git config --global user.name 'YOUR_USERNAME'
git config --global user.email 'YOUR_GMAIL'
git add .
git diff --quiet --cached || git commit -m "Update README"
- name: Push changes
uses: ad-m/github-push-action@master
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
```
`git diff --quiet --cached` will exit with 1 (there is difference), else exit with 0 if no difference. 1 will trigger the commit.
## Arugments
|Inputs | Default | Description |
|---|---|---|
|`feed_url`|`""`|Required. RSS Url|
|`count` |`5` |Number of posts to display |
|`readme_path`|`README.md`|Path to readme file|