Web Site/Application

Use Case: Web Application/Website Versioning with Versioning Tools API

Context

Managing versions for a web application or website is crucial for maintaining control over deployments, tracking changes, and ensuring consistent updates. This use case demonstrates how a developer can use the Versioning Tools API to automate the versioning process locally. The process involves retrieving the next semantic version, updating version information, tagging the Git repository, and preparing the site for deployment.

Scenario

A developer has completed a new feature or update for a web application or website. To prepare for the release, the developer needs to:

1. Retrieve the next semantic version from the Versioning Tools API.

2. Update the version information in the local codebase.

3. Tag the version in the version control system (Git).

4. Prepare the application or website for deployment.

Step-by-Step Guide

1. Retrieve the Next Version Identifier

The developer needs to obtain the next semantic version using the Versioning Tools API.

Command:

curl -X 'POST' \
  'https://api.versioning.tools/v1/SemVer/myWebAppOrSite?apiKey=YOUR_API_KEY' \
  -H 'accept: */*'

Explanation:

• myWebAppOrSite: Replace with your service ID for the web application or website.

• YOUR_API_KEY: Replace with your API key.

Response:

{
  "version": "1.4.0"
}

The response provides the next version number, such as 1.4.0.

2. Update Version Information in the Codebase

Update the version information in your web application or website’s codebase. This typically involves updating version metadata files or configuration files used for deployment.

For Web Applications:

1. Update package.json (for Node.js applications):

   • Open the package.json file.

   • Update the version field:

     {
       "name": "my-web-app",
       "version": "1.4.0",
       "description": "My Web Application"
       ...
     }

2. Update Configuration Files:

   • If your web application uses configuration files for versioning, such as .env or custom JSON/XML files, update the version accordingly:

     {
       "version": "1.4.0"
     }

For Static Websites:

1. Update a Version File:

   • If you maintain a version file (e.g., version.txt), update it with the new version number:

     1.4.0

2. Update Build Metadata:

   • If using build tools or scripts, ensure that the version number is updated in any build metadata or configuration files.

3. Tag the Version in Git

Tag the new version in your Git repository.

Command:

git tag v1.4.0 -m "Release version 1.4.0"

Explanation:

• v1.4.0: The version number obtained from the API.

• -m "Release version 1.4.0": A message describing the tag.

4. Push the Tag to the Remote Repository

Push the new tag to the remote repository.

Command:

git push origin v1.4.0

Explanation:

• origin: The name of the remote repository.

• v1.4.0: The tag being pushed.

5. Prepare for Deployment

Prepare the web application or website for deployment by:

1. Build Artifacts:

   • Build or compile the application if necessary. For static sites, ensure that the build process reflects the new version.

2. Deploy the Application or Website:

   • Upload the new build artifacts or updated files to your hosting environment.

3. Update Deployment Documentation:

   • Document the new version in your deployment records or release notes.

Example Workflow

Here’s an example workflow a developer might follow:

1. Complete Development:

   • Finalize coding and testing for the new feature or update.

2. Retrieve the Next Version:

   NEXT_VERSION=$(curl -X 'POST' \
     'https://api.versioning.tools/v1/SemVer/myWebAppOrSite?apiKey=YOUR_API_KEY' \
     -H 'accept: */*')

3. Update Version Information:

   • For Node.js apps, update package.json.

   • For static websites, update version.txt or configuration files.

4. Tag the Repository:

   git tag "v$NEXT_VERSION" -m "Release version $NEXT_VERSION"

5. Push the Tag:

   git push origin "v$NEXT_VERSION"

6. Prepare for Deployment:

   • Build and deploy the updated application or website.

---