@fontoxml/fontoxml-development-tools 3.12.0-beta.1 → 3.13.0-nightly.20221123233045

package/README.md

@@ -6,7 +6,7 @@ The Fonto Development Tools are command-line tools which offer support for devel
 
 ### Node
 
-The tools require [NPM](https://www.npmjs.com/get-npm) on [Node.js®](https://nodejs.org/) version 12.20.x or higher, which are freely available. An active or maintenence LTS release is recommended. After installing Node.js, you can install the latest version of the Fonto Development Tools globally on your system using the following command:
+The tools require [NPM](https://www.npmjs.com/get-npm) on [Node.js®](https://nodejs.org/) version 12.20.x or higher, which are freely available. An active or maintenence LTS release is recommended. After installing Node.js, the latest version of the Fonto Development Tools can be installed globally on your system using the following command:
 
     npm i -g @fontoxml/fontoxml-development-tools
 
@@ -14,13 +14,13 @@ Alternatively, the tools can be installed locally for your project using the fol
 
     npm install --save-dev @fontoxml/fontoxml-development-tools
 
-> **tip**: You can use Node Version Manager on Linux/MacOS or its Windows counterpart to install and use multiple version of Node.js on a single system. This is useful if you develop different projects with different versions of Node.js.
+> **tip**: Use Node Version Manager on Linux/MacOS or its Windows counterpart to install and use multiple version of Node.js on a single system. This is useful if you develop different projects with different versions of Node.js.
 
 ### Docker
 
-Certain commands, like `review run` and `review build`, require [Docker Community Edition](https://www.docker.com/) to be installed.
+Certain commands, like `review run` and `review build`, require [Docker](https://www.docker.com/) to be installed together with the Docker Compose plugin. Please refer to the [Docker installation instructions](https://docs.docker.com/install/) and the [Compose installation instructions](https://docs.docker.com/compose/install/) to install them.
 
-> **tip**: Docker places their installers behind an unnecessary login. Use the following direct links to avoid having to create an account: [Windows installer](https://download.docker.com/win/stable/Docker%20for%20Windows%20Installer.exe), [macOS installer](https://download.docker.com/mac/stable/Docker.dmg). For Linux, Docker Community Edition is usually available through package managers.
+> **note**: Please note that the Docker Compose plugin differs from the `docker-compose` standalone tool. Run `docker compose version` to verify its availability. Newer versions of Docker Desktop include the plugin by default.
 
 ## Usage
 

package/bitbucket-pipelines.yml

@@ -29,17 +29,47 @@ pipelines:
         - parallel: *build-tests
 
     tags:
-        '*-*':
+        'nightly':
             - parallel: *build-tests
             - step:
-                  name: Publish @beta
+                  image:
+                      name: fontoxmltoolsinternal.azurecr.io/build-tools/fdt:nightly
+                      username: $TOOLS_INTERNAL_REGISTRY_USERNAME
+                      password: $TOOLS_INTERNAL_REGISTRY_PASSWORD
+                  name: Publish @nightly
                   script:
+                      - >
+                          if ! NIGHTLY_VERSION=$(fdt internal generate-version --type nightly --package-json-location ./package.json); then
+                              echo "Could not generate a nightly version, FDT outputted:";
+                              echo "$NIGHTLY_VERSION";
+                              exit 1;
+                          fi
+                      - echo "Publishing nightly version '$NIGHTLY_VERSION'."
+                      - npm version --git-tag-version false $NIGHTLY_VERSION
                       - pipe: atlassian/npm-publish:0.2.3
                         variables:
-                            EXTRA_ARGS: --tag beta
+                            EXTRA_ARGS: --tag nightly
                             NPM_TOKEN: $NPM_API_TOKEN
 
-        '*':
+        '*.*.*-rc.*':
+            - parallel: *build-tests
+            - step:
+                  name: Publish @rc
+                  script:
+                      - pipe: atlassian/npm-publish:0.2.3
+                        variables:
+                            EXTRA_ARGS: --tag rc
+                            NPM_TOKEN: $NPM_API_TOKEN
+
+        '*.*.*-*':
+            - step:
+                  name: Unsupported tag
+                  script:
+                      - >
+                          echo "The provided tag '$BITBUCKET_TAG' has an unsupported pre-release format and will not be published.";
+                          exit 1;
+
+        '*.*.*':
             - parallel: *build-tests
             - step:
                   name: Publish @latest
@@ -47,3 +77,18 @@ pipelines:
                       - pipe: atlassian/npm-publish:0.2.3
                         variables:
                             NPM_TOKEN: $NPM_API_TOKEN
+
+    custom:
+        build-release-nightly:
+            - step:
+                  name: Publish @nightly
+                  script:
+                      - >
+                          if git describe --tags --exact-match HEAD --match nightly; then
+                              echo "The commit $(git rev-parse HEAD) already has the 'nightly' tag.";
+                              exit 0;
+                          fi
+                      - echo "Placing the 'nightly' tag on commit $(git rev-parse HEAD) to trigger the nightly pipeline."
+                      - git push origin --delete refs/tags/nightly || true
+                      - git tag --force --annotate --message "This was an automated event ($BITBUCKET_BUILD_NUMBER)." nightly
+                      - git push origin refs/tags/nightly

package/index.js

@@ -1,4 +1,4 @@
 export { default as App } from './src/App.js';
 export { default as AssertableWritableStream } from './src/AssertableWritableStream.js';
-export { default as FdtCommand } from './src/FdtCommand.js';
 export { default as FdtTable } from './src/FdtTable.js';
+export { default as FdtCommand } from './src/request/FdtCommand.js';