DEV Community

Cover image for Get a custom Github octocat in your README
Nabil Alamin
Nabil Alamin

Posted on • Updated on

Get a custom Github octocat in your README

My Workflow

Octo-my-readme is a github action that takes the github octocat and combines it with your most used language in all your repos then displays it in your README.md or wherever you place it.

 

Submission Category:

Wacky Wildcards

 

Link to Code and YAML File

GitHub logo arndom / octo-my-readme-workflow

Combines the GitHub Octocat with the logo of the most used language in your repositories which can then be displayed in your special README or wherever.

Preview

preview

How to use

  1. Star this repo 😉
  2. Go to your special repository(repo with name the same as git username).
  3. Create a folder named .github and create a workflows folder inside it, if it doesn't exist.
  4. Create a new file named octo-lang.yml with the following contents inside the workflow folder:
name: Octo my README 

on:
  # schedule: # Run workflow automatically
  #   - cron: '0 * * * *' # Runs every hour, on the hour
  workflow_dispatch: # Run workflow manually (without waiting for the cron to be called), through the Github Actions Workflow page directly

jobs:
  get_lang_gen_octo:
    runs-on: ubuntu-latest
    name: Get Language & Generate Ocoto-lang
    steps:
    - name: Checkout
      uses: actions/checkout@v2
    - name: Get most used language then generate ocoto lang
      id: octo-lang
      uses: arndom/octo-my-readme-workflow@v1
Enter fullscreen mode Exit fullscreen mode
  1. Commit and trigger it manually, after the run, a my-ocoto-lang.png file…


name: Octo my README 

on:
  # schedule: # Run workflow automatically
  #   - cron: '0 * * * *' # Runs every hour, on the hour
  workflow_dispatch: # Run workflow manually (without waiting for the cron to be called), through the Github Actions Workflow page directly

jobs:
  get_lang_gen_octo:
    runs-on: ubuntu-latest
    name: Get Language & Generate Ocoto-lang
    steps:
    - name: Checkout
      uses: actions/checkout@v2
    - name: Get most used language then generate ocoto lang
      id: octo-lang
      uses: arndom/octo-my-readme-workflow@v1

Enter fullscreen mode Exit fullscreen mode

 

Additional Resources / Info

This is my first github action and I was stuck for a bit realizing my idea but thanks to existing workflows; blog-post-workflow & github-update-readme and the styling of the octocat by my friend; @Rahnard I was able to make this.

Hope you like it 🤗, Don't forget to leave a star ⭐

Discussion (2)

Collapse
andypiper profile image
Andy Piper • Edited on

Oh, this is fun! Nice work. You should add a description, link and topics to your repo, too. I can see you’ve used the action on your own GH Profile, looks cool.

Collapse
arndom profile image
Nabil Alamin Author

Thanks, I'll be sure do add those
👌