From 08028f324f38a5f2f028804bb76a08abdc719ea3 Mon Sep 17 00:00:00 2001 From: Casper da Costa-Luis Date: Tue, 14 Jun 2022 14:12:34 +0100 Subject: [PATCH 1/2] soft-deprecate --file (#1059) Co-authored-by: Helio Machado <0x2b3bfa0+git@googlemail.com> --- bin/cml/publish.js | 3 ++- bin/cml/publish.test.js | 2 -- bin/cml/tensorboard-dev.js | 3 ++- bin/cml/tensorboard-dev.test.js | 46 ++++++++++++++++----------------- 4 files changed, 26 insertions(+), 28 deletions(-) diff --git a/bin/cml/publish.js b/bin/cml/publish.js index e513b9fbb..822baf44c 100644 --- a/bin/cml/publish.js +++ b/bin/cml/publish.js @@ -63,7 +63,8 @@ exports.builder = (yargs) => type: 'string', alias: 'f', description: - 'Append the output to the given file. Create it if does not exist.' + 'Append the output to the given file. Create it if does not exist.', + hidden: true }, repo: { type: 'string', diff --git a/bin/cml/publish.test.js b/bin/cml/publish.test.js index 7a65c875e..8aed8c11f 100644 --- a/bin/cml/publish.test.js +++ b/bin/cml/publish.test.js @@ -22,8 +22,6 @@ describe('CML e2e', () => { --rm-watermark Avoid CML watermark. [boolean] --mime-type Specifies the mime-type. If not set guess it from the content. [string] - -f, --file Append the output to the given file. Create it if does not - exist. [string] --repo Specifies the repo to be used. If not specified is extracted from the CI ENV. [string] --token Personal access token to be used. If not specified, diff --git a/bin/cml/tensorboard-dev.js b/bin/cml/tensorboard-dev.js index 034b98e31..7d378b715 100644 --- a/bin/cml/tensorboard-dev.js +++ b/bin/cml/tensorboard-dev.js @@ -142,7 +142,8 @@ exports.builder = (yargs) => type: 'string', alias: 'f', description: - 'Append the output to the given file. Create it if does not exist.' + 'Append the output to the given file. Create it if does not exist.', + hidden: true }, rmWatermark: { type: 'boolean', diff --git a/bin/cml/tensorboard-dev.test.js b/bin/cml/tensorboard-dev.test.js index b997e1484..f5fa73dc3 100644 --- a/bin/cml/tensorboard-dev.test.js +++ b/bin/cml/tensorboard-dev.test.js @@ -55,30 +55,28 @@ describe('CML e2e', () => { const output = await exec(`node ./bin/cml.js tensorboard-dev --help`); expect(output).toMatchInlineSnapshot(` -"cml.js tensorboard-dev - -Get a tensorboard link - -Options: - --help Show help [boolean] - --version Show version number [boolean] - --log Maximum log level - [string] [choices: \\"error\\", \\"warn\\", \\"info\\", \\"debug\\"] [default: \\"info\\"] - -c, --credentials TB credentials as json. Usually found at - ~/.config/tensorboard/credentials/uploader-creds.json. If - not specified will look for the json at the env variable - TB_CREDENTIALS. [string] [required] - --logdir Directory containing the logs to process. [string] - --name Tensorboard experiment title. Max 100 characters. [string] - --description Tensorboard experiment description. Markdown format. Max - 600 characters. [string] - --md Output as markdown [title || name](url). [boolean] - -t, --title Markdown title, if not specified, param name will be used. - [string] - -f, --file Append the output to the given file. Create it if does not - exist. [string] - --rm-watermark Avoid CML watermark. [boolean]" -`); + "cml.js tensorboard-dev + + Get a tensorboard link + + Options: + --help Show help [boolean] + --version Show version number [boolean] + --log Maximum log level + [string] [choices: \\"error\\", \\"warn\\", \\"info\\", \\"debug\\"] [default: \\"info\\"] + -c, --credentials TB credentials as json. Usually found at + ~/.config/tensorboard/credentials/uploader-creds.json. If + not specified will look for the json at the env variable + TB_CREDENTIALS. [string] [required] + --logdir Directory containing the logs to process. [string] + --name Tensorboard experiment title. Max 100 characters. [string] + --description Tensorboard experiment description. Markdown format. Max + 600 characters. [string] + --md Output as markdown [title || name](url). [boolean] + -t, --title Markdown title, if not specified, param name will be used. + [string] + --rm-watermark Avoid CML watermark. [boolean]" + `); }); test('cml tensorboard-dev --md returns md and after command TB is still up', async () => { From bf905366062cdf882733127c5cb0714642fac3cc Mon Sep 17 00:00:00 2001 From: Casper da Costa-Luis Date: Tue, 14 Jun 2022 19:01:58 +0100 Subject: [PATCH 2/2] 0.16.1 (#1060) --- package-lock.json | 4 ++-- package.json | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/package-lock.json b/package-lock.json index 76e993430..debd88045 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "@dvcorg/cml", - "version": "0.16.0", + "version": "0.16.1", "lockfileVersion": 2, "requires": true, "packages": { "": { "name": "@dvcorg/cml", - "version": "0.16.0", + "version": "0.16.1", "license": "Apache-2.0", "dependencies": { "@actions/core": "^1.8.2", diff --git a/package.json b/package.json index 0b118ed3e..d0b66cb7b 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@dvcorg/cml", - "version": "0.16.0", + "version": "0.16.1", "description": "

", "author": { "name": "Iterative Inc",