Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/yoshi389111/github-profile-3d-contrib
This GitHub Action creates a GitHub contribution calendar on a 3D profile image.
https://github.com/yoshi389111/github-profile-3d-contrib
github-action github-contribution-graph github-contributions github-profile github-profile-readme profile-readme
Last synced: about 2 months ago
JSON representation
This GitHub Action creates a GitHub contribution calendar on a 3D profile image.
- Host: GitHub
- URL: https://github.com/yoshi389111/github-profile-3d-contrib
- Owner: yoshi389111
- License: mit
- Created: 2021-05-08T14:12:59.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-05-11T16:10:49.000Z (4 months ago)
- Last Synced: 2024-05-18T14:02:14.904Z (4 months ago)
- Topics: github-action, github-contribution-graph, github-contributions, github-profile, github-profile-readme, profile-readme
- Language: TypeScript
- Homepage:
- Size: 29.1 MB
- Stars: 923
- Watchers: 8
- Forks: 141
- Open Issues: 18
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGE_LOG.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome - yoshi389111/github-profile-3d-contrib - This GitHub Action creates a GitHub contribution calendar on a 3D profile image. (TypeScript)
README
# GitHub Profile 3D Contrib.
[日本語](./docs/README.ja-jp.md) | [Español](./docs/README.es-es.md)
## Overview
This GitHub Action creates a GitHub contribution calendar on a 3D profile image.
## How to use (GitHub Actions) - Basic
This action generate your github profile 3d contribute calendar and make a commit to your repo.
You can also trigger action by yourself after add this action.
### step 1. Create special repository.
Create a repository on GitHub with the same name as your user name.
* e.g. If the user name is `octocat`, create a repository named `octocat/octocat`.
* ref. [Managing your profile README](https://docs.github.com/en/github/setting-up-and-managing-your-github-profile/managing-your-profile-readme)
In this repository, do the following.
### step 2. Create workflow file.
Create a workflow file like the one below.
* `.github/workflows/profile-3d.yml`
The schedule is set to start once a day.
Please correct the startup time to a convenient time.
```yaml:.github/workflows/profile-3d.yml
name: GitHub-Profile-3D-Contrib
on:
schedule: # 03:00 JST == 18:00 UTC
- cron: "0 18 * * *"
workflow_dispatch:
jobs:
build:
runs-on: ubuntu-latest
name: generate-github-profile-3d-contrib
steps:
- uses: actions/checkout@v3
- uses: yoshi389111/[email protected]
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
USERNAME: ${{ github.repository_owner }}
- name: Commit & Push
run: |
git config user.name github-actions
git config user.email [email protected]
git add -A .
git commit -m "generated"
git push
```
Note: If you also want to include the private repository, register the "personal access token" in the repository and set it to GITHUB_TOKEN specified in the workflow file.
This will add the action to the repository.
#### Environment variables
* `GITHUB_TOKEN` : (required) access token
* `USERNAME` : (required) target user name (or specify with an argument).
* `MAX_REPOS` : (optional) max repositories, default 100 - since ver. 0.2.0
* `SETTING_JSON` : (optional) settings json file path. See `sample-settings/*.json` and `src/type.ts` in `yoshi389111/github-profile-3d-contrib` repository for details. - since ver. 0.6.0
### step 3. Manually launch the action
Launch the added action.
* `Actions` -> `GitHub-Profile-3D-Contrib` -> `Run workflow`
The profile image is generated with the following paths.
* `profile-3d-contrib/profile-green-animate.svg`
* `profile-3d-contrib/profile-green.svg`
* `profile-3d-contrib/profile-season-animate.svg`
* `profile-3d-contrib/profile-season.svg`
* `profile-3d-contrib/profile-south-season-animate.svg`
* `profile-3d-contrib/profile-south-season.svg`
* `profile-3d-contrib/profile-night-view.svg`
* `profile-3d-contrib/profile-night-green.svg`
* `profile-3d-contrib/profile-night-rainbow.svg`
* `profile-3d-contrib/profile-gitblock.svg`
Alternatively, if `SETTING_JSON` is specified, the following image will be generated.
* `profile-3d-contrib/profile-customize.svg`
example: green version
example: season version (Northern Hemisphere.)
example: season version (Southern Hemisphere.)
example: night view version
example: night green version
example: night rainbow version
example: git block version
### step 4. Add image to README.md
Add the path of the generated image to the readme file.
e.g.
```md
```
## How to use (GitHub Actions) - Advanced examples
#### [More info in EXAMPLES.md](./EXAMPLES.md)
## How to use (local)
Set the `GITHUB_TOKEN` environment variable to the value of "personal access token".
```shell-session
export GITHUB_TOKEN=XXXXXXXXXXXXXXXXXXXXX
```
Run it with your GitHub user specified.
```shell-session
node_modules/.bin/ts-node src/index.ts USER_NAME
```
or
```shell-session
npm run build
node . USER_NAME
```
## Licence
MIT License
(C) 2021 SATO, Yoshiyuki