mettre à jour automatiquement la version package.json

Avant de faire une petite version et de l'étiqueter, j'aimerais mettre à jour le package.json pour refléter la nouvelle version du programme.

Existe-t-il un moyen de modifier package.jsonautomatiquement le fichier ?

Serait en utilisant une git pre-release hookaide?

npm versionest probablement la bonne réponse. Juste pour donner une alternative, je recommande grunt-bump . Il est maintenu par l'un des gars d'angular.js.

Usage:

grunt bump
>> Version bumped to 0.0.2

grunt bump:patch
>> Version bumped to 0.0.3

grunt bump:minor
>> Version bumped to 0.1.0

grunt bump
>> Version bumped to 0.1.1

grunt bump:major
>> Version bumped to 1.0.0

Si vous utilisez de toute façon grunt, cela pourrait être la solution la plus simple.

Bonne réponse

Pour ce faire, il suffit de npm version patch=)

Ma vieille réponse

Il n'y a pas de pre-releasecrochet à l'origine git. Au moins, man githooksne le montre pas.

Si vous utilisez git-extra( https://github.com/visionmedia/git-extras ), par exemple, vous pouvez utiliser un pre-releasehook qui est implémenté par celui-ci, comme vous pouvez le voir sur https://github.com/visionmedia/ git-extras / blob / master / bin / git-release . Il suffit d'un .git/hook/pre-release.shfichier exécutable qui édite votre package.jsonfichier. La validation, le push et le marquage seront effectués par la git releasecommande.

Si vous n'utilisez aucune extension pour git, vous pouvez écrire un script shell (je le nomme git-release.sh) et vous pouvez l'aliaser git releaseavec quelque chose comme:

git config --global alias.release '!sh path/to/pre-release.sh $1'

Vous pouvez, que, utiliser git release 0.4qui exécutera path/to/pre-release.sh 0.4. Votre script peut modifier package.json, créer la balise et la pousser vers le serveur.

C'est ce que je fais normalement avec mes projets:

npm version patch
git add *;
git commit -m "Commit message"
git push
npm publish

La première ligne npm version patchaugmentera la version du correctif de 1 (xx1 à xx2) dans package.json. Ensuite, vous ajoutez tous les fichiers - y compris ceux package.jsonqui ont été modifiés à ce moment-là. Ensuite, l'habituel git commitet git push, et enfin npm publishpour publier le module.

J'espère que cela a du sens...

Merc.

Pour donner une approche plus actuelle.

package.json

  "scripts": {
    "eslint": "eslint index.js",
    "pretest": "npm install",
    "test": "npm run eslint",
    "preversion": "npm run test",
    "version": "",
    "postversion": "git push && git push --tags && npm publish"
  }

Ensuite, vous l'exécutez:

npm version minor --force -m "Some message to commit"

Qui va:

1. ... exécuter des tests ...

2. passez package.jsonà une version mineure suivante (par exemple: 1.8.1 à 1.9.0)

3. pousser vos changements

4. créer une nouvelle version de balise git et

5. publiez votre package npm.

--forcec'est montrer qui est le patron! Blagues à part voir https://github.com/npm/npm/issues/8620

En complément, npm versionvous pouvez utiliser l' --no-git-tag-versionindicateur si vous voulez un changement de version mais pas de balise ou un nouveau commit:

npm --no-git-tag-version version patch

https://docs.npmjs.com/cli/version

Si vous utilisez du fil, vous pouvez utiliser

yarn version --patch

Cela incrémentera la package.jsonversion par patch (0.0.x), le commit et le marquera avec le formatv0.0.0

De même, vous pouvez modifier la version mineure ou majeure en utilisant --minorou--major

Lorsque vous poussez vers git, assurez-vous de pousser également les balises avec --follow-tags

git push --follow-tags

Vous pouvez également créer un script pour cela

    "release-it": "yarn version --patch && git push --follow-tags"

Exécutez-le simplement en tapant yarn release-it

J'utilise husky et git-branch-is :

À partir de Husky v1 +:

// package.json
{
  "husky": {
    "hooks": {
      "post-merge": "(git-branch-is master && npm version minor || 
  (git-branch-is dev && npm --no-git-tag-version version patch)",
    }
  }
}

Avant Husky V1:

"scripts": {
  ...
  "postmerge": "(git-branch-is master && npm version minor || 
  (git-branch-is dev && npm --no-git-tag-version version patch)",
  ...
},

En savoir plus sur la version npm

Webpack ou Vue.js

Si vous utilisez webpack ou Vue.js, vous pouvez l'afficher dans l'interface utilisateur en utilisant la version Auto inject - plugin Webpack

NUXT

Dans nuxt.config.js:

var WebpackAutoInject = require('webpack-auto-inject-version');

module.exports = {
  build: {
    plugins: [
      new WebpackAutoInject({
        // options
        // example:
        components: {
          InjectAsComment: false
        },
      }),
    ]
  },
}

À l'intérieur de votre templatepar exemple dans le pied de page:

<p> All rights reserved © 2018 [v[AIV]{version}[/AIV]]</p>

Je veux clarifier les réponses à cette question.

Même s'il y a des réponses ici qui s'attaquent correctement au problème et fournissent une solution, ce ne sont pas les bonnes. La bonne réponse à cette question est d'utilisernpm version

Existe-t-il un moyen de modifier automatiquement le fichier package.json?

Oui, ce que vous pouvez faire pour que cela se produise est d'exécuter la npm versioncommande lorsque cela est nécessaire, vous pouvez en savoir plus à ce sujet ici version npm , mais l'utilisation de base serait npm version patchet il ajouterait le 3e ordre de chiffres sur votre package.jsonversion (1.0. X )

Est-ce que l'utilisation d'un hook de pré-version git aiderait?

Vous pouvez configurer pour exécuter la npm versioncommande sur le hook de pré-version, selon vos besoins, mais cela dépend si c'est ce dont vous avez besoin ou non dans votre canal CD / CI, mais sans la npm versioncommande, un git pre-releasehook ne peut rien faire "facilement" avec lepackage.json

La raison pour laquelle npm versionla réponse est correcte est la suivante:

1. Si l'utilisateur utilise une structure de dossiers dans laquelle il a un, package.jsonil utilise npms'il utilise, npmil a accès au fichier npm scripts.
2. S'il y a accès, npm scriptsil a accès à la npm versioncommande.
3. En utilisant cette commande, il n'a plus besoin d'installer quoi que ce soit de plus dans son ordinateur ou sur son tube CD / CI, ce qui à long terme réduira l'effort de maintenabilité du projet et aidera à l'installation.

Les autres réponses dans lesquelles d'autres outils sont proposés sont incorrectes.

gulp-bump fonctionne mais nécessite un autre package supplémentaire qui pourrait créer des problèmes à long terme (point 3 de ma réponse)

grunt-bump fonctionne mais nécessite un autre package supplémentaire qui pourrait créer des problèmes à long terme (point 3 de ma réponse)

Tout d'abord, vous devez comprendre les règles de mise à niveau du numéro de version. Vous pouvez en savoir plus sur la version sémantique ici.

Chaque version aura une version xyz où elle définit à des fins différentes, comme indiqué ci-dessous.

1. x - majeur, jusqu'à ce que vous ayez des changements majeurs et qu'il y a une énorme différence de changements.
2. y - mineur, augmenter lorsque vous avez une nouvelle fonctionnalité ou une amélioration.
3. z - patch, augmentez-le lorsque vous avez corrigé des bogues ou annulez les modifications de la version précédente.

Pour exécuter les scripts, vous pouvez le définir dans votre package.json.

"script": {
    "buildmajor": "npm version major && ng build --prod",
    "buildminor": "npm version minor && ng build --prod",
    "buildpatch": "npm version patch && ng build --prod"
}

Dans votre terminal, il vous suffit d'exécuter npm en fonction de vos besoins, comme

npm run buildpatch

Si vous l'exécutez dans git repo, la version par défaut de git-tag-version est true et si vous ne souhaitez pas le faire, vous pouvez ajouter la commande ci-dessous dans vos scripts:

--no-git-tag-version

par exemple: "npm --no-git-tag-version version major && ng build --prod"

J'ai créé un outil qui peut effectuer un contrôle de version sémantique automatique basé sur les balises dans les messages de validation, connus sous le nom de types de changement. Cela suit de près la convention de message de validation angulaire ainsi que la spécification de versioning sémantique.

Vous pouvez utiliser cet outil pour changer automatiquement la version dans package.json à l'aide de l'interface de ligne de commande npm (ceci est décrit ici ).

En outre, il peut créer un journal des modifications à partir de ces validations et dispose également d'un menu (avec un correcteur orthographique pour les messages de validation) pour créer des validations en fonction du type de modification. Je recommande vivement de le vérifier et de lire des documents pour voir tout ce qui peut être accompli avec.

J'ai écrit l'outil parce que je n'ai rien trouvé qui convenait à mes besoins pour mon pipeline CICD pour automatiser la gestion des versions sémantiques. Je préfère me concentrer sur les changements réels plutôt que sur ce que devrait être la version et c'est là que mon outil sauve la mise.

Pour plus d'informations sur la justification de l'outil, veuillez consulter ceci .