Skip to content

Commit 69fe375

Browse files
committed
update for ver0.6.0
1 parent f87cb08 commit 69fe375

16 files changed

+42
-35
lines changed

CHANGE_LOG.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,10 @@
11
# Change Log
22

3+
## 2022-02-12, 0.6.0 release
4+
5+
* Added git block version.
6+
* New support for setting json file.
7+
38
## 2022-01-29, 0.5.0 release
49

510
* Use logarithm to calculate the height of the bars.

README.md

Lines changed: 13 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,6 @@
11
# GitHub Profile 3D Contrib.
22

3-
![svg](https://raw.githubusercontent.com/yoshi389111/github-profile-3d-contrib/main/docs/demo/profile-season-animate.svg)
4-
5-
![svg](https://raw.githubusercontent.com/yoshi389111/github-profile-3d-contrib/main/docs/demo/profile-green-animate.svg)
6-
7-
![svg](https://raw.githubusercontent.com/yoshi389111/github-profile-3d-contrib/main/docs/demo/profile-night-view.svg)
8-
9-
![svg](https://raw.githubusercontent.com/yoshi389111/github-profile-3d-contrib/main/docs/demo/profile-night-green.svg)
10-
11-
![svg](https://raw.githubusercontent.com/yoshi389111/github-profile-3d-contrib/main/docs/demo/profile-night-rainbow.svg)
3+
![svg](https://raw.githubusercontent.com/yoshi389111/github-profile-3d-contrib/main/docs/demo/profile-gitblock.svg)
124

135
[日本語](./docs/README.ja-jp.md)
146

@@ -53,7 +45,7 @@ jobs:
5345
name: generate-github-profile-3d-contrib
5446
steps:
5547
- uses: actions/checkout@v2
56-
- uses: yoshi389111/github-profile-3d-contrib@0.5.0
48+
- uses: yoshi389111/github-profile-3d-contrib@0.6.0
5749
env:
5850
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
5951
USERNAME: ${{ github.repository_owner }}
@@ -75,6 +67,7 @@ This will add the action to the repository.
7567
* `GITHUB_TOKEN` : (required) access token
7668
* `USERNAME` : (required) target user name (or specify with an argument).
7769
* `MAX_REPOS` : (optional) max repositories, default 100 - since ver. 0.2.0
70+
* `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
7871

7972
### step 3. Manually launch the action
8073

@@ -93,6 +86,11 @@ The profile image is generated with the following paths.
9386
* `profile-3d-contrib/profile-night-view.svg`
9487
* `profile-3d-contrib/profile-night-green.svg`
9588
* `profile-3d-contrib/profile-night-rainbow.svg`
89+
* `profile-3d-contrib/profile-gitblock.svg`
90+
91+
Alternatively, if `SETTING_JSON` is specified, the following image will be generated.
92+
93+
* `profile-3d-contrib/profile-customize.svg`
9694

9795
example: green version
9896

@@ -118,6 +116,10 @@ example: night reinbow version
118116

119117
![svg](https://raw.githubusercontent.com/yoshi389111/github-profile-3d-contrib/main/docs/demo/profile-night-rainbow.svg)
120118

119+
example: git block version
120+
121+
![svg](https://raw.githubusercontent.com/yoshi389111/github-profile-3d-contrib/main/docs/demo/profile-gitblock.svg)
122+
121123
### step 4. Add image to README.md
122124

123125
Add the path of the generated image to the readme file.
@@ -153,4 +155,4 @@ node . USER_NAME
153155

154156
MIT License
155157

156-
Copyright (C) 2021 SATO Yoshiyuki
158+
Copyright (C) 2021 SATO, Yoshiyuki

docs/README.ja-jp.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,6 @@
11
# GitHub Profile 3D Contrib.
22

3-
![svg](https://raw.githubusercontent.com/yoshi389111/github-profile-3d-contrib/main/docs/demo/profile-season-animate.svg)
4-
5-
![svg](https://raw.githubusercontent.com/yoshi389111/github-profile-3d-contrib/main/docs/demo/profile-green-animate.svg)
6-
7-
![svg](https://raw.githubusercontent.com/yoshi389111/github-profile-3d-contrib/main/docs/demo/profile-night-view.svg)
8-
9-
![svg](https://raw.githubusercontent.com/yoshi389111/github-profile-3d-contrib/main/docs/demo/profile-night-green.svg)
10-
11-
![svg](https://raw.githubusercontent.com/yoshi389111/github-profile-3d-contrib/main/docs/demo/profile-night-rainbow.svg)
3+
![svg](https://raw.githubusercontent.com/yoshi389111/github-profile-3d-contrib/main/docs/demo/profile-gitblock.svg)
124

135
## 概要
146

@@ -52,7 +44,7 @@ jobs:
5244
name: generate-github-profile-3d-contrib
5345
steps:
5446
- uses: actions/checkout@v2
55-
- uses: yoshi389111/github-profile-3d-contrib@0.5.0
47+
- uses: yoshi389111/github-profile-3d-contrib@0.6.0
5648
env:
5749
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
5850
USERNAME: ${{ github.repository_owner }}
@@ -74,6 +66,7 @@ jobs:
7466
* `GITHUB_TOKEN` : (必須) アクセストークン
7567
* `USERNAME` : (必須) 対象のユーザー名. (あるいは引数で指定する)
7668
* `MAX_REPOS` : (任意) 最大のリポジトリ数。デフォルトは100 - バージョン 0.2.0 で追加
69+
* `SETTING_JSON` : (任意) 設定JSONファイルパス。詳細は `yoshi389111/github-profile-3d-contrib` リポジトリの `sample-settings/*.json``src/type.ts` を参照してください - バージョン 0.6.0 で追加
7770

7871
### 手順 3. アクションを手動起動する
7972

@@ -93,6 +86,10 @@ jobs:
9386
* `profile-3d-contrib/profile-night-green.svg`
9487
* `profile-3d-contrib/profile-night-rainbow.svg`
9588

89+
あるいは、`SETTING_JSON` を指定した場合は、以下のファイルが生成されます。
90+
91+
* `profile-3d-contrib/profile-customize.svg`
92+
9693
例:green バージョン
9794

9895
![svg](https://raw.githubusercontent.com/yoshi389111/github-profile-3d-contrib/main/docs/demo/profile-green-animate.svg)
@@ -117,6 +114,9 @@ jobs:
117114

118115
![svg](https://raw.githubusercontent.com/yoshi389111/github-profile-3d-contrib/main/docs/demo/profile-night-rainbow.svg)
119116

117+
example: git block バージョン
118+
119+
![svg](https://raw.githubusercontent.com/yoshi389111/github-profile-3d-contrib/main/docs/demo/profile-gitblock.svg)
120120

121121
### 手順 4. README.md を追加
122122

@@ -153,4 +153,4 @@ node . USER_NAME
153153

154154
MIT License
155155

156-
Copyright (C) 2021 SATO Yoshiyuki
156+
Copyright (C) 2021 SATO, Yoshiyuki

docs/demo/profile-gitblock.svg

Lines changed: 1 addition & 0 deletions
Loading

docs/demo/profile-green-animate.svg

Lines changed: 1 addition & 1 deletion
Loading

docs/demo/profile-green.svg

Lines changed: 1 addition & 1 deletion
Loading

docs/demo/profile-night-green.svg

Lines changed: 1 addition & 1 deletion
Loading

docs/demo/profile-night-rainbow.svg

Lines changed: 1 addition & 1 deletion
Loading

docs/demo/profile-night-view.svg

Lines changed: 1 addition & 1 deletion
Loading

docs/demo/profile-season-animate.svg

Lines changed: 1 addition & 1 deletion
Loading

docs/demo/profile-season.svg

Lines changed: 1 addition & 1 deletion
Loading

docs/demo/profile-south-season-animate.svg

Lines changed: 1 addition & 1 deletion
Loading

docs/demo/profile-south-season.svg

Lines changed: 1 addition & 1 deletion
Loading

docs/profile-green-animate.svg

Lines changed: 0 additions & 1 deletion
This file was deleted.

package-lock.json

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "github-profile-3d-contrib",
3-
"version": "0.5.0",
3+
"version": "0.6.0",
44
"description": "Generate profile 3D Contributions",
55
"main": "dist/index.js",
66
"scripts": {

0 commit comments

Comments
 (0)