Commit historik

Denna action genererar en markdown-fil med en lista över alla commits som har gjorts i repot och av vem.

name: Generate Commit History

on:
  push:
    branches:
      - main

jobs:
  generate-history:
    runs-on: ubuntu-latest
    permissions:
      contents: write
    if: "github.event.pusher.email != 'action@github.com'"

    steps:
      - name: Checkout code
        uses: actions/checkout@v3
        with:
          ref: ${{ github.event.pull_request.head.sha }}
          fetch-depth: 0

      - name: Set up Git user
        run: |
          git config user.name "GitHub Action"
          git config user.email "action@github.com"

      - name: Generate commit history
        run: |
          echo "# Commit historik" > HISTORY.md
          echo "| Date | Author | Email | Message | Commit Hash |" > HISTORY.md
          echo "|------|--------|-------|---------|--------------|" >> HISTORY.md
          git log --pretty=format:'| %cd | %an | %ae | %s | %h |' --date=short | grep -v 'action@github.com'  >> HISTORY.md

      - name: Add and commit HISTORY.md file
        run: |
          git add HISTORY.md
          git commit -m "Update HISTORY.md file" || echo "No changes to commit"

      - name: Push changes
        run: |
          git push

      - name: Yay!
        run: echo Marcus Was Here!

Förklaring av koden

Förklaring av koden

Name

Namnet på actionen.

On

När actionen ska köras. I detta fall när någon pushar till main-branchen. Man kan även köra den när någon pushar till en pull request eller när någon skapar en pull request.

Exempelvis:

on:
  pull_request:
    branches:
      - main

Jobs

En jobb är en samling av steg som ska köras. I detta fall har vi bara ett jobb som heter generate-stats.

Runs-on

Vilken typ av maskin som jobbet ska köras på. I detta fall kör vi på en ubuntu-maskin, men kan även köra på en windows-maskin eller en mac-maskin.

Exempelvis:

runs-on: windows-latest

eller

runs-on: macos-latest

Permissions

Vilka rättigheter actionen ska ha. I detta fall behöver vi rättigheten contents: write för att kunna skriva till repot.

If

Villkor för när actionen ska köras. I detta fall vill vi inte att actionen ska köras när vi pushar till repot, utan bara när någon annan pushar till repot. Därför kollar vi om github.event.pusher.email är action@github.com och om det är det så kör vi inte actionen. Detta för att slippa att automatiserade commits triggar actionen.

Steps

Stegen som ska köras i jobbet. I detta fall har vi 7 steg. Varje steg har ett namn, en beskrivning och en kommando som ska köras.

Checkout code

Detta steg klonar repot till den maskin som actionen körs på.

Set up Git user

Detta steg sätter upp en användare för git som actionen kan använda för att göra commits. Du kan ange dina egna uppgifter här om du vill, men då rekommenderas att du använder en github secret för att inte lägga ut dina uppgifter publikt.

Generate commit history

Detta steg genererar en markdown-fil med en lista över alla commits som har gjorts i repot och av vem.

Add and commit HISTORY.md file

Detta steg lägger till och committar den genererade markdown-filen.

Push changes

Detta steg pushar ändringarna till repot.

Yay!

Detta steg skriver ut en glad hälsning i loggen.

Exempel på resultat