This library brings you easy to use deploy scripts and helper scripts to write human readable deploy code. It is powered by ShellJS and jsonpath.

Howto Use

1) :monkey: Install as dev dependency

npm install node-deploy-essentials --save-dev

Then add this script to wrap the binary in your package.json

{
  "scripts": {
    "ndes": "node ./node_modules/.bin/ndes"
  }
}

Now you can run

npm run ndes --version

2) :monkey: Install globally

npm install -g node-deploy-essentials

Now you can run

ndes --version

3) :monkey: Run via docker

docker run --tty --volume $(pwd)/:/opt/npm codeclou/docker-node-deploy-essentials:latest ndes --version

Note: Not all commands might work right when running as docker container. If you use waitForStatus or dockerHelper commands this might not work.

Scripts

• 1. Replace Helper
  • replace byCurrentTimetamp
  • replace by value
• 2. Grep Helper
  • grepJson
• 3. Deployment Scripts
  • deployToGitHubPages
  • deployToGitHubBranch
• 4. HTTP Helper

  • waitForStatusCode

:bulb: 1. Replace Helper

The replace helper helps you replace Strings in files.

:cyclone: replace {searchString} byCurrentTimetamp in {filename}

This helper replaces the searchString by the current ISO 8601 DateString in the file called filename.

Example

Let's assume you have the following file src/deploy-info.js

export default {
  branch:    '___BRANCH___',
  commit:    '___COMMIT___',
  buildTime: '___TIMEST___'
}

Then we want to replace ___TIMEST___ by the current timestamp you do

npm run ndes replace "___TIMEST___" byCurrentTimetamp in "src/deploy-info.js"

The src/deploy-info.js now looks like

export default {
  branch:    '___BRANCH___',
  commit:    '___COMMIT___',
  buildTime: '2016-07-25T20:50:23.722Z'
}

:cyclone: replace {searchString} by {value} in {filename}

This helper replaces the searchString by the value in the file called filename.

Example

Let's assume you have the following file src/deploy-info.js

export default {
  branch:    '___BRANCH___',
  commit:    '___COMMIT___',
  buildTime: '___TIMEST___'
}

Then we want to replace ___BRANCH___ by our Branchname.

npm run ndes replace "___BRANCH___" byValue "master" in "src/deploy-info.js"

The src/deploy-info.js now looks like

export default {
  branch:    'master',
  commit:    '___COMMIT___',
  buildTime: '___TIMEST___'
}

:bulb: 2. Grep Helper

:cyclone: grepJson {jsonPathQuery} from {filename} withMessage {message}

Extracts a JSON Value by using jsonPathQuery from filename echos it to STDOUT prefixed by message.

Example

Let's assume our package.json looks like this

{
  "homepage": "https://codeclou-int.github.io/bitbucket-pipeline-app-demo/master/"
}

With this command you extract the value of "homepage" from package.json

npm run ndes grepJson "$.homepage" from "package.json" withMessage "deployed to:"

Then the console output will be

deployed to: https://codeclou-int.github.io/bitbucket-pipeline-app-demo/master/

:bulb: 3. Deployment Scripts

:cyclone: deployToGitHubPages as {gitHubCommitterName} withEmail {gitHubCommitterEmail} withGitHubAuthUsername {gitHubAuthUsername} withGitHubAuthToken {gitHubAuthTokenOrPassword} toRepository {gitHubCloneUrl} fromSource {sourceDirToDeployContents} intoSubdirectory {gitHubSubdirectory}

Will deploy content of sourceDirToDeployContents to GitHub Pages https://owner.github.io/repoName/gitHubSubdirectory/.

Example

This script will deploy the contents of ./build/ directory into https://john123.github.io/customdir/

npm run ndes deployToGitHubPages as "John Smith" withEmail "[email protected]" withGitHubAuthUsername john123 withGitHubAuthToken aaa121411f31f31ff13 toRepository https://github.com/john123/johntest.git fromSource build intoSubdirectory customdir 

Notice

• :bangbang: System needs to have git installed.
• :bangbang: The order of the parameters is NOT interchangable.
• :bangbang: The target directory is purged (all files are deleted before new files are copied).

Parameters

| parameter | Example Usage | Description | | --------- | ------------- | ----------- | | gitHubCommitterName | deployToGitHubPages as "John Smith" ... | - | | gitHubCommitterEmail | deployToGitHubPages ... withEmail "[email protected]" ... | - | | gitHubAuthUsername | deployToGitHubPages ... withGitHubAuthUsername johnsmith ... | The actual GitHub username that corresponds to gitHubAuthTokenOrPassword | | gitHubAuthTokenOrPassword | deployToGitHubPages ... withGitHubAuthToken aafaffaf121212 ... | The GitHub Private Token with repo scope. | | gitHubCloneUrl | deployToGitHubPages ... toRepository https://repoOwner.github.com/repoName.git | Note that you have to provide the full URL ending with .git. Only https:// URLs are supported at the moment. | | sourceDirToDeployContents | deployToGitHubPages ... fromSource build ... | The source folder whose contents should be deployed | | gitHubSubdirectory | deployToGitHubPages ... intoSubdirectory myBranch ... | OPTIONAL-PARAMETER: The subfolder that should be created on baseDir of the gh-pages Branch and deployed into. |

:cyclone: deployToGitHubBranch as {gitHubCommitterName} withEmail {gitHubCommitterEmail} withGitHubAuthUsername {gitHubAuthUsername} withGitHubAuthToken {gitHubAuthTokenOrPassword} toRepository {gitHubCloneUrl} branch {gitHubBranch} fromSource {sourceDirToDeployContents} intoSubdirectory {gitHubSubdirectory}

Will deploy content of sourceDirToDeployContents to GitHub Repository on Branch {gitHubBranch}.

Example

This script will deploy the contents of ./build/ directory into the foobar branch.

npm run ndes deployToGitHubBranch as "John Smith" withEmail "[email protected]" withGitHubAuthUsername john123 withGitHubAuthToken aaa121411f31f31ff13 toRepository https://github.com/john123/foo.git branch foobar fromSource build

Notice

• :bangbang: System needs to have git installed.
• :bangbang: The order of the parameters is NOT interchangable.
• :bangbang: The target directory is purged (all files are deleted before new files are copied).

Parameters

| parameter | Example Usage | Description | | --------- | ------------- | ----------- | | gitHubCommitterName | deployToGitHubBranch as "John Smith" ... | - | | gitHubCommitterEmail | deployToGitHubBranch ... withEmail "[email protected]" ... | - | | gitHubAuthUsername | deployToGitHubBranch ... withGitHubAuthUsername johnsmith ... | The actual GitHub username that corresponds to gitHubAuthTokenOrPassword | | gitHubAuthTokenOrPassword | deployToGitHubBranch ... withGitHubAuthToken aafaffaf121212 ... | The GitHub Private Token with repo scope. | | gitHubCloneUrl | deployToGitHubBranch ... toRepository https://repoOwner.github.com/repoName.git | Note that you have to provide the full URL ending with .git. Only https:// URLs are supported at the moment. | | gitHubBranch | deployToGitHubBranch ... branch master | Do provide the Branchname without prefixes like origin/. Just the plain name. | | sourceDirToDeployContents | deployToGitHubBranch ... fromSource build ... | The source folder whose contents should be deployed | | gitHubSubdirectory | deployToGitHubBranch ... intoSubdirectory myBranch ... | OPTIONAL-PARAMETER: The subfolder that should be created on baseDir of Branch and deployed into. |

:bulb: 4. HTTP Helper

:cyclone: http waitForStatusCode {statusCode} {url}

This is usefull when you are starting up a big server that needs some time for startup and you want to wait for a HTTP 200 status code. Request Loop will break after 5000 requests and will NOT pause in between requests.

Example

This command will request the url and wait for a HTTP 200 and blocks the next command inside a shell script.

npm run ndes http waitForStatusCode 200 http://someurl/foo

Notice

• :bangbang: request loops stops after 5000 requests with an exit 1

Parameters

| parameter | Example Usage | Description | | --------- | ------------- | ----------- | | statusCode | 200 | e.g. 200, 302 a.s.o | | url | https://some.url | e.g. http://google.com |

License

MIT License

Changelog

Read details in Releases.

Note to contributors

By sending us patches/PRs, you automatically license the code under the same terms as node-deploy-essentials.