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.0.0
              with:
                username: YOUR_USERNAME_ON_DEV_TO                
                template-file: 'README.md.template'
                out-file: 'README.md'
                limit: 5
            - name: Commit
              run: |
                git config user.name github-actions
                git config user.email github-actions@github.com
                git add .
                git commit -m "update articles"
                git push origin main

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 Jack collected from dev.to

Table

	Update your dev.to articles into your Github profile In this article, I'll share you how to update your latest articles on dev.to into your Github... 14/09/2023
	Creating Dynamic README.md File This is my Github Profile. The specific thing here is that the weather is updated every 6 hours... 09/09/2023
	Search Goole Like a Pro [Cheat sheet] Before reading my article, let's try searching the following input: inurl:/jacktt/ site:dev.to ... 30/08/2023
	Advanced Go Build Techniques Table of contents Build options Which file will be included Build tags Build contraints ... 30/08/2023
	Load Private Module in Golang Project Load Private Module in Golang Project Table of Contents I. How Does go get Work? II. How... 12/08/2023

List

• Update your dev.to articles into your Github profile - 14/09/2023
• Creating Dynamic README.md File - 09/09/2023
• Search Goole Like a Pro [Cheat sheet] - 30/08/2023
• Advanced Go Build Techniques - 30/08/2023
• Load Private Module in Golang Project - 12/08/2023

Updated at: 2023-09-14T12:40:42Z