tutorial - github tag

¿La generación de registros de cambios de Github?

Question

¿Hay una manera de generar automáticamente un registro de cambios a partir de problemas de Github?

Lo ideal es poder señalar un hito cerrado y generar una lista de texto sin formato de los temas cerrados con sus títulos o, mejor aún, una lista con marcas para los enlaces a los problemas y el título de los mismos.

Answer 1

A ver si la siguiente herramienta hará por ti github-changes .

Divulgación: Soy el autor de la herramienta.

Answer 2

Ayudé a crear un complemento de jQuery para esto recientemente, que usa problemas de GitHub para comunicar las actualizaciones de la aplicación directamente al usuario. El repositorio se puede encontrar aquí https://github.com/uberVU/github-changelog

El uso es bastante simple:

$(function() {
  var $demoChangelog = $(''.demo-changelog'');

  //call the plugin on a dom none
  $demoChangelog.changelog({
    //give it a repo to monitor
    githubRepo: ''uberVU/github-changelog-playground'',
  });

  //manually check for new closed issues
  $(''.demo-button'').on(''click'', function(e) {
    e.stopPropagation();
    $demoChangelog.changelog(''checkForUpdates'');
  });
});

Answer 3

Creamos un proyecto de código abierto para generar un registro de cambios a partir de la lista de problemas de github cerrados desde una fecha determinada. Está disponible aquí: https://github.com/piwik/github-changelog-generator

Answer 4

Esto no es específicamente para Github, pero a través de Git puede ejecutar el registro a través de una impresión bonita para generar una página html de estilo de cambios.

Desde https://coderwall.com/p/5cv5lg

git log v2.1.0...v2.1.1 --pretty=format:''<li> <a href="http://github.com/jerel/<project>/commit/%H">view commit &bull;</a> %s</li> '' --reverse | grep "#changelog"

Answer 5

No directamente a través de GitHub: ese sería un tipo de gancho que podría establecer, y que se basaría en la convención de nomenclatura o convención de comentarios que su proyecto podría seguir.
Incluso usar el título de los problemas no siempre es una forma segura de generar un registro de cambios significativo, a menos que revise y edite, si es necesario, el título de cada uno de los temas de su proyecto.

En otras palabras, depende mucho de cómo gestione su proyecto y no se generaliza fácilmente a todos los repositorios de GitHub.
Lo dije en una pregunta muy similar: "¿ Publicar un lanzamiento de proyecto (paquetes binarios / fuente) en Github? ".

Answer 6

Puede usar la API de GitHub para obtener una lista de problemas asociados con un hito determinado. Por ejemplo:

curl https://api.github.com/repos/<user>/<project>/issues/?milestone/=1/&state/=closed

Reemplace <user> y <project> con el nombre de usuario y el proyecto y esto devolverá una lista json de todas las cuestiones cerradas del hito con el id 1 . Luego puede, por ejemplo, usar un script para extraer la información que le interesa. Aquí hay un ejemplo de Python que imprime la lista de problemas como texto reestructurado:

import json

with open("issues.json") as of:
    data = json.load(of)

for issue in data:
    t = issue[''title'']
    n = issue[''number'']
    url = issue[''html_url'']
    print "* %s [`Issue %s <%s>`_]" % (t, n, url)

Answer 7

Puedes intentar usar Github-Changelog-Generator . (Soy autor de este proyecto)

Genera el registro de cambios de las etiquetas y las solicitudes de extracción combinadas. Este script también tiene soporte para problemas de GitHub.

Este registro de cambios fue generado por este script. CHANGELOG.md

Ejemplo:

Registro de cambios

1.2.5 (2015-01-15)

Registro de cambios completo

Mejoras implementadas:

• Use el hito para especificar en qué versión se corrigió el error #22

Errores arreglados:

• Error al intentar generar registro para repo sin etiquetas #32

Solicitudes de extracción combinadas:

• La clase PrettyPrint se incluye en minúsculas ''pp'' #43 ( schwing )

• soporte github empresarial a través de las opciones de línea de comandos #42 ( glenlovett )