Skip to content

LoveDoLove/Github-Profile-Manager

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Contributors Forks Stargazers Issues project_license


Logo

GitHub Profile Manager

Automate your GitHub profile README with dynamic featured projects and 3D contribution graphs using GitHub Actions workflows.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Contributing
  5. License
  6. Contact
  7. Acknowledgments

About The Project

GitHub Profile Manager automates your GitHub profile README by dynamically updating featured repositories based on stars and displaying a 3D contribution graph. All updates are handled via GitHub Actions workflows—no manual script running required.

(back to top)

Built With

  • Python
  • GitHub Actions
  • Markdown

(back to top)

Getting Started

Prerequisites

  • A GitHub repository with a profile README (e.g., <username>/<username>)
  • GitHub Actions enabled

Installation

  1. Copy the workflow YAML files from the workflows/ directory into your repository's .github/workflows directory:
  2. (Optional) Add a repository environment variable named EXCLUDE_REPOS in your GitHub repository settings to exclude specific repositories from the featured list. Use a comma-separated list (e.g., repo1,repo2).

(back to top)

Usage

  • Automatic Featured Projects:
    The sync-top-starred-projects.yml workflow will automatically update your profile README with your top-starred repositories on a schedule or on demand.
  • Exclude Repositories:
    To skip certain repositories, set the EXCLUDE_REPOS repository environment variable in your GitHub settings.
  • 3D Contribution Graph:
    The generate-3d-contribution-graph.yml workflow generates a 3D contribution graph SVG, which you can embed in your profile README.
  • No Manual Script Running:
    All updates are handled by GitHub Actions; you do not need to run scripts locally.

For more examples, refer to the Documentation

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".
Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

Top contributors:

contrib.rocks image

License

Distributed under the MIT License. See LICENSE for more information.

(back to top)

Contact

LoveDoLove - @LoveDoLove - lovedolove@gmail.com

Project Link: https://github.com/LoveDoLove/Github-Profile-Manager

(back to top)

Acknowledgments

(back to top)

About

Automate your GitHub profile README with dynamic featured projects and 3D contribution graphs using GitHub Actions workflows.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Sponsor this project

 

Packages

No packages published

Languages