Ссылка на номер проблемы в GitHub в сообщении о фиксации
Возможно ли автоматически иметь ссылку на номер выпуска GitHub в сообщении git commit
?
Просто включите #xxx
в сообщение фиксации, чтобы ссылаться на проблему, не закрывая ее.
С новым GitHub выдает 2.0 вы можете использовать эти синонимы в ссылка на выдать и закрыть его (в сообщении о фиксации):
-
fix #xxx
-
fixes #xxx
-
fixed #xxx
-
close #xxx
-
closes #xxx
-
closed #xxx
-
resolve #xxx
-
resolves #xxx
-
resolved #xxx
Вы также можете заменить #xxx
на gh-xxx
.
Реферирование и проблемы закрытия в репозиториях также работают:
fixes user/repo#xxx
Просмотрите документацию, доступную в разделе справки.
Если вы хотите установить связь с проблемой GitHub и закрыть проблему, вы можете указать следующие строки в сообщении Git commit:
Closes #1.
Closes GH-1.
Closes gh-1.
(Любой из трех будет работать.) Обратите внимание, что это свяжется с проблемой и закроет ее. Вы можете узнать больше в этом сообщении в блоге (начните просмотр встроенного видео примерно в 1:40).
Я не уверен, что подобный синтаксис будет просто ссылаться на проблему, не закрывая ее.
Вы также можете перекрестно ссылаться на репозиции:
githubuser/repository#xxx
xxx - номер проблемы
github добавляет ссылку на фиксацию, если она содержит #issuenbr (это случайно обнаружено).
у них хорошая запись о новых проблемах 2.0 в их блоге https://github.com/blog/831-issues-2-0-the-next-generation
синонимы включают
- исправления #xxx
- исправлено #xxx
- fix #xxx
- закрывает #xxx
- закрыть #xxx
- закрыто #xxx
используя любое из ключевых слов в сообщении фиксации, вы сделаете фиксацию либо упомянутой, либо закроете проблему.
Как дополнение к другим ответам: если вы даже не хотите писать сообщение фиксации с номером проблемы и использовать для разработки Eclipse, то вы можете установить eGit и Mylyn плагины, а также разъем GitHub для Mylyn. Eclipse может автоматически отслеживать, на какую проблему вы работаете, и автоматически заполнять сообщение фиксации, включая номер проблемы, как показано во всех других ответах.
Подробнее об этой установке см. http://wiki.eclipse.org/EGit/GitHub/UserGuide
Одним из моих первых проектов в качестве программиста был драгоценный камень, называемый stagecoach, который (среди прочего) позволял автоматическое добавление github номер выпуска для каждого сообщения фиксации на ветке, которая является частью вопроса, на который на самом деле не был дан ответ.
По существу при создании ветки вы используете пользовательскую команду (что-то вроде stagecoach -b <branch_name> -g <issue_number>
), а номер проблемы будет назначен этой ветке в yml файле. Затем был фиксация фиксации, которая автоматически добавила номер проблемы в сообщение фиксации.
Я бы не рекомендовал его для использования на производстве, как в то время, когда я только программировал в течение нескольких месяцев, и я больше не поддерживаю его, но это может быть интересно кому-то.
Чтобы связать номер проблемы с сообщением о фиксации, вы должны добавить:
#issue_number
в сообщении git commit.
Пример Commit Message из Udacity git Руководство по стилю сообщений
feat: Summarize changes in around 50 characters or less
More detailed explanatory text, if necessary. Wrap it to about 72
characters or so. In some contexts, the first line is treated as the
subject of the commit and the rest of the text as the body. The
blank line separating the summary from the body is critical (unless
you omit the body entirely); various tools like `log`, `shortlog`
and `rebase` can get confused if you run the two together.
Explain the problem that this commit is solving. Focus on why you
are making this change as opposed to how (the code explains that).
Are there side effects or other unintuitive consequenses of this
change? Here the place to explain them.
Further paragraphs come after blank lines.
- Bullet points are okay, too
- Typically a hyphen or asterisk is used for the bullet, preceded
by a single space, with blank lines in between, but conventions
vary here
If you use an issue tracker, put references to them at the bottom,
like this:
Resolves: #123
See also: #456, #789
Вы также можете ссылаться на репозитории:
githubuser/repository#issue_number
Другие вопросы по меткам git git-commit github или Задайте вопрос