Automatische Aktualisierung der GitHub-Readme mit den neuesten Blog-Beiträgen

Nachdem ich bereits einen Blog-Beitrag über die Erstellung einer individuellen Readme-Datei auf GitHub geschrieben habe, möchte ich nun einen Schritt weitergehen: Die Readme soll automatisch immer die neuesten Blog-Beiträge anzeigen. Dies lässt sich mit einer GitHub Action elegant lösen, die regelmäßig meine Blog-Beiträge von Medium abruft und in die Readme einfügt.

In diesem Beitrag erkläre ich Schritt für Schritt, wie ich das umgesetzt habe und wie auch ihr eure Readme-Datei dynamisch halten könnt.

Was ist eine GitHub Action?

GitHub Actions sind Automatisierungen, die auf Basis bestimmter Ereignisse in eurem Repository ausgeführt werden. In meinem Fall nutze ich eine GitHub Action, um jeden Tag automatisch die neuesten Blog-Beiträge abzurufen und meine Readme zu aktualisieren.

Die GitHub Action im Detail

Hier ist der Code für die Action, die ich verwende:

name: Latest blog post - Medium

on:
  # Automatischer Start jeden Tag um 6 Uhr morgens
  schedule:
    - cron: "0 6 * * *"
  
  # Ermöglicht das manuelle Ausführen der Action
  workflow_dispatch:

# Erlaubt der Action, Inhalte im Repository zu überschreiben
permissions:
  contents: write

jobs:
  update-readme-with-blog:
    name: Update this repo's README with latest blog posts
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v4
        
      - name: Pull in posts
        uses: gautamkrishnar/blog-post-workflow@v1
        with:
          feed_list: "https://medium.com/feed/@tsjdevapps"
          comment_tag_name: "MEDIUM-BLOG-POST-LIST"
          max_post_count: 10

Was macht diese Action?

• Zeitgesteuerte Ausführung: Die Action wird automatisch jeden Tag um 6 Uhr morgens gestartet.
• Manuelles Auslösen: Zusätzlich kann man die Action jederzeit manuell starten.
• Abrufen der Blog-Posts: Mithilfe von gautamkrishnar/blog-post-workflow werden Blog-Posts über den RSS-Feed abgerufen.
• Update der ReadME: Die Action ersetzt eine Kommentarstelle (MEDIUM-BLOG-POST-LIST) in der Readme durch eine Liste der neuesten Blog-Beiträge (maximal 10).

Schritt-für-Schritt-Anleitung

So könnt ihr diese Action in eurem eigenen GitHub-Repository einrichten:

• RSS-Feed eures Blogs finden: Für Medium-Blogs lautet der RSS-Feed: https://medium.com/feed/@UserName
• Repository vorbereiten: Erstellt ein GitHub-Repository oder öffnet ein bestehendes. Stellt sicher, dass eure ReadME-Datei eine Stelle mit folgendem Kommentar enthält: <!-- MEDIUM-BLOG-POST-LIST -->
• GitHub Action hinzufügen: Navigiert zu Actions in eurem Repository. Klickt auf New Workflow. Fügt den oben gezeigten Code ein und speichert ihn als .github/workflows/latest-blog-post.yml
• Anpassungen vornehmen: Ersetzt https://medium.com/feed/@tsjdevapps durch den RSS-Feed eures Blogs. Passt, falls nötig, den Kommentar-Tag MEDIUM-BLOG-POST-LIST oder die maximale Anzahl an Beiträgen (max_post_count) an.

Vorteile dieser Automatisierung

• Aktuell bleiben: Eure Readme zeigt immer die neuesten Inhalte, ohne dass ihr manuell eingreifen müsst.
• Zeit sparen: Einmal eingerichtet, läuft die Aktualisierung von alleine.
• Flexibel: Funktioniert mit verschiedenen Blog-Plattformen, die RSS-Feeds anbieten.

Fazit

Mit dieser GitHub Action könnt ihr eure Readme dynamischer und informativer gestalten. Probiert es aus, und teilt eure Erfahrungen! Wenn ihr mehr über GitHub Readme oder Automatisierungen erfahren wollt, schaut euch meinen vorherigen Blog-Beitrag an. 🚀

Falls Fragen auftauchen, meldet euch gerne! 😊