Как работать с выпусками документа уценки на GitHub

Question

У нас есть документ по соглашениям о метаданных, разработанный группой для определенной группы моделей океана, который хранится в виде уценки github по адресу https://github.com/ugrid-conventions/ugrid-conventions и теперь мы хотели бы "выпустить" текущую версию. этого документа по уценке в версии 1.0 (и продолжить разработку соглашений для будущих выпусков).

Я понимаю, что у github есть выпуски, но нам не нужен zip-файл, содержащий документ уценки, мы просто хотим документ уценки версии 1.0. Мы также хотели бы сохранить изменения, чтобы люди могли видеть, что изменилось по сравнению с предыдущими версиями, по мере нашего продвижения вперед.

Должны ли мы просто скопировать существующий документ ugrid-conventions.md в ugrid-conventions_v1.0.0.mdили есть лучший способ?

Answer 1

Я бы предложил создать тег для каждого выпуска. Теги автоматически попадают в список на странице релизов GitHub (на самом деле, каждый релиз связан с тегом), и вы также можете напрямую ссылаться на файлы внутри тегового коммита. Например, если вы создали тег с именем v1.0Вы можете отправить людей на https://github.com/ugrid-conventions/ugrid-conventions/blob/v1.0/ugrid-conventions.md чтобы увидеть версию 1.0 этого файла.