myosc

Flex your open-source contributions like a pro 🤟🏽
A github action to list all your pull requests in a markdown file

❓ Usage

• You can use the following workflow as it is, just copy/paste in a file named my-contributions.yml inside your workflows directory.
• You can manually trigger builds but the recommended way is to schedule the build using cron.

name: Build My Contributions List

on:
  push:
  workflow_dispatch:
  schedule:
  # run once every month
    - cron:  '0 0 1 * *'

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v2
    - name: Generate My PRs List 👀
      uses: developersIndia/myosc@main
      with:
        username: "${{ github.actor }}"
        filename: "README.md"

Inputs

myosc accepts following input variables.

• username (required) : Your github username.
• filename (optional) : A filename for the new markdown file where report will be added, defaults to README.md

Demos

Check the my-prs.md file to see how the report looks like

✨ Customization

myosc supports custom header and footers for the README report. You can leverage this to add custom badges, licenses or any other info before and after the report

1. Create a file named HEADER.md if you want to append something before the report.
2. Create a file named FOOTER.md if you want to append something after the report.

📝 License

This project is GPLV3 licensed.