Low/No Code Use Case

Certainly! Below is a use case for versioning in a low-code or no-code environment using the Versioning Tools API. This guide is tailored for developers or users working with low-code or no-code platforms and shows how to integrate version management into their workflow.

---

Use Case: Low/No Code Application Versioning with Versioning Tools API

Context

In low-code and no-code environments, managing versions is crucial for tracking changes, coordinating updates, and ensuring consistency across deployments. This use case illustrates how users can automate versioning for low-code or no-code applications using the Versioning Tools API. The process involves retrieving the next version identifier, updating the version in the platform, and managing deployment.

Scenario

A user has completed updates or new features in a low-code or no-code application. To prepare for deployment, the user needs to:

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

2. Update the version information within the low-code/no-code platform.

3. Tag the version in the version control system (if applicable).

4. Prepare the application for deployment.

Step-by-Step Guide

1. Retrieve the Next Version Identifier

The user retrieves the next semantic version using the Versioning Tools API.

Command:

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

Explanation:

• myLowCodeApp: Replace with your service ID for the low-code or no-code application.

• YOUR_API_KEY: Replace with your API key.

Response:

{
  "version": "0.9.0"
}

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

2. Update Version Information in the Platform

In low-code or no-code platforms, the process to update the version might differ based on the platform used. Generally, you will need to:

1. Locate the Version Configuration:

   • Find where versioning information is managed in your platform. This could be in project settings, metadata, or a similar section.

2. Update the Version:

   • Enter the new version number received from the API. The exact method will vary by platform but generally involves updating a field or setting.

   For example:

   • In platforms like OutSystems or Mendix, update the version number in the application’s project or deployment settings.

3. Tag the Version in Git (If Applicable)

If your low-code or no-code application uses Git for version control, tag the version in the repository.

Command:

git tag v0.9.0 -m "Release version 0.9.0"

Explanation:

• v0.9.0: The version number obtained from the API.

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

4. Push the Tag to the Remote Repository (If Applicable)

Push the new tag to the remote Git repository.

Command:

git push origin v0.9.0

Explanation:

• origin: The name of the remote repository.

• v0.9.0: The tag being pushed.

5. Prepare for Deployment

Prepare the low-code or no-code application for deployment:

1. Deploy the Application:

   • Use the platform's deployment tools or options to deploy the updated version. Most low-code/no-code platforms have built-in deployment processes.

2. Update Deployment Documentation:

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

Example Workflow

Here’s an example workflow a user might follow:

1. Complete Updates:

   • Finalize changes and ensure everything is functioning as expected.

2. Retrieve the Next Version:

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

3. Update Version Information in the Platform:

   • Enter NEXT_VERSION into the version management section of your low-code/no-code platform.

4. Tag the Repository (If Applicable):

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

5. Push the Tag (If Applicable):

   git push origin "v$NEXT_VERSION"

6. Prepare for Deployment:

   • Deploy the application using the platform’s tools and update deployment documentation.

---