Adding optional parameter - create annotated git tag

Ouverte Adaptée aux débutants
#332 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Évaluation

Difficulté
2/5
Temps estimé
1-3 heures
Accessibilité débutants
70/100
Type d'issue
Fonctionnalité
Clarté
Plutôt claire
Activité
Calme
Stack technique
github-actions, python
Domaine
release

Piste de recherche

Commencez par localiser le schéma des entrées de l’Action et le point d’entrée du générateur où les git tags sont actuellement gérés, puis ajoutez une nouvelle entrée optionnelle tag-creation. Suivez le flux existant pour les tags manquants ou créés et ajustez le comportement afin que true crée le tag s’il est absent (avec un avertissement s’il existe déjà), tandis que false ignore explicitement la création et échoue avec une erreur bien visible. Exécutez les tests habituels du projet ou la vérification CI pour la génération des notes de version, et vérifiez que la documentation et les exemples décrivent la nouvelle option ainsi que ses résultats attendus.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Description

enhancement
Feature Description

Currently, with the newest version of v1.3.2, the Release Notes Generator does assume that the Git Tag already exists. If it does not exist, the action fails.

The way we solved this is that we explicitly create the Git Tag one step before the Release Notes Generator - but this is logically so close to the RN generator workflow, that it could be part of it - configurable by user.

Problem / Opportunity

Every CI action involving RN Generator must have a git tag creation there. Since this is used on almost every repository, our CI files could be slightly simpler - reducing git tag creation code.

Acceptance Criteria

The RN generator contains 1 optional parameter, maybe boolean tag-creation or something like that.

  • If it's true, then it will be created (and if it exists already maybe it should just emit warning).
  • If false then it should not create tag and it should fail loudly.
Langage dominant
Python
Étoiles
12
Forks
0
Merge moyen
1 min
PR mergées (30 j)
6

Préparer son environnement

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de AbsaOSS/generate-release-notes

Toutes les issues de AbsaOSS/generate-release-notes

Issues similaires

Plus d'issues Python

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.