Skip to content
This repository was archived by the owner on Jun 6, 2023. It is now read-only.

Commit 367fb6b

Browse files
committed
improve param description
1 parent 714d1e7 commit 367fb6b

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

lib/jobs/create.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ const chalk = require('chalk');
3030
* @param {string} [params.projectId] - The poject id of an existing project for this job. Note: if projectId is specified, the project parameter cannot be specified.
3131
* @param {string} [params.command] - An optional command to run within the workspace or container.
3232
* @param {string} [params.workspace] - An optional path to a workspace, or link to a git repository to upload and merge with the container. If a zip file name is provided it is uploaded instead. If no workspace is provided the current directory is zipped up and transferred. If the workspace is 'none', no workspace is merged and the container is run as-is. To download a git repository provide an https repository link and optionally prefix it with 'git+', e.g. 'https://github.com/MyProjects/MyRepo.git'. If the 'git+' prefix is not specified, it is added at the time of download to the job runner machine. S3 links are also supported using the schema 's3://bucketname/objectname'.
33-
* @param {string} [params.ignoreFiles] - An optional reference to files that should be excluded from workspace upload. Files/folders to be ignored.
33+
* @param {string} [params.ignoreFiles] - An optional reference to files or folders that should be excluded from workspace upload. Files/folders to be ignored, comma seperated if multiple.
3434
* @param {string} [params.codeCommit] - An optional reference to git commit hash if local workspace is a git repository. Found at runtime.
3535
* @param {string} [params.dataset] - An optional reference to a dataset to be merged with the container.
3636
* @param {string} [params.registryUsername] - An optional username for accessing an image hosted on a private container registry. Note: you must specify this option every time a private image is specified for the container.

0 commit comments

Comments
 (0)