chronicle

crónica

Un generador rápido de registros de cambios que genera cambios a partir de problemas y relaciones públicas de GitHub, organizados por etiquetas.

Cree un registro de cambios desde la última versión de GitHib hasta la etiqueta/compromiso git HEAD actual para el repositorio de git en el directorio actual:

 crónica

Cree un registro de cambios con todos los cambios desde v0.16.0 hasta la etiqueta/compromiso git HEAD actual para el repositorio de git en el directorio actual:

 crónica --since-tag v0.16.0

Cree un registro de cambios entre dos etiquetas específicas para un repositorio en la ruta indicada

 crónica --since-tag v0.16.0 --hasta-tag v0.18.0 ./path/to/git/repo

Cree un registro de cambios y adivine la versión de lanzamiento del conjunto de cambios en el registro de cambios.

 crónica -n

Simplemente adivine la próxima versión según el conjunto de cambios (no cree un registro de cambios)

 crónica próxima versión

Instalación

 curl -sSfL https://raw.githubusercontent.com/anchore/chronicle/main/install.sh | sh -s -- -b /usr/local/bin

...o puede especificar una versión de lanzamiento y un directorio de destino para la instalación:

curl -sSfL https://raw.githubusercontent.com/anchore/chronicle/main/install.sh | sh -s -- -b <DESTINATION_DIR> <RELEASE_VERSION>

Configuración

Rutas de búsqueda de configuración:

• .chronicle.yaml

• .chronicle/config.yaml

• ~/.chronicle.yaml

• <XDG_CONFIG_HOME>/chronicle/config.yaml

Valores predeterminados

Opciones de configuración (los valores de ejemplo son los predeterminados):

 # el formato de salida del registro de cambios# es el mismo que -o, --output y CHRONICLE_OUTPUT env varoutput: md# suprime todos los resultados de registro# igual que -q; CHRONICLE_QUIET env varquiet: false# todas las opciones de registrolog: # usar registro estructurado # igual que CHRONICLE_LOG_STRUCTURED env var estructurado: false # el nivel de registro # igual que CHRONICLE_LOG_LEVEL env var nivel: "warn" # ubicación para escribir el archivo de registro (el valor predeterminado no es tener un archivo de registro) # igual que el archivo CHRONICLE_LOG_FILE env var: ""# adivina qué la próxima versión se basa en la versión actual y el conjunto de cambios (no se puede usar con --until-tag)# igual que --speculate-next-version / -n ; CHRONICLE_SPECULATE_NEXT_VERSION env varspeculate-next-version: false# anula la etiqueta git inicial para el registro de cambios (el valor predeterminado es detectar la última versión automáticamente)# igual que --since-tag / -s ; CHRONICLE_SINCE_TAG env varsince-tag: ""# anula la etiqueta git final para el registro de cambios (el valor predeterminado es usar la etiqueta o confirmar en git HEAD)# igual que --until-tag / -u; CHRONICLE_SINCE_TAG env varuntil-tag: ""# si la versión actual es <v1.0, los cambios importantes eliminarán el campo de versión menor# igual que CHRONICLE_ENFORCE_V0 env varenforce-v0: false# el título utilizado para el registro de cambios# igual que CHRONICLE_TITLEtitle: Registro de cambios# todas las configuraciones relacionadas con githubgithub:
    # el host de github a usar (anulación para implementaciones empresariales de github) # igual que CHRONICLE_GITHUB_HOST env var host: github.com
    # no considere ningún problema o PR con cualquiera de las etiquetas dadas # igual que CHRONICLE_GITHUB_EXCLUDE_LABELS env var exclusion-labels:
    - duplicado
    - pregunta
    - inválido
    - no se arreglará
    - no se arregla
    - liberar-ignorar
    - registro de cambios-ignorar
    - ignorar
    # considerar los RP fusionados como entradas candidatas del registro de cambios (deben tener una etiqueta coincidente de una entrada 'github.changes') # igual que CHRONICLE_GITHUB_INCLUDE_PRS env var include-prs: true # considerar los problemas cerrados como entradas candidatas del registro de cambios (deben tener una etiqueta coincidente de un entrada 'github.changes') # igual que CHRONICLE_GITHUB_INCLUDE_ISSUES env var include-issues: verdadero # problemas solo se puede considerar para candidatos de registro de cambios si tienen RP vinculados que están fusionados (nota: NO requiere que se configure github.include-issues) # igual que CHRONICLE_GITHUB_ISSUES_REQUIRE_LINKED_PRS env var issues-require-linked-prs: false
    # lista de definiciones de qué etiquetas aplicadas a problemas o relaciones públicas constituyen una entrada del registro de cambios. Estas entradas también dictan # la sección del registro de cambios, el título del registro de cambios y el campo semver que mejor representa la clase de cambio.  # nota: no se puede configurar mediante cambios de variables de entorno: [...<lista de entradas>...] # Consulte la sección "Definiciones de cambios predeterminadas de GitHub" para obtener más detalles

Definiciones de cambios predeterminadas de GitHub

El configurable github.changes es una lista de asignaciones, cada una de las cuales toma los siguientes campos:

• name : [cadena] nombre singular, en minúsculas, separado por guiones (sin espacios) que mejor representa el cambio (por ejemplo, "cambio importante", "seguridad", "función agregada", "mejora", "nueva característica", etc).

• title : [cadena] título de la sección en el registro de cambios que enumera todas las entradas.

• semver-field : [cadena] las entradas de cambio resaltarán el campo semver respectivo al adivinar la próxima versión de lanzamiento. Valores permitidos: major , minor o patch .

• labels : [lista de cadenas] todas las etiquetas de problemas o relaciones públicas que deben coincidir con esta sección de cambios.

El valor predeterminado para github.changes es:

 - nombre: título de correcciones de seguridad: correcciones de seguridad campo semver: etiquetas de parches:
    - seguridad
    - vulnerabilidad
  - nombre: título de la característica agregada: Funciones agregadas campo semver: etiquetas menores:
    - mejora
    - característica
    - menor
  - nombre: título de corrección de errores: Corrección de errores campo semver: etiquetas de parche:
    - bicho
    - arreglar
    - corrección de errores
    - parche
  - nombre: título de la característica de última hora: cambios de última hora campo semver: etiquetas principales:
    - rompiendo
    - incompatible con versiones anteriores
    - cambio radical
    - función de ruptura
    - importante
    - nombre: título de la característica eliminada: Funciones eliminadas campo semver: etiquetas principales:
    - eliminado
  - nombre: título de característica obsoleta: características obsoletas campo semver: etiquetas menores:
    - obsoleto- nombre: título desconocido: cambios adicionales