Персонализируйте и сделайте свой профиль GitHub динамичным

В количестве Еженедельник JavaScript за прошлую неделюмы находим, в частности, Динамический профиль GitHub с Bun и Typescript где автор объясняет, как он персонализирует и, прежде всего, делает свой профиль на GitHub динамичным. Эта статья напомнила мне, что у меня в черновиках был пост на ту же тему, и поскольку я использую немного другой подход, это возможность закончить его и немного поговорить. сантехника за кулисами.

Настроить профиль GitHub легко.просто создайте репозиторий с именем, похожим на ваше имя пользователя username/username и добавить файл README.md в корне, чтобы его содержимое было включено в профиль. Для меня README.md из https://github.com/dpobel/dpobel находится на странице профиля, которая дает что-то вроде:

Поэтому остается регулярно обновлять этот файл, чтобы в профиле отображалась актуальная информация. В моем случае, помимо краткого вступления, я хочу отображать последние публикации, опубликованные на этом сайте, а также несколько избранных публикаций. Как и автор цитированной выше статьи, я мог бы поместить в репозиторий некоторый код username/username и регулярно запускать скрипт с помощью Действия GitHub (или другие) для обновления README.md из RSS-каналов. Однако я вижу как минимум два недостатка в этом подходе (который все же обладает определенной простотой):

1. необходимо обязательно добавить код в репозиторий username/username что требует небольшого обслуживания
2. действие обновления должно выполняться регулярно независимо от активности на этом сайте, учитывая взлеты и падения сообщений здесь, это, вероятно, не очень эффективное использование ресурсов 🙂

Более того, когда я хотел реализовать эту настройку, у меня была аналогичная потребность, которая заключалась в сохранении https://dpobel.github.io/ в зависимости от активности здесь. И здесь я мог бы поместить небольшой код в соответствующий репозиторий для создания страницы, что вызвало бы те же недостатки.

Короче говоря, пока искал альтернативу, я обнаружил, что GitHub предоставляет REST API, который позволяет запускать рабочий процесс Действия GitHub тем самым предлагая способ устранения второго недостатка. После этого я понял, что могу легко добавить в конструкцию этого сайта генерацию README.md под залог username/username и HTML-страница, предназначенная для https://dpobel.github.io/ а затем в конце развертывания этого было достаточно, чтобы вызвать рабочий процесс Действия GitHub по API для каждого из этих репозиториев кто может быть доволен скачать файл и комитент. Таким образом, большая часть логики сосредоточена на создании этого сайта, который управляет внешними обновлениями.

Подведу итог рецепта моего волшебного зелья 🧙:

1. создать README.md на своем сайте, чтобы он был развернут вместе с остальными (или сделайте его доступным по известному URL-адресу, если вы используете динамическую CMS)
2. Настройте рабочий процесс Действия GitHub для загрузки этого файла и комитент на депозите username/username
3. при событии, например во время развертывания, или если вы используете CMS для публикации нового контента, выполните вызов API, чтобы инициировать это. рабочий процесс.

И вуаля случается волшебство ✨️ Тот же механизм работает и при обновлении https://dpobel.github.io/. Если я верю история совершает от депозита по профилю и др. из страницымагия работает уже чуть больше 3-х лет практически без какого-либо ручного вмешательства на этих депозитах.