Sign inSign up

cenk1cenk2/pipe-node

By cenk1cenk2

•Updated 2 days ago

Node.JS operations for pipelines.

Image
0

10K+

cenk1cenk2/pipe-node repository overview

⁠pipe-node

Pipe for installing node.js dependencies and building node.js applications on CI/CD.

pipe-node [GLOBAL FLAGS] [COMMAND] [FLAGS]

⁠Global Flags

CLI

Flag / EnvironmentDescriptionTypeDefault
$LOG_LEVELDefine the log level for the application.string
enum("panic", "fatal", "warn", "info", "debug", "trace")		"info"
$ENV_FILEEnvironment files to inject.string[]

⁠Commands

⁠pipe-node login

Login to the given NPM registries.

pipe-node login [FLAGS]

⁠Flags

Login

Flag / EnvironmentDescriptionTypeDefault
$NPM_LOGINNPM registries to login.string
format(json([]struct{ username: string, token: string, registry?: string, useHttps?: bool }))
$NPM_NPMRC_FILE.npmrc file to use.string[]".npmrc"
$NPM_NPMRCDirect contents of .npmrc file.string

Package Manager

Flag / EnvironmentDescriptionTypeDefault
$NODE_PACKAGE_MANAGERPreferred package manager for nodejs.string
format(enum("npm", "yarn", "pnpm"))		"pnpm"
⁠pipe-node install

Install node.js dependencies with the given package manager.

pipe-node install [FLAGS]

⁠Flags

Install

Flag / EnvironmentDescriptionTypeDefault
$NODE_INSTALL_CWDWorking directory for the install operation.string"."
$NODE_INSTALL_USE_LOCK_FILEUse the lockfile while installing the packages.booltrue
$NODE_INSTALL_ARGSArguments to append to the install command.string
$NODE_INSTALL_CACHEEnable caching for the package manager.booltrue
Login
Flag / EnvironmentDescriptionTypeDefault
$NPM_LOGINNPM registries to login.string
format(json([]struct{ username: string, token: string, registry?: string, useHttps?: bool }))
$NPM_NPMRC_FILE.npmrc file to use.string[]".npmrc"
$NPM_NPMRCDirect contents of .npmrc file.string
Package Manager
Flag / EnvironmentDescriptionTypeDefault
$NODE_PACKAGE_MANAGERPreferred package manager for nodejs.string
format(enum("npm", "yarn", "pnpm"))		"pnpm"
⁠pipe-node add

Install node packages with the given package manager.

pipe-node add [FLAGS]

⁠Flags
Package Manager
Flag / EnvironmentDescriptionTypeDefault
$NODE_PACKAGE_MANAGERPreferred package manager for nodejs.string
format(enum("npm", "yarn", "pnpm"))		"pnpm"

Packages

Flag / EnvironmentDescriptionTypeDefault
$NODE_ADD_PACKAGES*Install node packages before performing operations.string[]
$NODE_ADD_GLOBALInstall node packages globally.booltrue
$NODE_ADD_SCRIPT_ARGSScript arguments to append to the install command.string
$NODE_ADD_CWDWorking directory for the add operation.string"."

* required

⁠pipe-node build

pipe-node build [FLAGS]

⁠Flags

Build

Flag / EnvironmentDescriptionTypeDefault
$NODE_BUILD_SCRIPTpackage.json script for the build operation.string
format(Template(struct{ Environment: string, EnvVars: map[string]string }))		"build"
$NODE_BUILD_SCRIPT_ARGSpackage.json script arguments for the build operation.string
format(Template(struct{ Environment: string, EnvVars: map[string]string }))
$NODE_BUILD_CWDWorking directory for the build operation.string"."

Environment

Flag / EnvironmentDescriptionTypeDefault
$ENVIRONMENT_ENABLEEnable environment injection.boolfalse
$ENVIRONMENT_CONDITIONSRegex pattern to select an environment.
Use either "heads/" for narrowing the search to branches or "tags/" for narrowing the search to tags.		string
format(json([]struct{ match: RegExp, environment: string }))		"[\n { \"match\": \"^tags/v?\\\\d+.\\\\d+.\\\\d+$\", \"environment\": \"production\" },\n { \"match\": \"^tags/v?\\\\d+.\\\\d+.\\\\d+-.*\\\\.\\\\d+$\", \"environment\": \"stage\" },\n { \"match\" :\"^heads/main$\", \"environment\": \"develop\" },\n { \"match\": \"^heads/master$\", \"environment\": \"develop\" }\n]"
$ENVIRONMENT_FAIL_ON_NO_REFERENCEFail on missing environment references.booltrue
$ENVIRONMENT_STRICTFail when no environment is selected.booltrue

GIT

Flag / EnvironmentDescriptionTypeDefault
$CI_COMMIT_REF_NAME
$BITBUCKET_BRANCH		Source control branch.string
$CI_COMMIT_TAG
$BITBUCKET_TAG		Source control tag.string
Package Manager
Flag / EnvironmentDescriptionTypeDefault
$NODE_PACKAGE_MANAGERPreferred package manager for nodejs.string
format(enum("npm", "yarn", "pnpm"))		"pnpm"
⁠pipe-node run

pipe-node run [FLAGS] Arguments appended to the script.

⁠Arguments
ArgumentUsageTypeValues
argArguments appended to the script.string[]0..*
⁠Flags

Command

Flag / EnvironmentDescriptionTypeDefault
$NODE_RUN_SCRIPT
$NODE_COMMAND_SCRIPT		package.json script for the given command operation.string
format(Template(struct{ Environment: string, EnvVars: map[string]string }))
$NODE_RUN_CWD
$NODE_COMMAND_CWD		Working directory for the given command operation.string"."
Environment
Flag / EnvironmentDescriptionTypeDefault
$ENVIRONMENT_ENABLEEnable environment injection.boolfalse
$ENVIRONMENT_CONDITIONSRegex pattern to select an environment.
Use either "heads/" for narrowing the search to branches or "tags/" for narrowing the search to tags.		string
format(json([]struct{ match: RegExp, environment: string }))		"[\n { \"match\": \"^tags/v?\\\\d+.\\\\d+.\\\\d+$\", \"environment\": \"production\" },\n { \"match\": \"^tags/v?\\\\d+.\\\\d+.\\\\d+-.*\\\\.\\\\d+$\", \"environment\": \"stage\" },\n { \"match\" :\"^heads/main$\", \"environment\": \"develop\" },\n { \"match\": \"^heads/master$\", \"environment\": \"develop\" }\n]"
$ENVIRONMENT_FAIL_ON_NO_REFERENCEFail on missing environment references.booltrue
$ENVIRONMENT_STRICTFail when no environment is selected.booltrue
GIT
Flag / EnvironmentDescriptionTypeDefault
$CI_COMMIT_REF_NAME
$BITBUCKET_BRANCH		Source control branch.string
$CI_COMMIT_TAG
$BITBUCKET_TAG		Source control tag.string
Package Manager
Flag / EnvironmentDescriptionTypeDefault
$NODE_PACKAGE_MANAGERPreferred package manager for nodejs.string
format(enum("npm", "yarn", "pnpm"))		"pnpm"

Tag summary

Content type

Image

Digest

sha256:9f371fac4…

Size

394 MB

Last updated

2 days ago

docker pull cenk1cenk2/pipe-node:22