Рубрики
Без рубрики

Changelog CI (Commit и / или комментарий автоматически сгенерированный изменяемый файл для PR, используя действия)

Мой рабочий процесс, который я создал свой первый ключ GitHub с открытым исходным кодом, называемый Changelog CI. Это … с меченым с помощью Actionhackathon, Github, Opensource, Python.

Мой рабочий процесс

Я создал свой первый открытый исходный Github Action под названием CHANGELOG CI Отказ Это действие GitHub, которое генерирует изменяемый файл, добавляет его к Changelog.md Файл и совершает и/или Комментарии Это до выпуска потянутого запроса.

Живой пример: Changelog Ci’s ChangeLog

Категория подачи:

Сопровождающий обязан

YAML-файл или ссылка на код

Вот ссылки для Changelog CI.

Репозиторий GitHub:

Saadmk11/changelog-ci

CHANGELOG CI – это действие GitHub, которое генерирует изменяемый файл, Затем изменяемый файл предан и/или прокомментировал запрос на выпуск.

Что такое CHANGELOG CI?

CHANGELOG CI – это действие GitHub, которое генерирует изменяемый файл, то изменяемый файл добавлен к Changelog.md файл и совершил и/или Прокомментировал на запрос на выпуск.

Как это работает:

CHANGELOG CI использует Python и Github API Сначала генерируйте изменяемый файл для хранилища, он пытается получить Последний релиз из репозитория (если есть) Затем он проверяет все запросы на тягу, объединенные после последнего выпуска с помощью API GitHUB. После этого он анализирует данные и генерирует Changelog Отказ Наконец, он пишет сгенерированный изменяемый файл в начале Changelog.md (или предоставленное пользователем файл имени файла). В дополнение к этому, если пользователь предоставляет файл config (json), changeelog ci анализирует пользовательский файл конфигурации и отображает changeLog в соответствии с конфигурацией пользователей. Тогда изменения являются совершил и/или Прокомментировал на запрос на выпуск.

Использование:

Использовать это действие Тянуть Запрос …

Рынок:

https://github.com/marketplace/actions/changelog-ci

Дополнительные ресурсы/информация

CHANGELOG CI Является ли новое действие с открытым исходным кодом, поскольку теперь мои проекты с открытым исходным кодом используют его.

Например, Django-NewsFeed и банковская система использует это. Этот вывод был создан с использованием Changelog-Ci CHANGELOG.md

ShangeLog Ci сам использует это действие для генерации Changelog Отказ

Как это работает:

CHANGELOG CI использует Python и Github API генерировать изменение изменений для хранилища. Во-первых, он пытается получить Последний релиз из репозитория (если есть). Затем он проверяет все запросы на тягу, объединенные после последнего выпуска с помощью API GitHUB. После этого он анализирует данные и генерирует Changelog Отказ Наконец, он пишет сгенерированный изменяемый файл в начале Changelog.md (или предоставленное пользователем файл имени файла). В дополнение к этому, если пользователь предоставляет файл config (json), changeelog ci анализирует пользовательский файл конфигурации и отображает changeLog в соответствии с конфигурацией пользователей. Тогда изменения являются совершил и/или Прокомментировал на запрос на выпуск.

Использование:

Использовать это действие Тянуть Заказать название должен соответствовать с по умолчанию Regex или предоставленное пользователем Regex из файла конфигурации.

По умолчанию заголовок Regex: ^ (? I) Выпуск (Название должно начинаться со словом «Release» (нечувствителен к регистру)))

Номер версии по умолчанию Regex: Это следует СЕМВЕР (Семантическая версификация) шаблон. например 1.0.0 , 1.0 , v1.0.1 и Т. Д.

Для получения более подробной информации о шаблоне семантической версии Перейти к этой ссылке: https://regex101.com/r/Ly7O1x/3/

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

Пример рабочего процесса с использованием Changelog CI

name: Changelog CI

# Controls when the action will run. Triggers the workflow on pull request
on:
  pull_request:
    types: [opened, reopened]

jobs:
  build:
    runs-on: ubuntu-latest

    steps:
      # Checks-out your repository
      - uses: actions/checkout@v2

      - name: Run Changelog CI
        uses: saadmk11/changelog-ci@v0.5.0
        with:
          # Optional, you can provide any name for your changelog file.
          # defaults to ``CHANGELOG.md`` if not provided.
          changelog_filename: CHANGELOG.md
          # Optional, only required when you want more customization
          config_file: changelog-ci-config.json
        env:
          # Optional, Only required for ``private`` repositories
          # and required if the changelog comment 
          # option is turned on through the config file
          GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}

Changelog Ci Badge: Добавьте это в свой README, чтобы отобразить значок:

![Changelog CI Status](https://github.com///workflows/Changelog%20CI/badge.svg)

Пример вывода изменений с использованием файла конфигурации:

Узнайте больше о файле конфигурации для ChangeLog CI от Readme.md.md

Версия: 0.0.2

Исправление ошибок

  • # 53 : Продолжайте обновлять readme
  • # 54 : Опять обновление одного файла README:(

Новые возможности

  • # 68 : Обновление Readme.md.

Обновления документации

  • # 66 : Документы обновления

Версия: 0.0.1

Исправление ошибок

  • # 53 : Продолжайте обновлять readme
  • # 54 : Опять обновление одного файла README:(

Обновления документации

  • # 66 : Документы обновления

Пример вывода изменений без использования файла конфигурации:

Версия: 0.0.2

  • # 53 : Продолжайте обновлять readme
  • # 54 : Опять обновление одного файла README:(
  • # 55 : Readme обновление

Версия: 0.0.1

  • # 43 : Это похоже на тестирование никогда не заканчивается:(
  • # 35 : Тестирование снова и снова
  • # 44 : Это опять еще один тест, устая
  • # 37 : Это опять еще один тест

Changelog CI в действии (комментарий и коммит)

Вывод

Я думаю, что это будет очень полезно для сопровождающих открытых источников. Если кто-то заинтересован, пожалуйста, попробуйте CHANGELOG CI Выйти и оставить отзыв:)

Оригинал: “https://dev.to/saadmk11/github-actions-changelog-ci-4ojh”

Читайте ещё по теме: