Действие user-statistician GitHub, упомянутое в Awesome-README

Действие user-statistician GitHub Action генерирует SVG с подробной сводкой вашей активности на GitHub, которую вы можете включить в README вашего профиля GitHub (или даже на вашем личном сайте), включая различную статистику о ваших репозиториях (например, звезды, форки, репозиторий с наибольшим количеством звезд, репозиторий с наибольшим количеством форков и т.д.), различную статистику вклада (например, коммиты, проблемы, pull request, pull request reviews и т.д.), а также круговую диаграмму распределения языков в ваших публичных репозиториях. В программе также предусмотрена международная поддержка с 16 локалями на выбор. Предполагаемый сценарий использования — запуск по расписанию через рабочий процесс GitHub в вашем профильном репозитории GitHub. Он реализован на Python в виде Container Action и использует GitHub CLI для запроса GitHub GraphQL API для сбора данных.

Недавно GitHub-экшен user-statistician был добавлен в раздел инструментов Awesome README, который представляет собой список Awesome List, содержащий коллекцию примеров Awesome README из проектов с открытым исходным кодом, а также инструменты для создания Awesome README. Список Awesome README — это отличное место, если вы ищете идеи, как улучшить README ваших проектов с открытым исходным кодом. Список Awesome README охватывает README в целом, но раздел инструментов включает несколько инструментов, ориентированных на профильные README, в дополнение ко многим инструментам для проектных README в целом. User-statistician GitHub Action находится в разделе инструментов.

Функциональность: User-statistician очень легко настраивается. Вот несколько способов, которыми вы можете его настроить.

  • Международная поддержка с 16 естественными языками на выбор: Bahasa Indonesia, Bengali, English, French, German, Hindi, Italian, Japanese, Korean, Lithuanian, Polish, Portuguese, Russian, Spanish, Turkish, Ukrainian.
  • Несколько цветовых тем, также можно задать пользовательские цвета.
  • Вы можете опустить статистику, которую не хотите отображать.
  • Вы можете изменить порядок разделов SVG по сравнению с порядком по умолчанию.
  • Вы можете изменить порядок статистики внутри раздела.
  • Вы можете опустить целые разделы, если хотите (например, возможно, вам нужна только статистика хранилища, или статистика хранилища и диаграмма распределения языков и т.д.).
  • Вы можете указать, сколько языков включить в круговую диаграмму распределения языков, или позволить действию самому выбрать количество языков, что является поведением по умолчанию. Если вы разрешите действию выбирать, оно включит все языки, которые по отдельности составляют не менее 1 процента от общего числа, а оставшиеся языки с низким процентом сгруппирует как «Другие».
  • Круговая диаграмма распределения языков включает необязательный анимированный поворот, который вы можете включить.
  • Вы можете включить хранилище по своему выбору.
  • … и несколько других поддерживаемых настроек.

Содержание: Остальная часть этой заметки организована следующим образом:

  • Как настроить, включая пример рабочего процесса и пример SVG, список рабочих процессов быстрого запуска и подробные шаги.
  • Узнать больше.
  • Где вы можете меня найти.

Как настроить

Давайте начнем с примера. Вот пример рабочего процесса из репозитория моего профиля. В этом рабочем процессе используется большинство настроек по умолчанию. Однако я использовал вход colors, чтобы изменить цветовую тему на dark. И я использовал вход featured-repository, чтобы включить хранилище в верхнюю часть SVG. Перед использованием этого конкретного рабочего процесса вам следует изменить его на один из ваших собственных репозиториев. Этот рабочий процесс запускается ежедневно в 3 часа утра (см. cron), а также запускается вручную через событие workflow_dispatch. Ему требуется GITHUB_TOKEN в качестве переменной окружения, чтобы запрашивать GitHub GraphQL API. Разрешений по умолчанию, которые автоматически предоставляются GITHUB_TOKEN, достаточно.

name: user-statistician

on:
  schedule:
    - cron: '0 3 * * *'
  workflow_dispatch:

jobs:
  stats:
    runs-on: ubuntu-latest

    steps:
    - uses: actions/checkout@v2

    - name: Generate the user stats image for GitHub profile
      uses: cicirello/user-statistician@v1
      with:
        colors: dark
        featured-repository: Chips-n-Salsa
      env:
        GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
Вход в полноэкранный режим Выйти из полноэкранного режима

Приведенный выше рабочий процесс, запущенный в репозитории, принадлежащем мне, дал следующие результаты (на день публикации этого DEV-поста):

Быстрые рабочие процессы

Репозиторий GitHub включает каталог Quickstart Workflows для ожидаемых общих желаемых опций конфигурации. К ним относятся:

  • all-defaults.yml: Запускает действие по ежедневному расписанию, используя все настройки по умолчанию, то есть светлую цветовую тему.
  • dark.yml: Запускает действие по ежедневному расписанию с темной цветовой темой, но в остальном использует все настройки по умолчанию.
  • dark-dimmed.yml: Запускает действие по ежедневному расписанию с темной цветовой темой, но в остальном использует все настройки по умолчанию.
  • contributions.yml: Запускает действие по ежедневному расписанию, генерируя только статистику вкладов (скрывая другие разделы), с темной цветовой темой.
  • repositories.yml: Запускает действие по ежедневному расписанию, генерируя только статистику репозиториев (скрывая другие разделы), с темной темой.
  • languages.yml: Запускает действие по ежедневному расписанию, генерируя только диаграмму распределения языков (скрывая другие разделы), с темной темой.
  • multiple-stats-cards.yml: Запускает действие по ежедневному расписанию, генерируя три отдельных SVG, один для статистики вкладов, один для статистики репозиториев и один для диаграммы распределения языков. Для всех трех используется темная тема. Обратите внимание, что если вы используете этот вариант, у вас будет три изображения для вставки в README вашего профиля.

Пошаговая инструкция.

Ниже приведены шаги по использованию одного из рабочих процессов быстрого запуска.

Шаг 0: Создайте репозиторий профиля

Ваш профиль GitHub — это специальный репозиторий GitHub. Начните с создания репозитория с тем же именем, что и ваше имя пользователя. Инициализируйте его с помощью файла README.md.

Шаг 1: Каталог рабочих процессов

В этом репозитории создайте каталог .github/workflows. Каталог .github — это специальный каталог, в котором вы можете настраивать различные функции GitHub, такие как рабочие процессы CI/CD, dependabot и т.д. А каталог .github/workflows — это место, где GitHub ожидает файлы рабочих процессов GitHub Actions.

Шаг 2: Выберите рабочий процесс быстрого запуска

Выберите один из рабочих процессов быстрого запуска, например, тот, который наиболее близок к вашей желаемой конфигурации. Поместите его в каталог .github/workflows, зафиксируйте его и запустите. Если вы не изменили имя файла, то он будет запущен, когда вы выложите его в репозиторий, так как он был настроен на запуск при выкладывании с таким именем файла (при условии, что ваша ветка называется main или master). Если вы изменили имя файла, отредактируйте атрибут paths события push, указав новое имя файла рабочего процесса.

Рабочий процесс настроен на ежедневный запуск по расписанию. Вы можете изменить расписание по своему усмотрению. Смотрите конфигурацию cron в верхней части рабочего процесса.

Вы также можете запустить его вручную, поскольку он также настроен на событие workflow_dispatch. Для этого перейдите на вкладку Действия для репозитория вашего профиля. Выберите рабочий процесс из списка рабочих процессов слева. Вы заметите, что там указано: «У этого рабочего процесса есть триггер события workflow_dispatch«. Справа от этого нажмите кнопку «Запустить рабочий процесс», чтобы запустить рабочий процесс вручную.

Шаг 3: Добавьте ссылку на изображение в README

Вы найдете SVG в каталоге images (который создается действием, если он еще не существует). Если вам не нравится имя директории или даже имя SVG-файла, действие содержит входные данные для его изменения.

Добавьте ссылку на него в README.md в хранилище вашего профиля. Если вы использовали один из этих рабочих процессов как есть, без использования входов для изменения имени файла изображения, то вы можете добавить изображение в свой профиль с помощью следующего Markdown:

![My user statistics](images/userstats.svg)
Войти в полноэкранный режим Выход из полноэкранного режима

Шаг 4: Настройте

Теперь, когда вы опробовали один из рабочих процессов быстрого запуска, загляните в документацию, чтобы узнать о дальнейшей настройке.

Узнайте больше

Чтобы узнать больше, например, документацию по дальнейшей настройке, загляните в репозиторий GitHub и пометьте его звездочкой, если он вам понравился.

cicirello / user-statistician

Генерирование SVG статистики GitHub для вашего профиля GitHub Profile README в GitHub Actions

user-statistician

Посмотрите все наши действия на GitHub: https://actions.cicirello.org/.

О user-statistician

Действия GitHub
Статус сборки
Информация об источнике
Вкладчики
Поддержка

GitHubAction cicirello/user-statistician генерирует подробную визуальную сводку вашей активности на GitHub в виде SVG-изображения, пригодного для отображения в вашем профиле GitHub READMEAlthough предполагаемый сценарий использования — это создание SVG-изображения для вашего профиля GitHub READMEy вы также можете ссылаться на это изображение с личного сайта или из любого другого места, где вы хотели бы поделиться сводкой вашей активности на GitHub. SVG, которое генерирует данное действие, включает статистику по репозиториям, которыми вы владеете, статистику вашего вклада (например, коммиты, проблемы, PR и т.д.), а также распределение языков в публичных репозиториях, которыми вы владеете Изображение статистики пользователя может быть настроено, включая цвета, например, с помощью одной из встроенных тем или вашего собственного набора…

Посмотреть на GitHub

У меня также есть сайт с более подробной информацией об этом и других GitHub Actions, которые я поддерживаю.

Винсент Чичирелло — Действия GitHub с открытым исходным кодом для автоматизации рабочего процесса

Информация о нескольких открытых GitHub Actions для автоматизации рабочих процессов, которые мы разработали для автоматизации частей конвейера CI/CD и других повторяющихся задач. Среди представленных GitHub Actions: jacoco-badge-generator, generate-sitemap, user-statistician и javadoc-cleanup.

actions.cicirello.org

Где меня можно найти

В Интернете:

Винсент А. Цицирелло — профессор компьютерных наук

Винсент А. Чичирелло — профессор компьютерных наук в Стоктонском университете — исследователь в области искусственного интеллекта, эволюционных вычислений, роевого интеллекта и вычислительного интеллекта, доктор философии по робототехнике в Университете Карнеги-Меллон. Он является старшим членом ACM, старшим членом IEEE, пожизненным членом AAAI, заслуженным членом EAI и членом SIAM.

cicirello.org

Следите за мной на DEV:

Винсент А. Чичирелло

Исследователь и преподаватель в области А.И., алгоритмов, эволюционных вычислений, машинного обучения и роевого интеллекта.

Следите за мной на GitHub:

cicirello / cicirello

Мой профиль на GitHub

Vincent A Cicirello

Сайты, где вы можете найти меня или мои работы
Веб и социальные сети
Разработка программного обеспечения
Публикации

Если вы хотите сгенерировать эквивалент вышеуказанного для своего профиля на GitHub, ознакомьтесь с действием cicirello/user-statisticianGitHub.

Посмотреть на GitHub

Оцените статью
devanswers.ru
Добавить комментарий