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

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

5. Commit and trigger it manually, after the run, a my-ocoto-lang.png file will be created in your repository.
6. You can display it in your README.md like this:

<p> Here is arndom's ocoto-lang:</p>
<img src= "./my-octo-lang.png" width="400px"/>

The result

Here is arndom's ocoto-lang:

Supported Languages

Currently this supports the following languages:

• C
• C++
• C#
• CSS
• GO
• Haskell
• HTML
• Java
• JavaScript
• Kotlin
• Lua
• php
• Python
• R
• Ruby
• Swift
• Typescript
  More coming soon...

Special thanks to

• All users of the workflow
• Dev.to for the github actions hackathon that inspired me to build this
• @gautamkrishnar & @theboi for writing awesome action code that helped me find my way around.
• @Rahnard for the styling of the octocat
• @abranhe for the programming logos package

Liked it?

Hope you like this, Don't forget to give this a star ⭐

octo-my-readme-workflow's Issues

Feature: Option to choose top language based on a specific repo

Currently, this goes through all the users' repos and then gets your most used language, this feature would allow the option for repo specific (where the action is being used) selection.

HTTP Status 403

Wasup. I tried to use it following the README but didn't work for me

I'm getting this:

Failed:  RequestError [HttpError]: Resource not accessible by integration
    at /home/runner/work/_actions/arndom/octo-my-readme-workflow/v1/node_modules/@octokit/request/dist-node/index.js:86:21
    at processTicksAndRejections (internal/process/task_queues.js:97:5)
    at async /home/runner/work/_actions/arndom/octo-my-readme-workflow/v1/index.js:53:9 {
  status: 403,
  response: {
    url: 'https://api.github.com/repos/devLucasOAK/my-github-workflows/contents/my-octo-lang.png',
    status: 403,
    ...

I'm kinda new with this, but I'm guessing this is related to permissions to the target repo.
Related: actions/first-interaction#10

Another issue is that is getting my top language wrong:

Your top language is Java
java is a supported language ✅

But my unique language used in the repo is Python.

You can check my logs here:
https://github.com/devLucasOAK/my-github-workflows/actions/runs/4102396265