Skip to content
Use this GitHub action with your project
Add this Action to an existing workflow or create a new one
View on Marketplace

Repository files navigation

About

Collect your latest articles from sources such as dev.to, and then update the README.md.

Use GitHub Action to update your README

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 Time
  • Author: 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

Below is my recent articles JackTT collected from dev.to

Table

thumbnail How I Segmented Millions of Users in Just a Few...
User segmentation requirement Imagine you need to send a push notification to users who...
03/08/2026
thumbnail GraphQL là gì — Tại sao nên dùng cho Social...
GraphQL là gì — Tại sao nên dùng cho Social App? 1. GraphQL là gì? GraphQL...
21/05/2026
thumbnail BMAD cheat sheet
Module 1: BMM (Business Model Management) The main product development module, designed...
11/03/2026
thumbnail BMAD Quick Flow
BMAD Quick Flow Quick Flow is the lean path inside the BMAD Method. It skips the full...
11/03/2026
thumbnail BMAD Standard Workflow
BMAD Standard Workflow Guide Overview BMAD (Business Methods and Development)...
11/03/2026

List

Updated at: 2026-08-07T13:35:43Z

About

Collect your latest articles from sources such as dev.to, and then update the README.md

Resources

Stars

11 stars

Watchers

1 watching

Forks

Releases

Packages

Used by

Contributors

Languages