Version bump procedure

The versioning method

iSCSC website versions follows the Semantic Versioning format.

The Version Bump procedure

this page is up-to-date with #71 and 5da6c41

Automatic version bump

After the last PR merged, a version is chosen according to Semantic Versioning.
NOTE: other relatively small PRs don't need to be blocked

At the root of the repo, run (depending on the bump you want in --patch, --minor and --major)

./scripts/bump.sh --patch|--minor|--major

NOTE: run ./scripts/bump.sh -h to see full help

The script will check your dependencies, check the consistency of the git tag and site version, checkout at origin/main and create a branch.
It will then bump ./frontend and ./backend versions, bump the root version, commit and try to push it to the an iScsc/iscsc.fr remote, you may be prompted for you're ssh key passphrase.

⚠️ you must have the iScsc/iscsc.fr remote in your git remotes, the script should detect automatically it, please fill in an issue in case of problems
⚠️ If the push fails you'll have to push yourself, but the script will echo the required command.

Once you've pushed, go to the iScsc/iscsc.fr GitHub and create the PR, named Bump to version X.Y.Z.

The PR is then reviewed, approved and merged.

On the iScsc/iscsc.fr GitHub releases page click Draft a new release.
Tag and title it vX.Y.Z, it should enable the Generate release notes, click it and Publish release.
Development process can continue...

Manual version bump

As for the automatic version bump, after the last PR merged, a version is chosen according to Semantic Versioning.
NOTE: other relatively small PRs don't need to be blocked

From main a X.Y.Z-version-bump branch is created and switched on.
local repo copy must be up-to-date.

Version is updated to X.Y.Z in package.json at repo root as well as ./frontend/package.json and ./backend/package.json.

{
...
    "version" : "X.Y.Z"
...
}

A single commit is created including the above changes and titled Bump to version X.Y.Z.

The above commit is pushed on origin and a PR is created.

The PR is then reviewed, approved and merged.

On the iScsc/iscsc.fr GitHub releases page click Draft a new release.
Tag and title it vX.Y.Z, it should enable the Generate release notes, click it and Publish release.
Development process can continue...

Documentation about versioning, version bump, bumpers

• Semantic Versioning
• Tips for changelog scripts
• A successful git branching model, bump procedure example
• EdgeX DevOps manual bump example: video