Document explaining project versioning strategy

Table of contents

Introduction

We are following semantic version system to release each new version. It works on major, minor and patch analogy to release a version. Standard version package is used to bump, commit and tag app version in package.json file. It stores commit name and hash in change-log file, everything gets done automatically. all we need to do is pass major, minor or patch tag with npm release command.

Release a new version

• How it works

<aside> 💡 Only project contributors can trigger workflow to release a new version of patternscape.

</aside>

• Go to GitHub action workflow and press "Run workflow" button on right side.

• Enter Bump version, options are: patch, minor or major.
• Change-log field is optional (default link will direct to project timeline doc), if you are giving changelog then it must be formatted markdown.
• Press run workflow to trigger workflow.

Setup Semantic Versioning in any project

<aside> 💡 THIS PART IS NOT REQUIRED FOR DEVELOPEMENT OF THE PROJECT, THIS IS HERE FOR JUST EDUCATIONAL PURPOSE.

</aside>