Skip to content

Commit

Permalink
fix: Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
braybatista authored Mar 6, 2024
1 parent f8551f2 commit faf90fe
Showing 1 changed file with 35 additions and 1 deletion.
36 changes: 35 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,35 @@
readme
## ¿Como funciona?
### Commit message format
semantic-release utiliza los mensajes de confirmación para determinar el impacto de los cambios en el código base en el consumidor. Siguiendo convenciones formalizadas para mensajes de confirmación, semantic-release determina automáticamente el siguiente número de versión semántica, genera un registro de cambios y publica la versión.

De forma predeterminada, la liberación semántica utiliza
convenciones de mensajes de confirmación angular. [convenciones de mensajes de confirmación angular.](https://github.com/angular/angular/blob/main/CONTRIBUTING.md#-commit-message-format)
El formato del mensaje de confirmación se puede cambiar con las opciones preestablecidas o de configuración de los complementos @semantic-release/commit-analyzer y @semantic-release/release-notes-generator.

Se pueden utilizar herramientas como commitizen o commit-lint para ayudar a los contribuyentes y hacer cumplir los mensajes de confirmación válidos.

La siguiente tabla muestra qué mensaje de confirmación le proporciona qué tipo de versión cuando se ejecuta la versión semántica (usando la configuración predeterminada):

|Commit message |Release type |
|-----------------|--------------------------------------------------------------------------------|
|fix(pencil): |stop graphite breaking when too much pressure applied Patch Fix Release |
|feat(pencil): |add 'graphiteWidth' option Minor Feature Release |
|perf(pencil): |remove graphiteWidth option |
|BREAKING CHANGE: |The graphiteWidth option has been removed. |
|The default graphite width of 10mm is always used for performance reasons. Major Breaking Release |
|(Note that the BREAKING CHANGE: token must be in the footer of the commit) |

dentro de la documentación de angular sobre convenciones de mensajes se tienen estos adicionales:

- build: cambios que afectan el sistema de compilación o las dependencias externas (alcances de ejemplo: gulp, broccoli, npm).
- ci: Cambios en nuestros archivos y scripts de configuración de CI (ejemplos: CircleCi, SauceLabs).
- docs: La documentación solo cambia.
- feat: una nueva característica.
- fix: una corrección de errores.
- perf: Un cambio de código que mejora el rendimiento.
- refactor: un cambio de código que no corrige un error ni agrega una característica.
- test: agregar pruebas faltantes o corregir pruebas existentes.

### excluir commit del análisis del plugin:

Todas las confirmaciones que contengan [skip release] or [release skip] en su mensaje se excluirán del análisis de confirmación y no participarán en la determinación del tipo de versión.

0 comments on commit faf90fe

Please sign in to comment.