Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
70 changes: 41 additions & 29 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,48 +7,58 @@
## Overview

Build versioning tool for Azure DevOps.
It will update your versioning file with a new generated version if the build is executed from a non stable branch.
So that you will always have a unique version that is build, even during PR builds.
As a bonus it will also update the pipeline name to reflect that new version so that you never have to look for the correct build again.
It will update your JSON file's `version` field with a new generated version if the build is executed from a non-stable branch.
Therefore, you will always have a unique version that is build, even during PR builds.
As a bonus, it will also update the pipeline name to reflect that new version so that you never have to look for the correct build again.

You can have a look at the builds of this plugin to see how that will be shown in [Azure DevOps](https://hvdb.visualstudio.com/simple-versioner/_build/latest?definitionId=1&branchName=master)

## Usage

`npx simple-versioner`
```bash
npx simple-versioner
```

or install

`npm i simple-versioner`
`simple-versioner`
```bash
npm i simple-versioner --save-dev
```

If you install it globally and have the global `node_modules` bin folder added to your PATH:

```bash
npm i -g simple-versioner
simple-versioner
```

### Options

#### Other file then package.json
#### Other file than package.json

`npx simple-versioner vss-extension.json`

Disclaimer: only works on files that also have a field named version
Disclaimer: only works on files that also have a field named `version`.

#### Different stable branch

Default stable branch is`master` if you are using a different stable branch you can provided this via a parameter.
Default stable branch is `master`, if you are using a different stable branch you can provide this via a parameter:

`npx simple-versioner -b:main`

### Possible options

`-b:BRANCH` -> Specify a different branch as release branch.
`-nu` -> Do not set the buildnumber in azure, only update the version in the provided json file.
`-mp` -> When specified the generate version will be based on the date and time. ie: `2022.3.1647715987`
`-ntc` -> No Tag Check, when passed it will not throw an error if the tag already exists. Handy when you need to recreate the version later on in the build process. Or don't care about tag already exists.
- `-b:BRANCH` -> Specify a different branch from the default release branch.
- `-nu` -> Do not set the buildnumber in Azure, only update the version in the provided json file.
- `-mp` -> When specified, the generated version will be based on the date and time, ie: `2022.3.1647715987`
- `-ntc` -> No Tag Check, when passed it will not throw an error if the tag already exists. Handy when you need to recreate the version later on in the build process. Or if you don't care about tag already exists.

### Using it in the Azure DevOps pipelines

#### Editor

You can add it via the editor:
Include an bash task:
You can add it via the editor:
Include a bash task:
```bash
npx simple-versioner
```
Expand All @@ -63,41 +73,43 @@ npx simple-versioner
## How it works

### Default behavior

When it is a stable build:
If the build is for the specified stable branch, the version would be left as is.
It will check if there are tags available with the specified version, if so it will throw an error stating that the version is already released. The build will then stop.
If the build is for the specified stable branch, the version would be left as is.
It will check if there are tags available with the specified version, if so it will throw an error stating that the version is already released. The build will then stop.
*Unless the `-ntc` option is provided. Then this check if not done.*

When it is a feature build:
- version: 1.0.0
- branch: develop
- gitCommitSha = 7bea27af4e3095bf77701a4e8dc71e9a53140b55

Version send to Azure, and put into the provided file to version is `1.0.0-refs-heads-develop-7bea27af`
note: `/` provided in the branchname are replaced by `-`
Version send to Azure, and put into the provided file to version is `1.0.0-refs-heads-develop-7bea27af`.
note: `/` provided in the branchname are replaced by `-`.

PR's are also handled and the correct branch and commitHash is used.
PRs are also handled and the correct branch and commitHash is used.

What happens in azure:
What happens in Azure:
The `Build.Buildnumber` will be update to the version needed. The build name will then be changed to that version instead of predefined name.
_Note: You can suppress this by providing the `-nu` option._

### Alternative
When providing the `-mp` option a version based on the date/time will be generated for non release branches.
Used format: `yy:MM:time` The time is generated based on `date.getTime()` divide by 1000 and the rounded with `Math.floor`
The check if the version (provided in your json file) is still executed.
The buildnumber will also be updated, when nor suppressed.

This is usefull for when you are developing a VScode and/or Azure devops extension.
As the marketplaces does not support prerelease version.
When providing the `-mp` option, a version based on the date/time will be generated for non-release branches.
Used format: `yy:MM:time` The time is generated based on `date.getTime()`, divide by 1000 and then rounded with `Math.floor`.
The check if the version (provided in your json file) is still executed.
The buildnumber will also be updated, when nor suppressed.

This is useful for when you are developing a VScode and/or Azure devops extension.
As the marketplaces does not support prerelease version.
_(hence the `-mp` name :))_

## Contributing

Feel free to contribute! Just fork and create a PR.
Feel free to contribute! Just fork and create a PR.

### Tests

Tests can be executed by running `npm t`
Tests can be executed by running `npm run test`.