Skip to content

Latest commit

 

History

History
476 lines (305 loc) · 21 KB

File metadata and controls

476 lines (305 loc) · 21 KB

Important

We are looking for translators for this project.
Any kind of help would be greatly appreciated.
Please see issue #23 if you would like to help!

README에 추가된 기능 플래그와 개발 메트릭스 🎌

Project Preview

Project Preview

📌✨Awesome README Stats


Star Badge

당신은 조기 🐤인가요, 밤 owl 🦉인가요?
하루 중 언제가 가장 생산적인가요?
어떤 언어로 코드를 작성하나요?
프로필의 README에서 확인해 보세요!

버그 신고 기능 요청

준비 작업

  1. .md 파일의 마크다운 파일을 2개의 주석으로 업데이트해야 합니다. 업데이트 방법은 여기를 참조하십시오.
  2. WakaTime API 키가 필요합니다. 이는 WakaTime 계정 설정에서 얻을 수 있습니다.
    • WakaTime에 새로 오셨다면 여기를 참조하십시오.
  3. 커밋 메트릭을 얻기 위해 액션을 실행하는 경우, 여기에서 repouser 범위를 가진 GitHub API 토큰이 필요합니다.
    • 예제를 사용하여 이를 설정할 수 있습니다.

Note

Enabling the repo scope seems DANGEROUS,
but this GitHub Action only accesses your commit timestamps and the number of lines of code added or deleted in repositories that you contributed to.

  1. 저장소 비밀에 WakaTime API 키와 GitHub API 토큰을 저장해야 합니다. 이는 저장소의 설정에서 찾을 수 있습니다.
    다음처럼 저장해야 합니다:
    • WakaTime API 키를 WAKATIME_API_KEY=<your wakatime API Key>로 저장
    • GitHub 개인 액세스 토큰(PAT)을 GH_TOKEN=<your github access token>로 저장
  2. 요구사항에 따라 기능 플래그를 활성화하거나 비활성화할 수 있습니다.

이 GitHub Action은 원하는 시간에 cron을 사용하여 실행할 수 있습니다. cron 표현식을 생성하려면 Crontab.guruthis 웹사이트를 참조하세요.

README 업데이트

README.md에 다음과 같은 주석을 추가하세요:

<!--START_SECTION:waka-->
<!--END_SECTION:waka-->

waka사용 가능한 플래그 섹션에 명시된 SECTION_NAME 플래그로 지정된 문자열로 대체될 수 있습니다.

이 줄들은 개발 메트릭스의 진입점이 될 것입니다.

WakaTime을 처음 사용하는 경우

WakaTime은 실제로 코딩에 소요된 시간을 알려줍니다. 이는 생산성과 경쟁력을 높이는 데 도움이 됩니다.

프로필 저장소

GitHub Access Token을 가져와야 하며, repouser 범위를 포함해야 하며, Repo Secrets에 GH_TOKEN = <Your GitHub Access Token>으로 저장해야 합니다.

다음은 이를 실행하는 샘플 워크플로우 파일입니다:

name: Waka Readme

on:
  schedule:
    # Runs at 12am IST
    - cron: '30 18 * * *'
  workflow_dispatch:
jobs:
  update-readme:
    name: Update Readme with Metrics
    runs-on: ubuntu-latest
    steps:
      - uses: anmol098/waka-readme-stats@master
        with:
          WAKATIME_API_KEY: ${{ secrets.WAKATIME_API_KEY }}
          GH_TOKEN: ${{ secrets.GH_TOKEN }}
  • 이제 커밋하고 자동으로 실행되기를 기다릴 수 있고, 즉시 결과를 확인하려면 Actions로 이동하여 Profile Readme Development Stats 워크플로우를 선택하고 Run workflow를 클릭하세요. 이제 1분 정도 기다리면 변경사항을 확인할 수 있습니다.

Extras

기본적으로 모든 플래그는 활성화되어 있습니다(코드 줄 수 플래그는 수행되는 중간 작업이 많기 때문에 예외). 통계에 추가 정보를 추가하고 싶다면 워크플로우 파일에 여러 개의 FLAGS를 추가할 수 있습니다.

- uses: anmol098/waka-readme-stats@master
  with:
      WAKATIME_API_KEY: ${{ secrets.WAKATIME_API_KEY }}
      GH_TOKEN: ${{ secrets.GH_TOKEN }}
      SHOW_OS: "False"
      SHOW_PROJECTS: "False"

사용 가능한 플래그


LOCALE 이 플래그는 사용자의 언어로 통계를 표시할 수 있습니다. 기본값은 영어입니다. 플래그 변수에 Short Hand 형식의 로케일 코드를 전달해야 합니다. 최종 결과 예시는 여기에서 확인할 수 있습니다.

SECTION_NAME 플래그는 임의의 문자열로 설정할 수 있으며, README에서 대체할 섹션의 이름이 됩니다.

COMMIT_BY_ME 플래그는 True로 설정하여 이름과 이메일을 사용하여 코드를 커밋할 수 있습니다.

COMMIT_MESSAGE 플래그는 커밋 메시지를 설정할 수 있습니다. 기본값은 "Updated with Dev Metrics"입니다.

COMMIT_USERNAME 플래그는 커밋에 사용할 사용자 이름을 설정할 수 있습니다. 기본값은 "readme-bot"입니다.

COMMIT_EMAIL 플래그는 커밋에 사용할 이메일을 설정할 수 있습니다. 기본값은 "41898282+github-actions[bot]@users.noreply.github.com"입니다.

SHOW_UPDATED_DATE 플래그는 True로 설정하여 단락의 끝에 업데이트된 날짜를 표시할 수 있습니다.

UPDATED_DATE_FORMAT 플래그는 업데이트된 날짜를 특정 형식으로 표시할 수 있습니다. 기본값은 "%d/%m/%Y %H:%M:%S"입니다.

SHOW_LINES_OF_CODE 플래그는 True로 설정하여 오늘까지 작성된 코드 줄 수를 표시할 수 있습니다.

Lines of Code

SHOW_TOTAL_CODE_TIME 플래그는 False로 설정하여 Code Time을 숨길 수 있습니다.

Code Time

SHOW_PROFILE_VIEWS 플래그는 False로 설정하여 Profile Views를 숨길 수 있습니다.

Profile Views

SHOW_COMMIT 플래그는 False로 설정하여 커밋 통계를 숨길 수 있습니다.

나는 초기 🐤

🌞 Morning    95 commits     ███████░░░░░░░░░░░░░░░░░░   30.55% 
🌆 Daytime    78 commits     ██████░░░░░░░░░░░░░░░░░░░   25.08% 
🌃 Evening    112 commits    █████████░░░░░░░░░░░░░░░░   36.01% 
🌙 Night      26 commits     ██░░░░░░░░░░░░░░░░░░░░░░░   8.36%

SHOW_DAYS_OF_WEEK 플래그를 False로 설정하여 주간 각 날짜에 대한 커밋을 숨길 수 있습니다.

📅 일요일에 가장 생산성이 높습니다

Monday       50 commits     ███░░░░░░░░░░░░░░░░░░░░░░   13.19% 
Tuesday      85 commits     █████░░░░░░░░░░░░░░░░░░░░   22.43% 
Wednesday    56 commits     ███░░░░░░░░░░░░░░░░░░░░░░   14.78% 
Thursday     44 commits     ███░░░░░░░░░░░░░░░░░░░░░░   11.61% 
Friday       28 commits     █░░░░░░░░░░░░░░░░░░░░░░░░   7.39% 
Saturday     30 commits     ██░░░░░░░░░░░░░░░░░░░░░░░   7.92% 
Sunday       86 commits     █████░░░░░░░░░░░░░░░░░░░░   22.69%

SHOW_LANGUAGE 플래그를 False로 설정하여 사용하는 프로그래밍 언어를 숨길 수 있습니다.

💬 Languages:
JavaScript               5 hrs 26 mins       ███████████████░░░░░░░░░░   61.97%
PHP                      1 hr 35 mins        ████░░░░░░░░░░░░░░░░░░░░░   18.07%
Markdown                 1 hr 9 mins         ███░░░░░░░░░░░░░░░░░░░░░░   13.3%
Python                   22 mins             █░░░░░░░░░░░░░░░░░░░░░░░░   4.32%
XML                      8 mins              ░░░░░░░░░░░░░░░░░░░░░░░░░   1.62%

SHOW_OS 플래그를 False로 설정하여 OS 세부 정보를 숨길 수 있습니다.

💻 Operating Systems:
Windows                  8 hrs 46 mins       █████████████████████████   100.0%

SHOW_PROJECTS 플래그를 False로 설정하여 작업한 프로젝트를 숨길 수 있습니다.

🐱‍💻 Projects:
ctx_connector            4 hrs 3 mins        ███████████░░░░░░░░░░░░░░   46.33%
NetSuite-Connector       1 hr 31 mins        ████░░░░░░░░░░░░░░░░░░░░░   17.29%
mango-web-master         1 hr 12 mins        ███░░░░░░░░░░░░░░░░░░░░░░   13.77%
cable                    54 mins             ██░░░░░░░░░░░░░░░░░░░░░░░   10.41%
denAPI                   40 mins             ██░░░░░░░░░░░░░░░░░░░░░░░   7.66%

SHOW_TIMEZONE 플래그를 False로 설정하여 현재 시간대를 숨길 수 있습니다.

⌚︎ Timezone: Asia/Calcutta

SHOW_EDITORS 플래그를 False로 설정하여 사용된 코드 편집기/IDE 목록을 숨길 수 있습니다.

🔥 Editors:
WebStorm                 6 hrs 47 mins       ███████████████████░░░░░░   77.43%
PhpStorm                 1 hr 35 mins        ████░░░░░░░░░░░░░░░░░░░░░   18.07%
PyCharm                  23 mins             █░░░░░░░░░░░░░░░░░░░░░░░░   4.49%

SHOW_LANGUAGE_PER_REPO 플래그를 False로 설정하여 다양한 프로그래밍 언어 및 프레임워크별로 저장소 수를 숨길 수 있습니다.

저는 주로 Vue로 코드를 작성합니다

Vue          8 repos        ██████░░░░░░░░░░░░░░░░░░░   25.0% 
Java         6 repos        ████░░░░░░░░░░░░░░░░░░░░░   18.75% 
JavaScript   6 repos        ████░░░░░░░░░░░░░░░░░░░░░   18.75% 
PHP          3 repos        ██░░░░░░░░░░░░░░░░░░░░░░░   9.38% 
Python       2 repos        █░░░░░░░░░░░░░░░░░░░░░░░░   6.25% 
Dart         2 repos        █░░░░░░░░░░░░░░░░░░░░░░░░   6.25% 
CSS          2 repos        █░░░░░░░░░░░░░░░░░░░░░░░░   6.25%

SHOW_SHORT_INFO 플래그를 False로 설정하여 사용자의 짧은 재미있는 사실 정보를 숨길 수 있습니다.

Note

This section requires a Personal Access Token (PAT) with the user scope, otherwise the data shown here will be incorrect.

🐱 My GitHub Data

🏆 2020년에 433 Contributions

📦 GitHub 저장소에서 292.3 kB 사용

💼 채용 선택

📜 25개 공개 저장소

🔑 15개 소유한 비공개 저장소

SHOW_LOC_CHART 플래그를 False로 설정하여 연도별로 분기별로 작성된 코드 줄 수를 숨길 수 있습니다.

IGNORED_REPOS 플래그를 "waka-readme-stats, my-first-repo"(예시)로 설정하여 일부 계산하지 않으려는 저장소를 무시할 수 있습니다.

SYMBOL_VERSION 플래그는 진행 표시줄의 기호를 위해 설정할 수 있으며, 기본값은 1입니다.

버전 완료 블록 빈 블록
1
2
3

DEBUG_LOGGING 플래그를 설정하여 GitHub Action의 출력 세부 정보 수준을 높일 수 있으며, 기본값은 내부 실행자 디버그 속성과 같습니다.

타임라인

Chart not found

💖 프로젝트 지원

나는 할 수 있는 모든 것을 오픈소스로 공개하고, 이 프로젝트를 사용하여 도움이 필요한 사람들의 요청에 답하려고 노력하고 있다. 당연하게도, 이 모든 과정은 시간이 많이 걸린다. 이 서비스는 무료로 사용할 수 있다.

그러나, 이 프로젝트를 사용하고 있고 만족하거나, 계속해서 새로운 것을 만들기를 원한다면 몇 가지 방법으로 도움을 줄 수 있다 :-

  • 이 액션을 사용할 때 readme에 적절한 인용을 하고, 다시 이 프로젝트로 연결해 주는 것 :D
  • 프로젝트를 스타링하고 공유하는 것 🚀
  • paypal.me/aapreneur - PayPal을 통해 일회성 기부를 할 수 있다. 아마도 맥주 와인 🍷를 사게 될 것이다.

감사합니다! ❤️

기여

기여는 환영합니다 ♥! 기능을 공유하고 단위 테스트를 추가해 주세요! pull request와 issue 시스템을 사용하여 기여해 주세요.

선택된 기여자

  1. Anmol Pratap Singh: 유지자
  2. Alexander Sergeev: 유지자
  3. DataBoySu: 유지자
  4. okcoder1: 유지자
  5. Aravind V. Nair: 유지자
  6. Prabhat Singh: 코드 타임라인 그래프를 위한 기여 #18
  7. Hedy Li: Pull Request #34#23을 위한 기여
  8. Pedro Torres: Pull Request #29을 위한 기여
  9. Aaron Meese: Pull Request #45을 위한 기여
  10. Arnav Jindal: Pull Request #48을 위한 기여
  11. Daniel Rowe: Pull Request #57을 위한 기여
  12. Ss5h: 번역을 위한 자연어 문장 작성 지원 추가 #136
Special mention for those who are currently making their profile readme more awesome 😄 🎉
  • 그리고 당신! 만약 지금 그것을 사용하고 있고 목록에 없으면 Special Mention 이슈를 보내서 알려주세요! 😊
    목록에 추가해 드릴 수 있어요.

❤️ 과 Python 🐍로 만들어졌습니다.

영감을 받은 출처

Awesome Pinned Gists
athul/waka-readme

이 프로젝트는 당신의 star ⭐ from you ♥가 필요합니다

시간에 따른 Stargazers 수

Stargazers over time