Redactar un registro de cambios a partir de confirmaciones
Changelog draft lee las confirmaciones del primer padre entre dos puntos, las agrupa, sugiere una siguiente versión y te permite copiar Markdown. La nota dice que es sólo un borrador. No se etiqueta, libera ni envía nada. Revisas los mensajes antes de compartirlos.
Funciona en GitTree Gratis: todas las funciones locales de Git, sin necesidad de cuenta.
En esta página
Antes de empezar
- El borrador del registro de cambios es parte del plan gratuito. Ambos puntos finales ya deben estar confirmados. El cuadro de diálogo dice Choose both committed endpoints hasta que lo estén.
- Los mensajes que desee agrupar deben seguir a Conventional Commits (
feat:,fix:,feat!:). Los mensajes simples se cuentan para su revisión. No son categorías inventadas.
donde encontrarlo
- Menú de confirmación o menú de etiqueta: Changelog draft.
Alt+Lo la paleta de comandos.
| acción | macOS | Windows y Linux |
|---|---|---|
| Changelog draft | ⌥L | Alt+L |
| La paleta de comandos | ⌘⇧P | Ctrl+Shift+P |
Pasos
Abrir borrador del registro de cambios
Seleccione la confirmación que debe finalizar el rango o la etiqueta para la que está escribiendo notas y elija Changelog draft. También puedes presionar
Alt+L. El título es Changelog draft. La nota dice Draft only. Review commit messages before sharing. Nothing is published.
El borrador del registro de cambios se encuentra en este menú y en el menú de una etiqueta. Todavía muestra el menú de confirmación.GitTree interfaz con un repositorio de demostración. Establecer el rango
From (excluded) es la confirmación o etiqueta que ya liberaste. To (included) es el nuevo consejo. La línea de alcance dice que el borrador utiliza la historia del primer padre. Las confirmaciones que llegaron solo a través de una combinación están representadas por la confirmación de combinación, no enumeradas una por una.
Generar el borrador
Presione Generate draft. Stop solicita que finalice la lectura del historial. El borrador aparece debajo de Editable Markdown draft, con Suggested version cuando se puede proponer una versión y Baseline tag cuando una etiqueta de versión apunta al punto final excluido. Copy Markdown lo copia. Markdown copied confirma la copia.
Edita y luego decide adónde va.
Edite el Markdown en el cuadro. Replace draft with proposal devuelve el texto generado después de editarlo. Si cambia los puntos finales, GitTree dice que los puntos finales cambiaron y su borrador editado se conserva. Insert draft into release notes se ofrece cuando escribe notas para una versión. Al cerrar después de las ediciones se pregunta Discard edited draft? Copie primero si necesita las palabras.
Resultado esperado
Tienes Markdown en el portapapeles o en el campo de notas de la versión. No se creó ninguna etiqueta ni se publicó ningún lanzamiento. Lea los grupos antes de pegarlos en una versión. Los mensajes simples, las reversiones y las fusiones se muestran para que pueda reescribirlos.
Cómo se agrupan las confirmaciones
| grupo | ¿Qué se coloca allí? |
|---|---|
| Cambios importantes | Confirmaciones marcadas como de última hora, incluido un pie de página ! o BREAKING CHANGE |
| Características | hazaña confirmada |
| Correcciones | arreglar confirmaciones |
| Rendimiento | commits de rendimiento |
| Otro | Tipos reconocidos que no son ninguno de los anteriores y mensajes que aún necesitan una revisión |
La línea de recuentos es Needs review, con mensajes simples, revertidos, fusionados y mensajes no decodificables. Esas cifras son la razón por la que se puede retener una versión. No commits in this range; no release is proposed significa que los puntos finales excluyen cada confirmación.
Cómo se elige la versión sugerida
La sugerencia comienza desde una etiqueta de versión en el punto final excluido. El diálogo explica el motivo: los cambios importantes sugieren una versión principal, o una menor, mientras que la principal es cero. Las características sugieren un menor. Otros Conventional Commits reconocidos sugieren un parche. Puedes ignorar la sugerencia. Choose the next version after review aparece cuando GitTree no elige uno.
git log --first-parent --pretty=format:%s v1.2.0..HEAD
git tag --points-at v1.2.0^{}El mismo rango en una terminal es git log --first-parent desde la confirmación excluida hasta la sugerencia incluida. GitTree no ejecuta git tag por usted. La creación de la etiqueta es etiquetas. La publicación de notas en un host es una acción de autorización independiente. La lección tutorial sobre etiquetas muestra cómo una etiqueta nombra una confirmación.
No se publica nada
Copy Markdown solo copia texto. Insert draft into release notes llena un campo. Ninguno de los dos crea una etiqueta, un comunicado GitHub o un push. Si la copia falla, el cuadro de diálogo dice Could not copy. Select and copy the draft text. Su borrador editado permanece en el cuadro hasta que lo reemplaza o lo descarta.
Si algo sale mal
"Elija ambos puntos finales confirmados".
Desde o Hasta aún no es un commit. Elija dos confirmaciones o una etiqueta que apunte a una confirmación. Un nombre de rama que no se resuelve no se generará.
"Ninguna etiqueta de versión apunta al punto final excluido".
No hay nada que incrementar. Elija la siguiente versión usted mismo o etiquete primero la confirmación excluida y genere nuevamente.
"Las etiquetas de diferentes versiones apuntan al punto final excluido. Elija la versión de referencia".
Más de una etiqueta de versión se encuentra en esa confirmación. Elija la línea de base a la que se refiere. GitTree no adivinará qué etiqueta es la versión del producto.
"La línea de base es una versión preliminar. Elija el canal de lanzamiento y la versión".
Una etiqueta de presentación preliminar no implica el siguiente número estable. Elija el canal y la versión, luego conserve el borrador.
"No se pudo copiar. Seleccione y copie el borrador del texto".
El portapapeles fue rechazado. Seleccione Markdown en el cuadro y cópielo con el acceso directo del sistema. El borrador todavía está ahí.
Preguntas
¿El borrador del registro de cambios crea una versión?
No. La nota dice que no se publica nada. Copia Markdown o lo inserta en las notas de la versión. Te etiquetas y publicas.
¿Qué confirmaciones están incluidas?
Historial del primer padre desde el punto final excluido hasta la sugerencia inclusive. Las confirmaciones de una rama fusionada están representadas por la confirmación de fusión.
¿Por qué no hay ninguna versión sugerida?
El cuadro de diálogo retiene uno cuando falta la etiqueta de referencia, es ambigua o es una versión preliminar, cuando es necesario revisar mensajes simples, revertidos, fusionados o no decodificables, o cuando un componente de la versión no se puede incrementar.
¿Sobrevivirán mis ediciones a un nuevo rango?
Sí hasta que los reemplaces. El cuadro de diálogo dice que su borrador editado se conserva. Reemplazar borrador con propuesta lo sobrescribe con el nuevo texto.
¿Tengo que usar Conventional Commits?
No. Los mensajes sencillos se enumeran en Necesita revisión. Los grupos y la versión sugerida son más específicos cuando los sujetos usan hazaña, corrección y el marcador de cambio importante.