https://github.com/umutphp/github-action-dynamic-profile-page
GitHub Action to push updates to your special profile repository.
https://github.com/umutphp/github-action-dynamic-profile-page
github-action hacktoberfest profile
Last synced: about 1 month ago
JSON representation
GitHub Action to push updates to your special profile repository.
- Host: GitHub
- URL: https://github.com/umutphp/github-action-dynamic-profile-page
- Owner: umutphp
- License: gpl-3.0
- Created: 2020-07-10T20:06:38.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2024-09-16T20:08:28.000Z (7 months ago)
- Last Synced: 2024-09-17T01:37:58.924Z (7 months ago)
- Topics: github-action, hacktoberfest, profile
- Language: Shell
- Homepage:
- Size: 124 KB
- Stars: 54
- Watchers: 4
- Forks: 12
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-github-profile - Dynamic Profile Page On Github - Get dynamically generated list of your commits (of the repositories that the action is configured) on GitHub profile readme. (Tools)
- fucking-awesome-github-profile-readme - Dynamic Profile Page On Github - Get dynamically generated list of your commits (of the repositories that the action is configured) on GitHub profile readme. (Tools)
- AwesomeGithubProfileTemplates - Dynamic Profile Page On Github - Get dynamically generated list of your commits (of the repositories that the action is configured) on GitHub profile readme. (Resources / Tools)
- awesome-readme-tools - Dynamic Profile Page - GitHub action to push updates to your special profile repository. (GitHub Actions for Readmes)
- awesome-github-profile-readme - Dynamic Profile Page On Github - Get dynamically generated list of your commits (of the repositories that the action is configured) on GitHub profile readme. (Tools)
- awesome-ubc-profile-readme - Dynamic Profile Page On Github - Get dynamically generated list of your commits (of the repositories that the action is configured) on GitHub profile readme. (Tools)
- jimsghstars - umutphp/github-action-dynamic-profile-page - GitHub Action to push updates to your special profile repository. (Shell)
- awesome-bd-readme-profile - Dynamic Profile Page On Github - Get dynamically generated list of your commits (of the repositories that the action is configured) on GitHub profile readme. (Tools / Images Gifs:)
- awesome-bd-readme-profile - Dynamic Profile Page On Github - Get dynamically generated list of your commits (of the repositories that the action is configured) on GitHub profile readme. (Tools / Images Gifs:)
README
# Dynamic Profile Page On GitHub
A 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. A line per repository is added to the section and the lines are ordered from the newest to the oldest. You can see a sample execution in [my profile page](https://github.com/umutphp).
Please feel free to fork it or contribute to it.
## Usage
You can add this action to any repository other than profile repository (special repository). This action will add a line for every repository (that the action is activated) to the README file of the special repository.
Follow the steps;
- Create your special repository if not exists.
- Add `` add the end of the README.md file of the special repo.
- Create a personal access token [here](https://github.com/settings/tokens) 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` of the repository (the one which is not the special repository). You can use the sample given below. Please update `YOUR_GITHUB_USERNAME` and `EMAIL_USED_ON_GITHUB` values.
- Please do not forget to add checkout step before GADPP step in your pipeline.
## Example YML File To Create A Workflow With This Action
```yml
name: Update GitHub Profile Page
on: [push]
jobs:
gadpp_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@v5
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'
```
### Users using this action
- [Awesome CLI](https://github.com/umutphp/awesome-cli)
- [Hacker Laws TR](https://github.com/umutphp/hacker-laws-tr)
- [Github Stats](https://github.com/umutphp/github-stats)
- [Famous Bugs](https://github.com/umutphp/famous-bugs)
- [PHP Docker Images for CLI](https://github.com/umutphp/php-docker-images-for-cli)
- [Larvel Model Recommendation](https://github.com/umutphp/larvel-model-recommedation)
- [LuckKAnn](https://github.com/LuckKAnn/LuckKAnn)
- [Vvroul](https://github.com/vvroul/vvroul)
- [Waka Box](https://github.com/joriewong/waka-box)
- [Diablo Music App](https://github.com/Suvraneel/diablo-music-app)
- [Diablo Music](https://github.com/Suvraneel/diablo-music)
- [C Programming](https://github.com/Suvraneel/C-programming)
- [B Buck Offical](https://github.com/david3239294/BBUCKOffical)
- [Baby Buck](https://github.com/david329294/babybuck)
- [Sandep-FED](https://github.com/Sandeep-FED)
- [7-TE](https://github.com/7-TE/7-TE)
- [Go Go Richie](https://github.com/gogorichie/gogorichie)
- [TheRakeshPurohit](https://github.com/TheRakeshPurohit/awesome-cli)
- [Dotfiles](https://github.com/dat-adi/dotfiles)
- [Tiny App](https://github.com/dat-adi/tinyApps)
- [Time Tabler](https://github.com/dat-adi/time-tabler)
- [Eisen Tickets](https://github.com/dat-adi/eisen-tickets)
Please add a issue if you don't see your name on here, And We will add it.