Skip to content

Latest commit

 

History

History
231 lines (157 loc) · 8.78 KB

README.ko.md

File metadata and controls

231 lines (157 loc) · 8.78 KB

GitHub 프로필 3D 기여도

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은 GitHub 기여도 캘린더를 3D 프로필 이미지로 생성합니다.

사용 방법 (GitHub Actions) - 기본

이 GitHub Action은 GitHub 프로필 3D 기여도 캘린더를 생성하여 저장소에 커밋합니다. GitHub 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 설정에서 비공개 저장소의 기여도를 포함하도록 변경할 수 있습니다. 이 설정을 변경하려면 표준 기여도 캘린더 오른쪽 상단의 Contribution settings를 클릭하거나 화면 오른쪽 상단의 아이콘을 클릭 후 Settings ⇒ Public profile ⇒ Contributions & Activity에서 Include private contributions on my profile을 체크하세요.

비공개 저장소의 추가 활동을 포함하려면 개인 액세스 토큰을 시크릿으로 등록하고 워크플로우 파일의 GITHUB_TOKEN 환경 변수에 설정하세요. 대부분의 경우 기본 secrets.GITHUB_TOKEN이면 충분합니다.

기본적으로 하루에 한 번 실행되도록 예약되어 있습니다. 원하는 시간으로 예약 시간을 변경할 수 있습니다.

이렇게 하면 워크플로우가 저장소에 추가됩니다.

환경 변수

샘플에서는 GITHUB_TOKEN과 USERNAME만 환경 변수로 지정되어 있지만, 다음 환경 변수를 지정할 수 있습니다:

  • GITHUB_TOKEN : (필수) 액세스 토큰
  • USERNAME : (필수) 대상 사용자 이름 (또는 인수로 지정)
  • MAX_REPOS : (선택) 최대 저장소 수, 기본값 100 - ver. 0.2.0부터
  • SETTING_JSON : (선택) 설정 json 파일 경로. 자세한 내용은 sample-settings/*.json 및 src/type.ts를 참고하세요. - ver. 0.6.0부터
  • GITHUB_ENDPOINT : (선택) Github GraphQL 엔드포인트. 예를 들어, 회사의 GitHub Enterprise 활동을 기반으로 기여도 캘린더를 만들고 싶다면 이 환경 변수를 설정하세요. 예: https://github.mycompany.com/api/graphql - ver. 0.8.0부터
  • YEAR : (선택) 과거 캘린더를 위해 연도를 지정하세요. 커맨드라인에서 도구를 실행할 때 지정합니다. - ver. 0.8.0부터

GITHUB_TOKEN에 대하여

샘플에서 GITHUB_TOKEN 환경 변수에 설정된 secrets.GITHUB_TOKEN은 GitHub에서 자동으로 생성되는 특별한 액세스 토큰입니다.

공개 저장소만을 위한 기여도 캘린더를 생성하려면 이 값을 사용하세요. 별도의 시크릿을 만들 필요가 없습니다.

또한, 비공개 저장소의 활동을 기여도 캘린더에 포함하려면 프로필 설정의 "Public profile" 섹션에서 "Include private contributions on my profile"을 체크하세요.

추가적인 비공개 저장소 활동 정보를 포함하려면 적절한 권한의 액세스 토큰을 생성하세요. 해당 액세스 토큰을 원하는 이름의 시크릿(예: 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에 이미지를 사용할 수 있습니다.

예시: green 버전

svg

예시: season 버전 (북반구)

svg

예시: season 버전 (남반구)

svg

예시: night view 버전

svg

예시: night green 버전

svg

예시: night rainbow 버전

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 라이선스 하에 제공됩니다.