build-data

Get metadata for your build

Why?

• Useful for managing build processes.
• Reliable and concurrent data collection.
• Intelligent behavior in or out of a repository.

Install

npm install build-data --save

Usage

Get it into your program.

const buildData = require('build-data');

Get the current branch name and a version to be associated with your build.

buildData().then((data) => {
    console.log('data:', data);
    // {
    //     branch  : 'master',
    //     version : '1.0.0'
    // }
});

Get the data that was used for the most recent build.

buildData.latest().then((data) => {
    console.log('data:', data);
});

You can and should provide any data you know already.

buildData({ version : '3.2.1' }).then((data) => {
    console.log('data:', data);
});

API

buildData(option)

option

Type: object

Settings and known build metadata.

cwd

Type: string Default: process.cwd()

The parent directory of the build root.

branch

Type: string

Use the given branch name, instead of asking git.

version

Type: string

Use the given version, instead of asking build-version.

buildData.latest(option)

Same as buildData(), except the branch defaults to the most recently built branch and version defaults to the most recently built version of the branch.

Related

• delivr - Build your code and ship it to S3
• build-files - Read the files from your build
• build-keys - Get the paths of files from your build
• build-dir - Get a place to put your build
• build-path - Get a path for the given build
• build-version - Get a version for your build
• branch-name - Get the current branch name

Contributing

See our contributing guidelines for more details.

1. Fork it.
2. Make a feature branch: git checkout -b my-new-feature
3. Commit your changes: git commit -am 'Add some feature'
4. Push to the branch: git push origin my-new-feature
5. Submit a pull request.

License

MPL-2.0 © Seth Holladay

Go make something, dang it.