Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kaustubhgupta/readme-projects-display
🔥 Display your projects information on your profile README
https://github.com/kaustubhgupta/readme-projects-display
github-actions github-api hacktoberfest profile-readme project project-management pygithub pygithub-examples python readme
Last synced: 22 days ago
JSON representation
🔥 Display your projects information on your profile README
- Host: GitHub
- URL: https://github.com/kaustubhgupta/readme-projects-display
- Owner: kaustubhgupta
- License: mit
- Created: 2021-03-24T15:18:51.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2021-10-15T13:25:20.000Z (about 3 years ago)
- Last Synced: 2024-10-06T05:18:11.620Z (about 1 month ago)
- Topics: github-actions, github-api, hacktoberfest, profile-readme, project, project-management, pygithub, pygithub-examples, python, readme
- Language: Python
- Homepage: https://github.com/marketplace/actions/readme-projects-display
- Size: 154 KB
- Stars: 15
- Watchers: 2
- Forks: 4
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
GitHub's Profile readme is a great tool to showcase your skills and projects to potential recruiters/developers. This GitHub action allows you to update a particular section of README with your Project details. These include the project name, stars, and a controllable amount of description.
## Getting Your Profile Ready
- Add this comment in your README.md/specified file:
```
```
- The repositories need to have `project` topics to add them to the project section.
- 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 personal repositories access then they will be added to the sections but their links will not work for others_
## Action Setup
GitHub actions can be integrated into any repository. Create a new folder called `.github/workflows/.yml`. Paste the following starter code:
```yml
name: Update Projects
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:
# workflow_dispatch allows you to trigger the action any time manually
jobs:
update-readme-with-projects:
name: Update this repo's README with latest project updates
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: kaustubhgupta/readme-projects-display@master
with:
gh_token: ${{ secrets.TOKEN }} # Create a secret to store the access token
```
## Available Options
| Option | Default Value | Description | Required | Example |
| -------------- | ------------- | ---------------------------------------------------------------------------- | -------- | ------- |
| `gh_token` | NA | GitHub Personal Access token | Yes | NA |
| `file_name` | `README.md` | Name of the readme file or any other file containing the comment mentioned above. Note: The file needs to be at the root of the repository. (Dynamic paths coming in next version!) | No | myfile.txt/ myfile.html |
| `max_repo_description` | 50 | How much description you want to Display | No | 40 |
| `allow_forks` | True | Control if you want to display the number of forks of the repository | No | False |
| `project_sort_by` | `stars` | Control the sorting of projects by `'stars'` or `'forks'` | No | `'forks'` |
## Examples
- [My Workflow File](https://github.com/kaustubhgupta/kaustubhgupta/blob/master/.github/workflows/project-updater.yml)
**Happy?? Do Star ⭐ this Repo. 🤩**
## License
[](https://choosealicense.com/licenses/mit/)