action libérations automatiques

Versions automatiques de GitHub

Cette action simplifie le processus de publication de GitHub en téléchargeant automatiquement les ressources, en générant des journaux de modifications, en gérant les versions préliminaires, etc.

Contenu

1. Exemples d'utilisation
2. Paramètres pris en charge
3. Déclencheurs d'événements
4. Gestion des versions
5. Comment obtenir de l'aide
6. Licence

REMARQUE : Le référentiel marvinpinto/action-automatic-releases est un miroir généré automatiquement du monorepo marvinpinto/actions contenant cette action et d'autres. Veuillez déposer des problèmes et des demandes d'extraction là-bas.

Exemples d'utilisation

Générez automatiquement une pré-version lorsque les modifications arrivent sur le maître

Cet exemple de flux de travail démarrera dès que les modifications arriveront sur master . Après avoir exécuté les étapes de création et de test de votre projet :

1. Il créera (ou remplacera) une balise git appelée latest .
2. Générez un journal des modifications à partir de tous les commits entre celui-ci et la latest balise précédente.
3. Générez une nouvelle version associée à la latest balise (en supprimant toutes les versions associées précédentes).
4. Mettez à jour cette nouvelle version avec le titre spécifié (par exemple Development Build ).
5. Téléchargez LICENSE.txt et tous les fichiers jar en tant qu'actifs de version.
6. Marquez cette version comme une pre-release .

Vous pouvez voir un exemple fonctionnel de ce flux de travail sur marvinpinto/actions.

---
name : " pre-release "

on :
  push :
    branches :
      - " master "

jobs :
  pre-release :
    name : " Pre Release "
    runs-on : " ubuntu-latest "

    steps :
      # ...
      - name : " Build & test "
        run : |
          echo "done!"

      - uses : " marvinpinto/action-automatic-releases@latest "
        with :
          repo_token : " ${{ secrets.GITHUB_TOKEN }} "
          automatic_release_tag : " latest "
          prerelease : true
          title : " Development Build "
          files : |
            LICENSE.txt
            *.jar

Créez une nouvelle version de GitHub lorsque les balises sont poussées vers le référentiel

Semblable à l'exemple précédent, ce flux de travail démarrera dès que de nouvelles balises seront transférées vers GitHub. Après avoir construit et testé votre projet :

1. Générez un journal des modifications à partir de tous les commits entre cette balise et la balise précédente ressemblant à un semver.
2. Générez une nouvelle version et associez-la à cette balise.
3. Téléchargez LICENSE.txt et tous les fichiers jar en tant qu'actifs de version.

Encore une fois, il y a un exemple de cela sur marvinpinto/actions.

---
name : " tagged-release "

on :
  push :
    tags :
      - " v* "

jobs :
  tagged-release :
    name : " Tagged Release "
    runs-on : " ubuntu-latest "

    steps :
      # ...
      - name : " Build & test "
        run : |
          echo "done!"

      - uses : " marvinpinto/action-automatic-releases@latest "
        with :
          repo_token : " ${{ secrets.GITHUB_TOKEN }} "
          prerelease : false
          files : |
            LICENSE.txt
            *.jar 

Paramètres pris en charge

Paramètre	Description	Défaut
repo_token **	Jeton d'action GitHub, par exemple "${{ secrets.GITHUB_TOKEN }}" .	null
draft	Marquer cette version comme brouillon ?	false
prerelease	Marquer cette version comme une pré-version ?	true
automatic_release_tag	Nom de la balise à utiliser pour les versions automatiques, par exemple latest .	null
title	Titre de la version ; par défaut, le nom de la balise si aucun n'est spécifié.	Nom de la balise
files	Fichiers à télécharger dans le cadre des ressources de la version.	null

Sorties

Les valeurs de sortie suivantes sont accessibles via ${{ steps..outputs. }} :

Nom	Description	Taper
automatic_releases_tag	La balise de version que cette action vient de traiter	chaîne
upload_url	L'URL pour télécharger des ressources supplémentaires vers la version	chaîne

Remarques :

• Les paramètres indiqués par ** sont obligatoires.
• Le paramètre files prend en charge les modèles globaux multilignes, voir les exemples de référentiel.

Déclencheurs d'événements

Le framework GitHub Actions vous permet de déclencher cette action (et d'autres) sur de nombreuses combinaisons d'événements. Par exemple, vous pouvez créer des versions préliminaires spécifiques pour les balises de version candidate (par exemple *-rc* ), générer des versions au fur et à mesure que les modifications arrivent sur le maître (exemple ci-dessus), des versions nocturnes et bien plus encore. Lisez la syntaxe du workflow pour les actions GitHub pour obtenir des idées et des exemples avancés.

Gestion des versions

Chaque commit qui atterrit sur master pour ce projet déclenche une build automatique ainsi qu'une version balisée appelée latest . Si vous ne souhaitez pas vivre à la pointe de la technologie, vous pouvez utiliser une version stable à la place. Voir les versions pour les versions disponibles.

"">

- uses : " marvinpinto/action-automatic-releases@ " 

Comment obtenir de l'aide

Le README principal de ce projet contient de nombreuses informations liées aux problèmes de débogage et de soumission. Si vous êtes toujours bloqué, essayez de me joindre sur keybase et je ferai de mon mieux pour vous aider.

Licence

Le code source de ce projet est publié sous la licence MIT. Ce projet n'est pas associé à GitHub.