DEV Community

Jesus Moran
Jesus Moran

Posted on

2 1

Generate contributors markdown file

Hi, this post is my submision for the actionshackaton

My Workflow

This github action helps to generate markdown file of contributors which obtain the data of the contributors from a file configured as a parameter in the action, for example contributors.json or .all-contributorssrc, and it will generate a markdown file of contributors with a basic template.

Submission Category:

Maintainer Must-Haves

Yaml File or Link to Code

Markdown Contributors Action

This github action helps to generate markdown file of contributors which obtain the data of the contributors from a file configured as a parameter in the action, for example contributors.json or .all-contributorssrc, and it will generate a markdown file of contributors with a basic template.

Usage

on: [push]

jobs:
  hello_world_job:
    runs-on: ubuntu-latest
    name: A job to add contributors markdown
    steps:
      - name: Checkout
        uses: actions/checkout@v2
      - name: Generate markdown file
        uses: ./
      - uses: stefanzweifel/git-auto-commit-action@v2
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        with:
          commit_message: Update generated contributors markdown
          branch: master



Usage

on: [push]

jobs:
  hello_world_job:
    runs-on: ubuntu-latest
    name: A job to add contributors markdown
    steps:
      - name: Checkout
        uses: actions/checkout@v2
      - name: Generate markdown file
        uses: ./
      - uses: stefanzweifel/git-auto-commit-action@v2
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        with:
          commit_message: Update generated contributors markdown
          branch: master

Thanks to stefanzweifel/git-auto-commit-action

Top comments (1)

Collapse
 
fennecdjay profile image
Jérémie Astor

Nice idea!
Maybe you could show us what the generated markdown file looks like.
I found one in your repo, which I assume is the generated file, but maybe I'm wrong.
If show want to show a file with more contributors, maybe you can clone something with (a few) more contributors (shall I suggest this one ?) and add your action to it.

Also, I think a "it looks like this" section in the README whould be beneficial.

After looking at your repo, I'm left with a question: where is the template file?

A Workflow Copilot. Tailored to You.

Pieces.app image

Our desktop app, with its intelligent copilot, streamlines coding by generating snippets, extracting code from screenshots, and accelerating problem-solving.

Read the docs

👋 Kindness is contagious

Discover a treasure trove of wisdom within this insightful piece, highly respected in the nurturing DEV Community enviroment. Developers, whether novice or expert, are encouraged to participate and add to our shared knowledge basin.

A simple "thank you" can illuminate someone's day. Express your appreciation in the comments section!

On DEV, sharing ideas smoothens our journey and strengthens our community ties. Learn something useful? Offering a quick thanks to the author is deeply appreciated.

Okay