GitHub Action
Article updater
v1.3.0
Latest version
Collect your latest articles from sources such as dev.to, and then update the README.md
.
Step 1: In your repository, create a file named README.md.template
.
Step 2: Write anything you want within the README.md.template
file.
Step 3: Embed one of the following entities within your README.md.template
:
- Article listing:
{{ template "article-list" .Articles }}
- Article table:
{{ template "article-table" .Articles }}
If you are familiar with Go templates, you have access to the root
variable, which includes the following fields:
Articles
: An array of Article. You can view the Article struct definition in model/article.go.Time
: Updated TimeAuthor
: Author of articles
Step 4: Register Github Action
- Create a file
.github/workflows/update-articles.yml
in your repository.
name: "Cronjob"
on:
schedule:
- cron: '15 0 * * *'
jobs:
update-articles:
permissions: write-all
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- name: Generate README
uses: huantt/article-listing@v1.1.0
with:
username: YOUR_USERNAME_ON_DEV_TO
template-file: 'README.md.template'
out-file: 'README.md'
limit: 5
- name: Commit
run: |
if git diff --exit-code; then
echo "No changes to commit."
exit 0
else
git config user.name github-actions
git config user.email github-actions@github.com
git add .
git commit -m "update"
git push origin main
fi
Step 5: Commit your change, then Github actions will run as your specified cron to update Articles into your README.md file
[Golang] Understanding Unbuffered and Buffered Channels
Table of contents Channel capacity Behavior Closed channel Receive-Only & Send-only...
14/09/2024
|
|
Snowflake Schema vs. Star Schema: Pros, Cons, and Use Cases
Star Schema Structure: Central Fact Table: Contains quantitative data for...
12/09/2024
|
|
[Postgres] Isolation levels
In PostgreSQL, isolation levels determine how transaction integrity is maintained when multiple...
12/09/2024
|
|
ACID in Postgres
ACID is a set of properties that ensure reliable transactions in a database system. It stands for...
15/08/2024
|
|
Kubernetes probes: startupProbe, livenssProbe, and readinessProbe
Liveness Liveness probes determine when to restart a container. If the liveness probe...
07/08/2024
|
- [Golang] Understanding Unbuffered and Buffered Channels - 14/09/2024
- Snowflake Schema vs. Star Schema: Pros, Cons, and Use Cases - 12/09/2024
- [Postgres] Isolation levels - 12/09/2024
- ACID in Postgres - 15/08/2024
- Kubernetes probes: startupProbe, livenssProbe, and readinessProbe - 07/08/2024
Updated at: 2024-09-19T01:50:36Z