custom_badges.md

Custom Badges

You can create custom badges such as .

This relies on a GitHub workflow such as:

name: Count LOC in Python Files

on:
  push:
    branches: [ develop ]
  pull_request:
    branches: [ main, develop ]

jobs:
  count-loc:
    runs-on: ubuntu-latest

    steps:
      - name: Checkout repository
        uses: actions/checkout@v3

      - name: Count Total Lines of Code in Python Files
        id: loc  # Give this step an ID to reference later
        run: |
          echo "Counting total lines of Python code..."
          LOC_COUNT=$(git ls-files '*.py' | xargs wc -l | tail -n 1)
          echo "LOC_COUNT=${LOC_COUNT}" >> $GITHUB_ENV
          echo "Python Lines of Code (LOC): $LOC_COUNT"

      - name: Post LOC Count as PR Comment (Only for Main Branch)
        if: github.event_name == 'pull_request' && github.base_ref == 'main'
        uses: peter-evans/create-or-update-comment@v3
        with:
          token: ${{ secrets.GITHUB_TOKEN }}
          issue-number: ${{ github.event.pull_request.number }}
          body: |
            ### Python Lines of Code (LOC) Summary
            Total lines of Python code in this repository:
            ```
            ${{ env.LOC_COUNT }}
            ```

      - name: Create Awesome Badge
        uses: schneegans/dynamic-badges-action@v1.7.0
        with:
          auth: ${{ secrets.GIST_SECRET }}
          gistID: 25d4f4d4d222fcb5f266a280b1dd60d4
          filename: phenopacket_mapper_locs.JSON # Use test.svg if you want to use the SVG mode.
          label: Lines of Code
          message: ${{ env.LOC_COUNT }}
          color: blue

You can see the last section on creating a badge. In order for this to work, you need to follow the steps in this tutorial: Dynamic Badges Action

TLDR:

1. Create a gist file (e.g., test.json) at https://gist.github.com/.
2. Create a GitHub Access token with the Gist access.
3. Create a secret in your repository and call it GIST_SECRET
4. Configure the workflow to write to the gist as seen above
5. Add the badge to your README like this:

![badge](https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/<user>/<gist-ID>/raw/test.json)