Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kaustubhgupta/portfoliofy
🔥 Dynamically Self Updating Portfolio GitHub Action
https://github.com/kaustubhgupta/portfoliofy
docker github-actions github-api github-pages github-stats hacktoberfest portfolio project pygithub pygithub-examples python
Last synced: 9 days ago
JSON representation
🔥 Dynamically Self Updating Portfolio GitHub Action
- Host: GitHub
- URL: https://github.com/kaustubhgupta/portfoliofy
- Owner: kaustubhgupta
- License: mit
- Created: 2020-10-04T13:04:00.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2022-06-27T05:58:06.000Z (over 2 years ago)
- Last Synced: 2024-10-15T06:36:38.064Z (21 days ago)
- Topics: docker, github-actions, github-api, github-pages, github-stats, hacktoberfest, portfolio, project, pygithub, pygithub-examples, python
- Language: Python
- Homepage: https://www.kaustubhgupta.me/PortfolioFy
- Size: 12.5 MB
- Stars: 122
- Watchers: 6
- Forks: 20
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
Developers create hundreds of repositories, and hardly a few of them are presentable and showcased on social media/LinkedIn. This GitHub action allows you to generate your self-updating portfolio consisting of Projects, Hackathons, or maybe the latest Blogs.
An index file is pushed by this action which with the help of GitHub pages can be deployed as soon as it is committed to the repository. If you write blogs, then you can add [Blog Post Workflow](https://github.com/marketplace/actions/blog-post-workflow) to the main workflow for updating your portfolio. !
## Getting Your Profile Ready ⚡
- The repositories need to have a `project` topic to add to the project section and a `hackathon` topic to add them in the hackathon section. If you add both the topics to the same repository then it will be reflected in both sections!
- A GitHub personal access token will be needed which can be obtained by going to Settings > Developer Settings > Personal Access Tokens.
_Note: If you give private repositories access then they will be added to the sections but their links will not work_
## Repository Setup 😉
GitHub actions can be integrated into any repository. Create a new folder called `.github/workflows/.yml`. Paste the following starter code:
```yml
name: Latest portfolio
on:
schedule:
- cron: '0 0 * * *'
# This makes the action run at the end of every day. Customize this accordingly or you can also trigger this action for GitHub events (Pull, Push). Check the GitHub actions page for that.
workflow_dispatch:
jobs:
updating-portfolio:
name: update-index-with-project
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: kaustubhgupta/PortfolioFy@main
with:
gh_token: ${{ secrets.TOKEN }} # Create a secret to store the access token
```
## Available Options 🤔
(To know more about each parameter, jump to [this](https://kaustubhgupta.github.io/PortfolioFy/#/./pages/Git-Actions-Parameters) page in the documentation)
| Option | Default Value | Description | Required | Example |
| -------------- | ------------- | ---------------------------------------------------------------------------- | -------- | ------- |
| `gh_token` | NA | GitHub Personal Access token | Yes | NA |
| `theme` | `1` | Level of the webpage you want to render: 1 or 2 | No | `1` |
| `blogs` | `False` | Include blogs in your Portfolio | No | `True` |
| `hackathons` | `False` | Include repositories that are tagged as `hackathon` topic | No | `True` |
| `stats_choice` | `1` | Type/Style of GitHub stats you want to include. A total of `8` types of GitHub stats are available. See the sections below for more information | No | `6` |
| `stats_customization` | Comming Soon | Customize the GitHub stats chosen by passing additional parameters supported | Comming Soon | Comming Soon|
| `social_links` | `False` | Links for Linkedin, Twitter, Dev. to, Medium, or Stackoverflow can be included. All handles are not necessary, you can provide them as comma-separated list as per need in any order | No | `'https://www.linkedin.com/in/kaustubh-gupta/, https://twitter.com/Kaustubh1828, https://medium.com/@kaustubhgupta1828, https://dev.to/kaustubhgupta, https://stackoverflow.com/users/14681298/kaustubh'`|
| `resume_link` | `False` | Link for resume uploaded online | No | `'https://drive.google.com/fnskaml...'` |
| `allow_footer` | `True` | Whether you want to display the credits of the creator at the end of the webpage | No | `False` |
| `project_sort_by` | `'stars'` | Control the sorting of projects by `'stars'` or `'forks'` | No | `'forks'` |
## Documentation 📜
The detailed documentation for this project is available [here](https://kaustubhgupta.github.io/PortfolioFy)
## Regarding Blog Updates
There is an action called [Blog Post Workflow](https://github.com/marketplace/actions/blog-post-workflow). You can easily integrate this in your workflow via this template: (Highly recommended!)
```yml
name: Latest blog post workflow
on:
push: # Every time index.html is pushed, this action runs and updates the blogs section!
jobs:
update-readme-with-blog:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: gautamkrishnar/blog-post-workflow@master
with:
feed_list:
max_post_count:
readme_path: index.html
template: "
$title
" # It is suggested not to modify this
gh_token: ${{ secrets.TOKEN }}
```
Make sure to enable the blogs parameter in the main workflow:
```yml
.
.
- uses: actions/checkout@v2
- uses: kaustubhgupta/PortfolioFy@main
with:
gh_token: ${{ secrets.TOKEN }}
blogs: True
```
## Examples
- [My Portfolio](https://www.kaustubhgupta.me/)
- [My Workflow File](https://github.com/kaustubhgupta/kaustubhgupta.github.io/blob/master/.github/workflows/website.yml)
- [My Blogs Workflow File](https://github.com/kaustubhgupta/kaustubhgupta.github.io/blob/master/.github/workflows/blog.yml)
## Happy?? Do Star ⭐ this Repo. 🤩
## Special Mentions 😃
- [Anurag Hazra](https://github.com/anuraghazra) (GitHub stats)
- [Simon Lecoq](https://github.com/lowlighter/metrics) (GitHub stats)
- [Casper](https://github.com/vn7n24fzkq) (GitHub stats)
- [Jonah Lawrence](https://github.com/DenverCoder1) (GitHub stats)
- [Joshua Clifford Reyes](https://github.com/LordDashMe) (GitHub stats)
- [ryo-ma](https://github.com/ryo-ma) (GitHub stats)
- [Vincent Voyer](https://github.com/vvo) (GitHub stats)
- [Ashutosh Dwivedi](https://github.com/Ashutosh00710) (GitHub Stats)
- [Gautam Krishna R](https://github.com/marketplace/actions/blog-post-workflow) (Blogpost Action)
- [Start Bootstrap](https://startbootstrap.com/theme/resume) (Amazing themes)
## License 📝
[](https://choosealicense.com/licenses/mit/)