Skip to content

README.zh-TW.md

Latest commit

 

History

History
231 lines (157 loc) · 7.67 KB

README.zh-TW.md

File metadata and controls

231 lines (157 loc) · 7.67 KB

GitHub Profile 3D Contrib

svg

English (en) | Deutsch (de) | Español (es) | Français (fr) | 日本語 (ja) | 한국어 (ko) | Português (pt-BR) | Português (pt) | Русский (ru) | 简体中文 (zh-CN) | 繁體中文 (zh-TW) |

Note

本翻譯由機器自動生成。 可能包含錯誤或不自然的表達。 歡迎協助改進翻譯！

概述

此 GitHub Action 會在 3D 個人檔案圖片上建立 GitHub 貢獻日曆。

如何使用（GitHub Actions）- 基本

此 GitHub Action 會產生您的 3D 貢獻日曆並提交到您的倉庫。 新增 Action 後，工作流程每天會自動執行一次。 您也可以手動觸發工作流程。

步驟 1. 建立特殊個人檔案倉庫

在 GitHub 上建立一個與您的使用者名稱相同的倉庫。

在此倉庫中，請依照以下步驟操作。

步驟 2. 建立工作流程檔案

建立如下的工作流程檔案。

  • .github/workflows/profile-3d.yml
name: GitHub-Profile-3D-Contrib

on:
  schedule: # 03:00 JST == 18:00 UTC
    - cron: "0 18 * * *"
  workflow_dispatch:

permissions:
  contents: write

jobs:
  build:
    runs-on: ubuntu-latest
    name: generate-github-profile-3d-contrib
    steps:
      - uses: actions/checkout@v5
      - uses: yoshi389111/github-profile-3d-contrib@latest
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
          USERNAME: ${{ github.repository_owner }}
      - name: Commit & Push
        run: |
          git config user.name github-actions
          git config user.email github-actions@github.com
          git add -A .
          if git commit -m "generated"; then
            git push
          fi

Note

您可以變更 GitHub 設定以包含私人倉庫的貢獻。請點選標準貢獻日曆右上角的「貢獻設定」，或點選右上角的個人圖示，選擇「設定」⇒「公開個人檔案」⇒「貢獻與活動」，並勾選「在我的個人檔案中包含私人貢獻」。

若要額外包含私人倉庫的活動，請將個人存取權杖註冊為機密，並在工作流程檔案中設定為 GITHUB_TOKEN 環境變數。但大多數情況下，預設的 secrets.GITHUB_TOKEN 已足夠。

預設排程為每天執行一次。 您可依需求調整排程時間。

這會將工作流程新增至您的倉庫。

環境變數

範例中僅指定了 GITHUB_TOKEN 和 USERNAME，但您可指定以下環境變數：

  • GITHUB_TOKEN：（必填）存取權杖
  • USERNAME：（必填）目標使用者名稱（或以參數指定）。
  • MAX_REPOS：（選填）最大倉庫數，預設 100 - 自 v0.2.0 起
  • SETTING_JSON：（選填）設定 json 檔案路徑。詳見 sample-settings/*.json 及 src/type.ts。- 自 v0.6.0 起
  • GITHUB_ENDPOINT：（選填）Github GraphQL 端點。例如，若要根據公司 GitHub Enterprise 活動建立貢獻日曆，請設定此環境變數。例如：https://github.mycompany.com/api/graphql - 自 v0.8.0 起
  • YEAR：（選填）指定年份以產生過去的日曆。僅限命令列執行時指定。- 自 v0.8.0 起

關於 GITHUB_TOKEN

範例中於 GITHUB_TOKEN 環境變數設定的 secrets.GITHUB_TOKEN 為 GitHub 自動建立的特殊存取權杖。

若僅需產生公開倉庫的貢獻日曆，請使用此值。 無需手動建立機密。

若要在貢獻日曆中包含私人倉庫活動，請在個人檔案設定的「公開個人檔案」→「貢獻與活動」中勾選「在我的個人檔案中包含私人貢獻」。

若要額外包含私人倉庫的活動資訊，請建立具有適當權限的存取權杖。 將該權杖註冊為機密，名稱可自訂（如 MY_PERSONAL_ACCESS_TOKEN）。 但請注意，使用者建立的機密名稱不可以 GITHUB_ 開頭。

將該機密設為 GITHUB_TOKEN 環境變數的值。

          env:
-           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+           GITHUB_TOKEN: ${{ secrets.MY_PERSONAL_ACCESS_TOKEN }}
            USERNAME: ${{ github.repository_owner }}

關於排程時間

範例設定為 18:00 UTC 執行。 這是因為作者的本地時間為 JST 午夜。

on:
  schedule: # 03:00 JST == 18:00 UTC
    - cron: "0 18 * * *"

您可自由調整時間。 建議設為本地時間午夜（約凌晨 3 點）。 但請注意，時間需以 UTC 指定。

步驟 3. 手動執行 GitHub Action

首次請手動執行此工作流程。

  • Actions -> GitHub-Profile-3D-Contrib -> Run workflow

個人檔案圖片將產生於以下路徑：

  • 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

若指定 SETTING_JSON 環境變數且 json 檔案未含 fileName 屬性，將產生以下圖片：

  • profile-3d-contrib/profile-customize.svg

您可依下例於 README.md 使用這些圖片。

範例：綠色版本

svg

範例：季節版（北半球）

svg

範例：季節版（南半球）

svg

範例：夜景版

svg

範例：夜綠版

svg

範例：夜彩虹版

svg

範例：Git Block 版

svg

步驟 4. 將圖片加入 README.md

將產生的圖片路徑加入您的 README 檔案。

範例：

![](./profile-3d-contrib/profile-green-animate.svg)

如何使用（GitHub Actions）- 進階範例

如何使用（本地端）

請將 GITHUB_TOKEN 環境變數設為您的個人存取權杖。

export GITHUB_TOKEN=XXXXXXXXXXXXXXXXXXXXX

執行下列指令，將 USER_NAME 替換為您的 GitHub 使用者名稱或目標使用者名稱。

node_modules/.bin/ts-node src/index.ts USER_NAME

或

npm run build
node . USER_NAME

授權

© 2021 SATO Yoshiyuki. 授權採用 MIT License。