Coolprofiles creates a cool README for your GitHub profile, so you can easily showcase to everyone what you've been up to recently. Our mission is simple: inject some fun into the often mundane world of managing GitHub profiles. Why settle for a standard profile when you can have one that reflects more than just your code contributions?
-
GitHub Repository Transformation: CoolProfiles dives into your GitHub repository and forks it to create a unique and whimsical summary of your most recent commits from the past three months.
-
README.md Magic: But we don't stop there! We magically transform your repository's README.md file into an engaging summary that captures the essence of your project. Most importantly, this personal README will be automatically updated every month.
-
Emoji Auto-Generation: The cherry on top is our emoji feature! Our system smartly auto-generates an emoji that perfectly matches the title of your GitHub repo. Imagine a repository named "SolarSystem" getting paired with a planet emoji, or "MusicBox" finding its rhythm with a musical note emoji. It's the perfect blend of functionality and frivolity.
-
Word Cloud Wonderland: And for the grand finale, we create a word cloud, a visual feast crafted from your repository titles, descriptions, commits, and pull requests.
This project isn't just about enhancing profiles; it's about bringing a smile, a chuckle, and maybe even a bewildered shake of the head. In a world obsessed with utility, we're here to celebrate the joy of the beautifully useless. Join us in this playful rebellion against the mundane – your GitHub profile will never be the same!
- Fork this repo and give it the same name as your GitHub username.
- NOTE: If the repository does not share your username, the README will not display on your profile.
-
To allow GitHub Actions to write to your repository: Go to Settings -> Actions -> General -> Workflow Permissions -> Select Read and write permissions.
-
To add your environment variables: Go to Settings -> Secrets and Variables -> Under Repository Secrets, Click/Add a New Repository Secret
-
Name your New Secret "ENV_FILE"
-
Fill in the Secrets section with the following template and replace the respective fields with your GitHub personal access token, OpenAI key, and GitHub username.
GH_TOKEN=(Change this to your GitHub personal access token)
OPENAI_API_KEY=(Change this to your OpenAI key)
GH_USER=(Change this to your GitHub username)
Example:
GH_TOKEN=WJd3rnf8snvSDdNs93rnv5ny9cdJHKndgNjgdk
OPENAI_API_KEY=sk-S7nVFDJIYdnhNFjmndDShmsjfuBF933nDUFhjkda
GH_USER=username
- Go to Actions -> Click I understand my workflows, go ahead and enable them
- Go to Profile README -> click Enable Workflow
- Once enabled, click Run workflow
- (Optional) Setup the credentials you will be pushing the commit with. Go to
build.ymland change the lines
git config --global user.email "(Change this to your email)"
git config --global user.name "(Change this to your username)"