Profile Stack Save

🚀 Display your tech stack on your GitHub profile's README

Project README

profile_stack GitHub release (latest by date)

lint build test deploy

🚀 Display your tech stack on your GitHub profile's README

🆕 v2.0.0 Migration

✨ Example

Add the following to a file in .github/workflows:

name: stack

on:
  push:
    branches:
      - main

jobs:
  profile_stack:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - uses: gleich/profile_stack@master

Based on a config file this GitHub action will generate a table showing technologies and projects you've used them in (doesn't have to be all, pick any):

💻 Technology 🚀 Projects
Golang fgh gh_fsync nuke logoru statuser
Python profile_stack Contribution-Hat

You can see a live example at my repo: github.com/gleich/gleich

⚙️ Config

Configuration for the profile stack. Located by default in stack.yml at the root of your repository. Below is an example config:

- name: Golang
  logo: go
  url: https://golang.org/
  color: '#7FD6EA'
  projects:
    - url: https://github.com/gleich/fgh
    - url: https://github.com/gleich/gh_fsync
    - url: https://github.com/gleich/nuke
    - url: https://github.com/gleich/logoru
    - url: https://github.com/gleich/statuser

- name: Python
  logo: python
  url: https://www.python.org/
  color: '#3C78A9'
  projects:
    - url: https://github.com/gleich/profile_stack
    - url: https://github.com/gleich/Contribution-Hat

So for each technology, there are the following fields you need to fill in:

Key Example Value Description Default
name Dart Name of the technology Required
logo dart Logo for the technology Required
url https://flutter.dev/ URL for the technology Required
logo_color FFFFFF Hex color code for the logo color #FFFFFF
color 52C0F2 Hex color code for the background color Required
projects - url: https://github.com/gleich/Personal-Site - url: https://github.com/gleich/fgh List of GitHub project URLs or project objects Required

Project object

You pass a list of YAML objects to the projects field.

Key Example Value Description Default
url https://github.com/gleich/Personal-Site URL to a GitHub project Required
wip true Mark a project as work-in-progress false

🤖 Action Configuration

Here is an example config:

name: stack

on:
  push:
    branches:
      - main

jobs:
  profile_stack:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - uses: gleich/profile_stack@master
        with:
          path: config/stack.yml
          badges: false
          technology_emoji: 👨🏻‍💻
          project_emoji: ✨

You can also configure the following when declaring your action:

Key Example Value Description Default
path config/stack.yml The path in your repository where the config file is located stack.yml
badges false Don't have badges, just plain old urls false
technology_emoji 👨🏻‍💻 The character to be displayed to the left of the Technology title 💻
project_emoji The character to be displayed to the left of the Project title 🚀

🙌 Contributing

We would love to have you contribute! Please read the contributing guide before submitting a pull request. Thank you in advance!

👥 Contributors

Open Source Agenda is not affiliated with "Profile Stack" Project. README Source: gleich/profile_stack
Stars
51
Open Issues
0
Last Commit
1 year ago

Open Source Agenda Badge

Open Source Agenda Rating