Releases: armingli/readme-update-actions
Final release
v1.1.1 rename the blog tag
Refactor updator
- simplify the tool
Support multiple rss format
Usage
-
Go to your repository
-
Add the following to your README.md file, you can use any title. Just make sure that you use
<!-- BLOG-LIST-START --><!-- BLOG-LIST-END -->
in your readme. The workflow will replace this comment with the actual blog posts list:# Blog posts <!-- BLOG-LIST-START --> <!-- BLOG-LIST-END -->
-
Create a folder
.github/workflows
inside root of the repository if it doesn't exists. -
Create a new file
readme-update-actions.yml
inside.github/workflows/
with the following contents:
name: Readme Update Blog
on:
schedule: # Run workflow automatically
- cron: '0 * * * *' # Runs every hour
workflow_dispatch: # Run workflow manually (without waiting for the cron to be called), through the GitHub Actions Workflow page directly
jobs:
update-readme-with-blog:
name: Update latest blogs
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v3
- name: Fetch posts
uses: imskr/readme-update-actions@v2
with:
RSS_LIST: "https://blog.metaprogramming.space/rss.xml" # required
MAX_POST: 5 # optional, default 3
COMMIT_USER: "commiter" # optional
COMMIT_EMAIL: "[email protected]" # optional
COMMIT_MESSAGE: "Update readme with latest blogs" # optional, offer default msg like this
- Replace the above URL list with your own RSS feed URLs.
- Commit and wait for it to run automatically, or you can also trigger it manually to see the result instantly.
Support multiple rss format
Usage
-
Go to your repository
-
Add the following to your README.md file, you can use any title. Just make sure that you use
<!-- BLOG-LIST-START --><!-- BLOG-LIST-END -->
in your readme. The workflow will replace this comment with the actual blog posts list:# Blog posts <!-- BLOG-LIST-START --> <!-- BLOG-LIST-END -->
-
Create a folder
.github/workflows
inside root of the repository if it doesn't exists. -
Create a new file
readme-update-actions.yml
inside.github/workflows/
with the following contents:
name: Readme Update Blog
on:
schedule: # Run workflow automatically
- cron: '0 * * * *' # Runs every hour
workflow_dispatch: # Run workflow manually (without waiting for the cron to be called), through the GitHub Actions Workflow page directly
jobs:
update-readme-with-blog:
name: Update latest blogs
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v3
- name: Fetch posts
uses: imskr/readme-update-actions@v2
with:
RSS_LIST: "https://blog.metaprogramming.space/rss.xml" # required
MAX_POST: 5 # optional, default 3
COMMIT_USER: "commiter" # optional
COMMIT_EMAIL: "[email protected]" # optional
COMMIT_MESSAGE: "Update readme with latest blogs" # optional, offer default msg like this
- Replace the above URL list with your own RSS feed URLs.
- Commit and wait for it to run automatically, or you can also trigger it manually to see the result instantly.
Support multiple rss format
Usage
-
Go to your repository
-
Add the following to your README.md file, you can use any title. Just make sure that you use
<!-- BLOG-LIST-START --><!-- BLOG-LIST-END -->
in your readme. The workflow will replace this comment with the actual blog posts list:# Blog posts <!-- BLOG-LIST-START --> <!-- BLOG-LIST-END -->
-
Create a folder
.github/workflows
inside root of the repository if it doesn't exists. -
Create a new file
readme-update-actions.yml
inside.github/workflows/
with the following contents:
name: Readme Update Blog
on:
schedule: # Run workflow automatically
- cron: '0 * * * *' # Runs every hour
workflow_dispatch: # Run workflow manually (without waiting for the cron to be called), through the GitHub Actions Workflow page directly
jobs:
update-readme-with-blog:
name: Update latest blogs
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v3
- name: Fetch posts
uses: armingli/readme-update-actions@v1
with:
RSS_LIST: "https://blog.metaprogramming.space/rss.xml" # required
MAX_POST: 5 # optional, default 3
COMMIT_USER: "commiter" # optional
COMMIT_EMAIL: "[email protected]" # optional
COMMIT_MESSAGE: "Update readme with latest blogs" # optional, offer default msg like this
- Replace the above URL list with your own RSS feed URLs.
- Commit and wait for it to run automatically, or you can also trigger it manually to see the result instantly.