p4p1 / tryhackme-badge-workflow

A simple github action to retrieve tryhackme static badge image and display it on your profile README
https://github.com/marketplace/actions/tryhackme-badge-workflow
GNU General Public License v3.0
118 stars 6 forks source link
readme-profile tryhackme workflow-automation

tryhackme-workflow

A simple github action to retrieve tryhackme static badge image and display it on your profile README!

profile_demo

How This Was Built

How to use:

  1. Star this repo and give me a follow :)
  2. Create a .github/workflows directory in your username repo where your README is located
  3. Create a file named tryhackme-badge-workflow.yml inside of that folder
  4. Place the following code inside of the previously created file:
    
    name: TryHackMe Update Badge

on: schedule:

Make it run every 24 hour

- cron: '0 0 * * *'

workflow_dispatch: jobs: tryhackme-badge-update: name: Update this repo's tryhackme badge with the latest tryhackme image badge runs-on: ubuntu-latest steps:

Variables:

name description default required
image_path Path of the image file you want to update ./assets/thm_propic.png false
username Tryhackme username true
committer_username Username of commiting bot thm-p4p1-bot false
committer_email Email of commiting bot p4p1@thm.bot false
commit_message Commit message Updated THM profile badge false
GITHUB_TOKEN Your github secret token true