https://github.com/mikeamputer/orcs-earn-badges

A GitHub action that tracks orcs-have-issues game achievements and adds badges to a profile readme
https://github.com/mikeamputer/orcs-earn-badges

actions badges dotnet github-profile profile-readme rpg

Last synced: 4 months ago
JSON representation

A GitHub action that tracks orcs-have-issues game achievements and adds badges to a profile readme

• Host: GitHub
• URL: https://github.com/mikeamputer/orcs-earn-badges
• Owner: MikeAmputer
• License: mit
• Created: 2024-09-08T11:18:19.000Z (5 months ago)
• Default Branch: master
• Last Pushed: 2024-09-23T13:21:52.000Z (5 months ago)
• Last Synced: 2024-10-13T23:03:15.109Z (4 months ago)
• Topics: actions, badges, dotnet, github-profile, profile-readme, rpg
• Language: C#
• Homepage:
• Size: 6.64 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# orcs-earn-badges

A GitHub action that tracks [orcs-have-issues](https://github.com/MikeAmputer/orcs-have-issues) game achievements and adds badges to a profile readme.

  

    

      


        

        

      

    

    

      

      

      

      

      

      

      

      

      

      

      

      

      

      

      

      

      

      

      

      

      

      

      

      

      

      

    

  


## Installation

Create a character in the [orcs-have-issues repository](https://github.com/MikeAmputer/orcs-have-issues) to earn your first badge.

Create a new repository named `YourLogin/YourLogin` on GitHub with a README.md file to [manage your profile readme](https://docs.github.com/en/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/managing-your-profile-readme). Replace `YourLogin` with your GitHub username.

Edit README.md and add the following comment lines (badges will appear between them):

```

```

Create a new workflow (add file) in your repository at `.github/workflows/orcs-earn-badges.yml`:

```yml

name: Orcs Have Issues Badges

on:

  schedule:

    - cron: '30 1 * * *'

  workflow_dispatch:

jobs:

  update-badges:

    runs-on: ubuntu-latest

    steps:

      - name: Orcs Have Issues Profile Badges

        uses: MikeAmputer/orcs-earn-badges@v1

        with:

          token: ${{ secrets.REPOSITORY_TOKEN }}

```

This will automatically run the action daily at 1:30 UTC (1 hour after the game simulation), and will also let you to run it manually right now or any other time.

[Generate a Personal Access Token](https://github.com/settings/personal-access-tokens/new) with `contents` write permission. This token will be used to update the readme file.









Copy the token and navigate to `/settings/secrets/actions` of your repository.







Create a new repository secret `REPOSITORY_TOKEN` with the value of the created token.







To validate setup, navigate to the `/actions/workflows/orcs-earn-badges.yml` and run the workflow manually.







You can check the result in [my profile](https://github.com/MikeAmputer), and an example of installation in [my profile repository](https://github.com/MikeAmputer/MikeAmputer).