You're viewing an older version of this GitHub Action. Do you want to see the latest version instead?
GitHub Action
github-profile-toolbox
v1.0.8
With this GitHub action you can include a nice Markdown table in your GitHub profile to summarize your skill set.
Giving the following configuration passed as an input to the GitHub action:
tools:
IDE:
- jetbrains
- neovim
Language:
- javascript
- cplusplus
- rust
- php; you would get the following output:
Here is a real-life example: https://github.com/alexandre-abrioux#hammer_and_wrench-toolbox
-
Add the comment
<!-- START_SECTION:toolbox --><!-- STOP_SECTION:toolbox -->withinREADME.md. You can find an example here. -
Add the following workflow file to your profile repository:
.github/workflows/update-toolbox.yaml
name: Update Toolbox
on:
push:
branches: [ main ]
workflow_dispatch:
jobs:
update-toolbox:
runs-on: ubuntu-latest
permissions:
contents: write
steps:
- uses: actions/checkout@v4
- uses: alexandre-abrioux/github-profile-toolbox@v1
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
- uses: peter-evans/create-pull-request@v7
with:
commit-message: "docs(readme): update toolbox"
title: "docs(readme): update toolbox"
branch: patch/toolbox
reviewers: ${{ github.actor }}You can find an example here.
Use the following input parameters to customize it for your use case:
| Input Param | Description | Default Value |
|---|---|---|
config |
path to the YAML configuration file | .github/github-profile-toolbox.yaml |
readme |
path to the README file that should be modified | README.md |
For instance, if you which to place your configuration file somewhere else, use the following:
- uses: alexandre-abrioux/github-profile-toolbox@v1
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
with:
config: "my-custom-path.yaml"