Skip to content

Latest commit

 

History

History
477 lines (306 loc) · 25.1 KB

File metadata and controls

477 lines (306 loc) · 25.1 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!

Метрики Dev в README с добавленными флагами функций 🎌

Project Preview

Project Preview

📌✨Awesome README Stats


Star Badge

Вы ранний 🐤 или ночной 🦉?
Когда вы наиболее продуктивны в течение дня?
Какие языки программирования вы используете?
Посмотрим это в вашем README профиля!

Report Bug Request Feature

Подготовительные действия

  1. Вам нужно обновить файл markdown (.md) с двумя комментариями. Вы можете обратиться здесь для обновления.
  2. Вам понадобится API-ключ WakaTime. Вы можете получить его в настройках аккаунта WakaTime
    • Вы можете обратиться здесь, если вы новичок в WakaTime.
  3. Вам понадобится токен GitHub API с областью repo и user с здесь, если вы запускаете действие для получения метрик коммитов.
    • Вы можете использовать этот пример, чтобы разобраться.

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. Вам нужно сохранить ключ API WakaTime и токен API GitHub в секреты репозитория. Вы можете найти их в настройках вашего репозитория.
    Убедитесь, что сохранили их следующим образом:
    • Ключ API WakaTime как WAKATIME_API_KEY=<your wakatime API Key>
    • Личный токен доступа GitHub (PAT) как GH_TOKEN=<your github access token>
  2. Вы можете включать и отключать флаги функций в зависимости от ваших требований.

Эта GitHub Action может быть настроена для запуска в любое время, которое вы хотите, с использованием cron. Посмотрите Crontab.guru и этот сайт, чтобы сгенерировать выражения cron.

Обновите ваш Readme

Добавьте комментарий в ваш README.md следующим образом:

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

waka может быть заменен на любую строку, указанную в флаге SECTION_NAME согласно доступным флагам.

Эти строки будут нашими точками входа для метрик разработчика.

Новый пользователь WakaTime

WakaTime дает вам представление о времени, которое вы действительно потратили на программирование. Это помогает повысить вашу продуктивность и конкурентоспособность.

Профиль репозитория

Вам понадобится получить GitHub Access Token с областью repo и user и сохранить его в секреты репозитория 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. Теперь подождите одну или две минуты, и вы увидите ваши изменения.

Дополнительно

Если вы хотите добавить дополнительную информацию в свои статистики, вы можете добавить несколько 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, чтобы скрыть детали вашей ОС.

💻 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.

🐱 Мой GitHub Данные

🏆 433 Вкладки в году 2020

📦 Использовано 292,3 kB в хранилище GitHub

💼 Выбрано для найма

📜 25 Публичных репозиториев

🔑 15 Приватных репозиториев, которыми владеют

Флаг SHOW_LOC_CHART может быть установлен в False, чтобы скрыть количество строк кода, написанных в разных кварталах разных лет.

Флаг IGNORED_REPOS может быть установлен в "waka-readme-stats, my-first-repo" (просто пример), чтобы игнорировать некоторые репозитории, которые вы не хотите учитывать.

Флаг SYMBOL_VERSION может быть установлен для символа прогресс-бара (по умолчанию: 1).

Версия Блок выполнено Блок пустой
1
2
3

Флаг DEBUG_LOGGING может быть установлен для увеличения подробности вывода GitHub Action, по умолчанию равен внутреннему свойству отладки исполнителя

Таймлайн

График не найден

💖 Поддержите проект

Я делюсь открытым исходным кодом почти всем, что могу, и стараюсь отвечать всем, кто нуждается в помощи при использовании этих проектов. Очевидно, это занимает время. Вы можете использовать этот сервис бесплатно.

Однако, если вы используете этот проект и довольны им или просто хотите поблагодарить меня за продолжение создания подобных проектов, есть несколько способов, которыми вы можете это сделать :-

  • Указывайте правильные ссылки, когда используете этот action в вашем readme, возвращаясь к нему :D
  • Добавьте звёздочку и делитесь проектом 🚀
  • paypal.me/aapreneur - Вы можете сделать одноразовые пожертвования через PayPal. Я, вероятно, куплю немного пива вина 🍷.

Спасибо! ❤️

Вклад

Вклад приветствуется ♥! Пожалуйста, делитесь любыми функциями и добавляйте тесты! Используйте системы pull request и issue для внесения вклада.

Выбранные участники

  1. Anmol Pratap Singh: Maintainer
  2. Alexander Sergeev: Maintainer
  3. DataBoySu: Maintainer
  4. okcoder1: Maintainer
  5. Aravind V. Nair: Maintainer
  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 issue! 😊
    Мы будем рады добавить вас в список.

Сделано с ❤️ и Python 🐍.

Вдохновлено

Awesome Pinned Gists
athul/waka-readme

Этот проект нуждается в звёздочке ⭐ от вас ♥

Количество звёзд со временем

Stargazers over time