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: coding-to-music/[email protected]
        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 [email protected]
              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 Tom Connors collected from dev.to

Table

	MIT's Premier Programming Competition, Battlecode, open to all, registration is... It's Battlecode Season, open to all Battlecode 2023 begins on January 9th, 2023! Register... 05/12/2022
	Playing around with Open.ai's ChatGPT-3 to ask how to upload... It Works! https://chat.openai.com/chat Question 1 use typescript to put multiple... 05/12/2022
	BattleCode 2021 - Overview and instructions - create java bots... BattleCode 2021 - Overview BattleCode 2021 - Overview Introduction Why... 15/01/2021

List

• MIT's Premier Programming Competition, Battlecode, open to all, registration is... - 05/12/2022
• Playing around with Open.ai's ChatGPT-3 to ask how to upload... - 05/12/2022
• BattleCode 2021 - Overview and instructions - create java bots... - 15/01/2021

Updated at: 2023-09-17T00:25:19Z