Documentation
Primary version
Primary version
  • Cubbles documentation
  • First steps
    • Generate a project
    • Create a webpackage
    • Create an elementary component
    • Create a compound component
      • Compound slot initialization
  • Runtime extension - RTE
    • User guide
      • RTE Integration
      • The Cubbles TAG API
        • The Cubbles Dependency API
      • The Cubbles Javascript API
        • Interacting with Cubbles from the outside
        • Adding dynamic connections
        • Interacting with Elementary Cubbles from the inside
      • The RTE Processing
        • RTE initialization and rendering timeline
      • The Cubbles IFrame API
        • The Cubbles IFrame Resizer API
      • The Cubbles mutation based start event API
      • FAQs
        • How to manually resolve dependency conflicts?
        • How to create a component instance dynamically?
        • How to render HTML Markup coming from input slot?
        • How to replace a dependency when declaring a component instance?
        • How to synchronize multiple dataflows between component instances?
        • How to handle the copyValue flag for non serializable instances?
    • Contributor guide
      • CIF processing
  • Developing with the vanilla boilerplate
    • Creating a new project
    • Developing elementaries using the vanilla boilerplate
    • Developing compounds using the vanilla boilerplate
    • Using the vanilla boilerplate scripts
  • Coder devtools - CDT
    • User guide
      • Create Cubbles artifacts
      • Upload a Webpackage
      • Generate a README file
      • Rename an artifact
      • Configure network proxy
      • Validate the manifest.webpackage file
      • Change active webpackage
      • Bulk upload of webpackages
      • Release a webpackage
      • Update the RTE version of a webpackage
      • Prepare a webpackage to be released
      • Update webpackage to the next development version
      • Generate a test environment for a component
      • Testing Cubbles components
      • Validate sources
      • Create a demo webpackage
    • Contributor guide
      • Checklist for releasing a new webpackage.modelVersion
  • Terms and concepts
    • Webpackage
    • Artifacts
    • User roles
    • Base
Powered by GitBook
On this page
  • Purpose
  • Steps
  • Outcome
  • The npm module version
  1. Coder devtools - CDT
  2. User guide

Prepare a webpackage to be released

PreviousUpdate the RTE version of a webpackageNextUpdate webpackage to the next development version

Last updated 6 years ago

When you have finished developing a webpackage (or any of its artifacts), you may want to release it in a store using a fixed version (i.e., without the -SNAPSHOT suffix). After uploading the webpackage to a store, one won't be able to upload changes using the same version. The offers you the _webpackage-prepareRelease task to:

  • Check that all dependencies of your webpackage are not in development (i.e., they are fixed versions); to avoid any unexpected behaviour of artifacts under development.

  • Update the version of your webpackage using a fixed version, provided by you or generated automatically by removing the -SNAPSHOT suffix to the current version.

Purpose

To show how to use the _webpackage-prepareRelease task to prepare a webpackage to be released.

Steps

First, you should run the task within the CDT folder (normally it is called devtools) as follows:

grunt  _webpackage-prepareRelease

Then, you should provide the release version to be used. Remember that it should be a digit, three or two dot-separated digits (e.g. 1, 3.1, 2.0.3). Or you can use the generated value (displayed in parenthesis) by pressing Enter. For instance, in the code below the suggested version is 0.1.0:

? Please type the release version to be set to the webpackage: (0.1.0)

If all dependencies belong to released webpackages and the provided release version (if any) is correct, the process will finish. Otherwise, you will be prompted with a message indicating the error and how to solve it. After solving the error, you should run the task again.

Outcome

The version of your webpackage will be updated in the manifest.webpackage file.

The npm module version

You can use an npm module that serves the same purposes called . The module can be used from the command line or in a node script.

CDT
cubx-prepare-webpackage-release