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!
あなたは早朝の🐤ですか、それとも夜型の🦉ですか？
1日のうちで最も生産的な時間はいつですか？
あなたがコードを書く言語は何ですか？
プロフィールのREADMEで確認しましょう！
.mdファイルのマークダウンファイルを2つのコメントで更新する必要があります。更新方法はこちらを参照してください。- WakaTime APIキーが必要です。これはWakaTimeアカウント設定から取得できます。
- WakaTimeに新規ユーザーの場合、こちらを参照してください。
- コミットメトリクスを取得するアクションを実行する場合、こちらから
repoおよびuserスコープを持つ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.
- リポジトリのシークレットにWakaTime APIキーおよびGitHub APIトークンを保存する必要があります。リポジトリの「設定」で確認できます。
以下の通りに保存してください:- WakaTime APIキーを
WAKATIME_API_KEY=<your wakatime API Key>として保存 - GitHubパーソナルアクセストークン(PAT)を
GH_TOKEN=<your github access token>として保存
- WakaTime APIキーを
- ご要望に応じて、機能フラグを有効または無効にできます。
このGitHub Actionは、cronを使用していつでも実行できます。cron式を生成するには、Crontab.guruおよびthisのウェブサイトをご覧ください。
README.mdにコメントを追加する例:
<!--START_SECTION:waka-->
<!--END_SECTION:waka-->waka は、利用可能なフラグセクション に記載されている SECTION_NAME フラグで指定された任意の文字列に置き換えることができます。
これらの行は、開発者メトリクスのエントリポイントとなります。
WakaTimeは、実際にコーディングに費やした時間を把握するのに役立ちます。これにより、生産性と競争力を向上させることができます。
- https://wakatime.comにアクセスし、アカウントを作成してください。
- WakaTimeのアカウント設定からWakaTime APIキーを取得してください。
- お気に入りのエディタ/IDEにWakaTimeプラグインをインストールしてください。
- APIキーを貼り付け、分析を開始してください。
repo および user スコープを持つ GitHub Access Token を取得し、リポジトリシークレット 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〜2分待つと、変更内容が表示されます。
他の情報を統計に追加したい場合は、ワークフロー ファイルに複数の 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 このフラグは、自分の言語で統計を表示するために使用できます。デフォルトは英語です。フラグ変数に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 に設定すると、これまでに書かれたコードの行数を表示します。
SHOW_TOTAL_CODE_TIME フラグを False に設定すると、Code Time を非表示にします。
SHOW_PROFILE_VIEWS フラグを False に設定すると、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
📦 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の出力の詳細度を増やすことができます。デフォルトでは内部ランナーのデバッグプロパティに等しくなります。
タイムライン
私はできる限りすべてをオープンソース化しており、これらのプロジェクトを使って助けが必要な人全員に返信しようと努力しています。明らかに、これは時間がかかります。このサービスは無料で利用できます。
しかし、このプロジェクトを使用していて満足している、またはただ継続して作成することを奨励したいだけでも、いくつかの方法があります :-
- このアクションを使用するときに readme で適切なクレジットを記載し、リンクを戻す :D
- プロジェクトをスター付きにし、共有する 🚀
- PayPal を通じて一回限りの寄付を行うことができます。私はおそらく
ビールワイン 🍷を購入するでしょう。
ありがとう！:heart:
貢献は歓迎されます ♥! ご希望の機能や、ユニットテストをぜひご提供ください。プルリクエストやイシューのシステムをご利用ください。
- Anmol Pratap Singh: メンテナ
- Alexander Sergeev: メンテナ
- DataBoySu: メンテナ
- okcoder1: メンテナ
- Aravind V. Nair: メンテナ
- Prabhat Singh: コードタイムライングラフの実装 #18
- Hedy Li: プルリクエスト #34 および #23 への貢献
- Pedro Torres: プルリクエスト #29 への貢献
- Aaron Meese: プルリクエスト #45 への貢献
- Arnav Jindal: プルリクエスト #48 への貢献
- Daniel Rowe: プルリクエスト #57 への貢献
- Ss5h: 翻訳用自然文の記述をサポート #136
Special mention for those who are currently making their profile readme more awesome 😄 🎉
- そしてあなたも！もし今現在使用しているがリストに載っていない場合は、Special Mention の issue を送って教えてください！:blush:
リストに加えてくれることを喜んでいます。
❤️ と Python 🐍 で作成されました。
