Skip to content
You're viewing an older version of this GitHub Action. Do you want to see the latest version instead?
align-justify

GitHub Action

My Awesome list

v1.0.32

My Awesome list

align-justify

My Awesome list

Generate awesome list from user starred repositories

Installation

Copy and paste the following snippet into your .yml file.

              

- name: My Awesome list

uses: simonecorsi/mawesome@v1.0.32

Learn more about this action in simonecorsi/mawesome

Choose a version

My Awesome List

This action query the github api to get starred list of the user and then generates a list ordered by languages.

You can see an example of the output at my own simonecorsi/awesome

Table of Contents

Documentation

Requirements

  • An empty repository
  • A personal github api key

Configuration

The service can be configured setting the appropriate environment variables or writing an .env file.

Variable Description Default
api-token Personal github api token. ${{ secrets.API_TOKEN }}
github-token Action Token ${{ secrets.GITHUB_TOKEN }}
github-name Name used for the commit, default to action Github Action
github-email email used for commit, default to action actions@users.noreply.github.com

api-token

The Personal API Access Token is mandatory to fetch stars from the API without incurring in Rate Limits.

You'll have to generate a personal api token and then add

Example workflow

name: Update awesome list

on: 
  workflow_dispatch:
  schedule:
    - cron: '0 0 * * *'

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - name: Awesome generator
        uses: simonecorsi/mawesome@latest
        with:
          api-token: ${{ secrets.API_TOKEN }}
          github-token: ${{ secrets.GITHUB_TOKEN }}
          github-email: ${{ secrets.USER_EMAIL }}
          github-name: ${{ github.repository_owner }}