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

GitHub Action

Push updates to your profile page

v1

Push updates to your profile page

git-commit

Push updates to your profile page

Create a line for every commit/release on profile page

Installation

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

              

- name: Push updates to your profile page

uses: umutphp/github-action-dynamic-profile-page@v1

Learn more about this action in umutphp/github-action-dynamic-profile-page

Choose a version

Dynamic Profile Page On Github

GitHub Action to push updates to your special profile repo.

Why?

GitHub announced a special repository (github_username/github_username) so that its README.md file will appear on your profile page. People liked it a lot and started using some static pages with fancy texts and images. This GitHub action helps you to add a section that is updated dynamically when you commit a repository that uses this action. Please feel free to fork it or contribute to it.

Usage

Follow the steps;

  • Create your special repository if not exists.
  • Add <!-- START gadpp --> add the end of the README.md file of the special repo.
  • Create a personal access token here and set the repo permission.
  • Add the access token created in previous step to the repository (that uses this action) as a secret with name API_TOKEN_GITHUB.
  • Create the YML file for the action under .github/workflows. You can use the sample given below.

Example YML File To Create A Workflow With This Action

on: [push]

jobs:
  hello_world_job:
    runs-on: ubuntu-latest
    name: Update GitHub Profile Page
    steps:
      - name: Checkout
        uses: actions/checkout@v2
      - name: GADPP
        uses: umutphp/github-action-dynamic-profile-page@v1
        id: gadpp
        env:
          API_TOKEN_GITHUB: ${{ secrets.API_TOKEN_GITHUB }}
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        with:
          github-username: 'YOUR_GITHUB_USERNAME'
          user-email: 'EMAIL_USED_ON_GITHUB'