screenly / chrome-extension

Versioning - screenly/chrome-extension

Versioning is the practice of assigning unique identifiers to different versions of a software extension, allowing users to track changes and manage updates. In the context of the Screenly Chrome Extension project (https://github.com/screenly/chrome-extension/), versioning is an essential aspect of maintaining and distributing the extension.

There are several methods for versioning a Chrome Extension, including:

  1. Manifest versioning: The manifest.json file in a Chrome Extension project contains metadata about the extension, including its version number. This version number can be updated manually in the manifest.json file. For example:
{
"manifest_version": 2,
"name": "Screenly Extension",
"version": "1.0.0",
// ...
}

Reference: Using JavaScript to hack the web | Opensource.com

  1. Docker image tagging: If the Screenly Chrome Extension is packaged as a Docker image, versioning can be managed using Docker image tagging. Docker image tags follow semantic versioning conventions, allowing users to easily identify the version of the extension they are using. For example:
docker build -t screenly/chrome-extension:1.0.0 .

Reference: Package and release your extension | Docker Docs

  1. API versioning: If the Screenly Chrome Extension includes an API, versioning can be managed using API versioning methods. There are several methods for API versioning, including media type versioning, custom headers versioning, URI versioning, domain versioning, request parameter versioning, and date versioning. For example, using URI versioning:
https://example.com/api/v1/screenly

Reference: API versioning methods: A brief reference | Red Hat Developer

To update the extension’s version number, follow these steps:

  1. Determine the versioning method used in the Screenly Chrome Extension project.
  2. Update the version number using the appropriate method (e.g., update the version field in manifest.json, tag the Docker image with a new version number, or update the API version number in the URI).
  3. Test the updated extension to ensure it functions as expected.
  4. Publish the updated extension, following the appropriate distribution method (e.g., publishing to the Chrome Web Store or pushing the updated Docker image to a registry).

Note: The Screenly Chrome Extension project does not include a manifest.json file, Dockerfile, or API, so the above examples are for illustrative purposes only.

Sources: