diff --git a/CHANGE_LOG.md b/CHANGE_LOG.md index 5cf210a..9c393b5 100644 --- a/CHANGE_LOG.md +++ b/CHANGE_LOG.md @@ -1,5 +1,10 @@ # Change Log +## 2022-02-12, 0.6.0 release + +* Added git block version. +* New support for setting json file. + ## 2022-01-29, 0.5.0 release * Use logarithm to calculate the height of the bars. diff --git a/README.md b/README.md index 44bf5fa..d40f86f 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,6 @@ # GitHub Profile 3D Contrib. -![svg](https://raw.githubusercontent.com/yoshi389111/github-profile-3d-contrib/main/docs/demo/profile-season-animate.svg) - -![svg](https://raw.githubusercontent.com/yoshi389111/github-profile-3d-contrib/main/docs/demo/profile-green-animate.svg) - -![svg](https://raw.githubusercontent.com/yoshi389111/github-profile-3d-contrib/main/docs/demo/profile-night-view.svg) - -![svg](https://raw.githubusercontent.com/yoshi389111/github-profile-3d-contrib/main/docs/demo/profile-night-green.svg) - -![svg](https://raw.githubusercontent.com/yoshi389111/github-profile-3d-contrib/main/docs/demo/profile-night-rainbow.svg) +![svg](https://raw.githubusercontent.com/yoshi389111/github-profile-3d-contrib/main/docs/demo/profile-gitblock.svg) [日本語](./docs/README.ja-jp.md) @@ -53,7 +45,7 @@ jobs: name: generate-github-profile-3d-contrib steps: - uses: actions/checkout@v2 - - uses: yoshi389111/github-profile-3d-contrib@0.5.0 + - uses: yoshi389111/github-profile-3d-contrib@0.6.0 env: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} USERNAME: ${{ github.repository_owner }} @@ -75,6 +67,7 @@ This will add the action to the repository. * `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 @@ -93,6 +86,11 @@ The profile image is generated with the following paths. * `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 @@ -118,6 +116,10 @@ example: night reinbow version ![svg](https://raw.githubusercontent.com/yoshi389111/github-profile-3d-contrib/main/docs/demo/profile-night-rainbow.svg) +example: git block version + +![svg](https://raw.githubusercontent.com/yoshi389111/github-profile-3d-contrib/main/docs/demo/profile-gitblock.svg) + ### step 4. Add image to README.md Add the path of the generated image to the readme file. @@ -153,4 +155,4 @@ node . USER_NAME MIT License -Copyright (C) 2021 SATO Yoshiyuki +Copyright (C) 2021 SATO, Yoshiyuki diff --git a/docs/README.ja-jp.md b/docs/README.ja-jp.md index 36a0747..c4d43ba 100644 --- a/docs/README.ja-jp.md +++ b/docs/README.ja-jp.md @@ -1,14 +1,6 @@ # GitHub Profile 3D Contrib. -![svg](https://raw.githubusercontent.com/yoshi389111/github-profile-3d-contrib/main/docs/demo/profile-season-animate.svg) - -![svg](https://raw.githubusercontent.com/yoshi389111/github-profile-3d-contrib/main/docs/demo/profile-green-animate.svg) - -![svg](https://raw.githubusercontent.com/yoshi389111/github-profile-3d-contrib/main/docs/demo/profile-night-view.svg) - -![svg](https://raw.githubusercontent.com/yoshi389111/github-profile-3d-contrib/main/docs/demo/profile-night-green.svg) - -![svg](https://raw.githubusercontent.com/yoshi389111/github-profile-3d-contrib/main/docs/demo/profile-night-rainbow.svg) +![svg](https://raw.githubusercontent.com/yoshi389111/github-profile-3d-contrib/main/docs/demo/profile-gitblock.svg) ## 概要 @@ -52,7 +44,7 @@ jobs: name: generate-github-profile-3d-contrib steps: - uses: actions/checkout@v2 - - uses: yoshi389111/github-profile-3d-contrib@0.5.0 + - uses: yoshi389111/github-profile-3d-contrib@0.6.0 env: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} USERNAME: ${{ github.repository_owner }} @@ -74,6 +66,7 @@ jobs: * `GITHUB_TOKEN` : (必須) アクセストークン * `USERNAME` : (必須) 対象のユーザー名. (あるいは引数で指定する) * `MAX_REPOS` : (任意) 最大のリポジトリ数。デフォルトは100 - バージョン 0.2.0 で追加 +* `SETTING_JSON` : (任意) 設定JSONファイルパス。詳細は `yoshi389111/github-profile-3d-contrib` リポジトリの `sample-settings/*.json` や `src/type.ts` を参照してください - バージョン 0.6.0 で追加 ### 手順 3. アクションを手動起動する @@ -93,6 +86,10 @@ jobs: * `profile-3d-contrib/profile-night-green.svg` * `profile-3d-contrib/profile-night-rainbow.svg` +あるいは、`SETTING_JSON` を指定した場合は、以下のファイルが生成されます。 + +* `profile-3d-contrib/profile-customize.svg` + 例:green バージョン ![svg](https://raw.githubusercontent.com/yoshi389111/github-profile-3d-contrib/main/docs/demo/profile-green-animate.svg) @@ -117,6 +114,9 @@ jobs: ![svg](https://raw.githubusercontent.com/yoshi389111/github-profile-3d-contrib/main/docs/demo/profile-night-rainbow.svg) +example: git block バージョン + +![svg](https://raw.githubusercontent.com/yoshi389111/github-profile-3d-contrib/main/docs/demo/profile-gitblock.svg) ### 手順 4. README.md を追加 @@ -153,4 +153,4 @@ node . USER_NAME MIT License -Copyright (C) 2021 SATO Yoshiyuki +Copyright (C) 2021 SATO, Yoshiyuki diff --git a/docs/demo/profile-gitblock.svg b/docs/demo/profile-gitblock.svg new file mode 100644 index 0000000..454f0f7 --- /dev/null +++ b/docs/demo/profile-gitblock.svg @@ -0,0 +1 @@ +1101001K10KCommit876Issue11PullReq43Review4Repo10CTypeScriptKotlinShellPerlotherC 549TypeScript 146Kotlin 58Shell 49Perl 28other 46952contributions13513514142021-02-07 / 2022-02-12 \ No newline at end of file diff --git a/docs/demo/profile-green-animate.svg b/docs/demo/profile-green-animate.svg index 5745e38..b39f8be 100644 --- a/docs/demo/profile-green-animate.svg +++ b/docs/demo/profile-green-animate.svg @@ -1 +1 @@ -1-101001K10K+Commit842Issue11PullReq42Review3Repo10CTypeScriptKotlinShellPerlotherC 533TypeScript 133Kotlin 58Shell 44Perl 27other 47911911contributions626210102020-12-20 / 2021-12-22 \ No newline at end of file +1101001K10KCommit876Issue11PullReq43Review4Repo10CTypeScriptKotlinShellPerlotherC 549TypeScript 146Kotlin 58Shell 49Perl 28other 46952contributions13513514142021-02-07 / 2022-02-12 \ No newline at end of file diff --git a/docs/demo/profile-green.svg b/docs/demo/profile-green.svg index 00966cb..2ae5edd 100644 --- a/docs/demo/profile-green.svg +++ b/docs/demo/profile-green.svg @@ -1 +1 @@ -1-101001K10K+Commit842Issue11PullReq42Review3Repo10CTypeScriptKotlinShellPerlotherC 533TypeScript 133Kotlin 58Shell 44Perl 27other 47911911contributions626210102020-12-20 / 2021-12-22 \ No newline at end of file +1101001K10KCommit876Issue11PullReq43Review4Repo10CTypeScriptKotlinShellPerlotherC 549TypeScript 146Kotlin 58Shell 49Perl 28other 46952contributions13513514142021-02-07 / 2022-02-12 \ No newline at end of file diff --git a/docs/demo/profile-night-green.svg b/docs/demo/profile-night-green.svg index 7a7c478..5a900af 100644 --- a/docs/demo/profile-night-green.svg +++ b/docs/demo/profile-night-green.svg @@ -1 +1 @@ -1-101001K10K+Commit836Issue11PullReq42Review4Repo10CTypeScriptKotlinShellPerlotherC 525TypeScript 137Kotlin 58Shell 44Perl 27other 45907907contributions747412122021-01-10 / 2022-01-09 \ No newline at end of file +1101001K10KCommit876Issue11PullReq43Review4Repo10CTypeScriptKotlinShellPerlotherC 549TypeScript 146Kotlin 58Shell 49Perl 28other 46952contributions13513514142021-02-07 / 2022-02-12 \ No newline at end of file diff --git a/docs/demo/profile-night-rainbow.svg b/docs/demo/profile-night-rainbow.svg index 57131ee..6854e8b 100644 --- a/docs/demo/profile-night-rainbow.svg +++ b/docs/demo/profile-night-rainbow.svg @@ -1 +1 @@ -1-101001K10K+Commit842Issue11PullReq42Review3Repo10CTypeScriptKotlinShellPerlotherC 533TypeScript 133Kotlin 58Shell 44Perl 27other 47911911contributions626210102020-12-20 / 2021-12-22 \ No newline at end of file +1101001K10KCommit876Issue11PullReq43Review4Repo10CTypeScriptKotlinShellPerlotherC 549TypeScript 146Kotlin 58Shell 49Perl 28other 46952contributions13513514142021-02-07 / 2022-02-12 \ No newline at end of file diff --git a/docs/demo/profile-night-view.svg b/docs/demo/profile-night-view.svg index 667d40b..96a0886 100644 --- a/docs/demo/profile-night-view.svg +++ b/docs/demo/profile-night-view.svg @@ -1 +1 @@ -1-101001K10K+Commit842Issue11PullReq42Review3Repo10CTypeScriptKotlinShellPerlotherC 533TypeScript 133Kotlin 58Shell 44Perl 27other 47911911contributions626210102020-12-20 / 2021-12-22 \ No newline at end of file +1101001K10KCommit876Issue11PullReq43Review4Repo10CTypeScriptKotlinShellPerlotherC 549TypeScript 146Kotlin 58Shell 49Perl 28other 46952contributions13513514142021-02-07 / 2022-02-12 \ No newline at end of file diff --git a/docs/demo/profile-season-animate.svg b/docs/demo/profile-season-animate.svg index ad06b94..b26639d 100644 --- a/docs/demo/profile-season-animate.svg +++ b/docs/demo/profile-season-animate.svg @@ -1 +1 @@ -1-101001K10K+Commit842Issue11PullReq42Review3Repo10CTypeScriptKotlinShellPerlotherC 533TypeScript 133Kotlin 58Shell 44Perl 27other 47911911contributions626210102020-12-20 / 2021-12-22 \ No newline at end of file +1101001K10KCommit876Issue11PullReq43Review4Repo10CTypeScriptKotlinShellPerlotherC 549TypeScript 146Kotlin 58Shell 49Perl 28other 46952contributions13513514142021-02-07 / 2022-02-12 \ No newline at end of file diff --git a/docs/demo/profile-season.svg b/docs/demo/profile-season.svg index cc809aa..c730a7a 100644 --- a/docs/demo/profile-season.svg +++ b/docs/demo/profile-season.svg @@ -1 +1 @@ -1-101001K10K+Commit842Issue11PullReq42Review3Repo10CTypeScriptKotlinShellPerlotherC 533TypeScript 133Kotlin 58Shell 44Perl 27other 47911911contributions626210102020-12-20 / 2021-12-22 \ No newline at end of file +1101001K10KCommit876Issue11PullReq43Review4Repo10CTypeScriptKotlinShellPerlotherC 549TypeScript 146Kotlin 58Shell 49Perl 28other 46952contributions13513514142021-02-07 / 2022-02-12 \ No newline at end of file diff --git a/docs/demo/profile-south-season-animate.svg b/docs/demo/profile-south-season-animate.svg index 6ce6716..d28e322 100644 --- a/docs/demo/profile-south-season-animate.svg +++ b/docs/demo/profile-south-season-animate.svg @@ -1 +1 @@ -1-101001K10K+Commit842Issue11PullReq42Review3Repo10CTypeScriptKotlinShellPerlotherC 533TypeScript 133Kotlin 58Shell 44Perl 27other 47911911contributions626210102020-12-20 / 2021-12-22 \ No newline at end of file +1101001K10KCommit876Issue11PullReq43Review4Repo10CTypeScriptKotlinShellPerlotherC 549TypeScript 146Kotlin 58Shell 49Perl 28other 46952contributions13513514142021-02-07 / 2022-02-12 \ No newline at end of file diff --git a/docs/demo/profile-south-season.svg b/docs/demo/profile-south-season.svg index a720d14..c87dec5 100644 --- a/docs/demo/profile-south-season.svg +++ b/docs/demo/profile-south-season.svg @@ -1 +1 @@ -1-101001K10K+Commit842Issue11PullReq42Review3Repo10CTypeScriptKotlinShellPerlotherC 533TypeScript 133Kotlin 58Shell 44Perl 27other 47911911contributions626210102020-12-20 / 2021-12-22 \ No newline at end of file +1101001K10KCommit876Issue11PullReq43Review4Repo10CTypeScriptKotlinShellPerlotherC 549TypeScript 146Kotlin 58Shell 49Perl 28other 46952contributions13513514142021-02-07 / 2022-02-12 \ No newline at end of file diff --git a/docs/profile-green-animate.svg b/docs/profile-green-animate.svg deleted file mode 100644 index a0521e5..0000000 --- a/docs/profile-green-animate.svg +++ /dev/null @@ -1 +0,0 @@ -CommitIssuePullReqReviewRepoJupyter NotebookTypeScriptGoPythonJavaScriptother360contributions802020-05-10/2021-05-09 \ No newline at end of file diff --git a/package-lock.json b/package-lock.json index 058f9aa..fcdaf44 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "github-profile-3d-contrib", - "version": "0.5.0", + "version": "0.6.0", "lockfileVersion": 2, "requires": true, "packages": { "": { "name": "github-profile-3d-contrib", - "version": "0.5.0", + "version": "0.6.0", "license": "MIT", "dependencies": { "@actions/core": "^1.2.7", diff --git a/package.json b/package.json index c074025..5029320 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "github-profile-3d-contrib", - "version": "0.5.0", + "version": "0.6.0", "description": "Generate profile 3D Contributions", "main": "dist/index.js", "scripts": {