Get metadata for your build

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

npm install build-data --save

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);
});

Returns a Promise for an object with the git branch and a newly generated version, based on the status of the cwd.

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

Type: object

Settings and known build metadata.

Type: string
Default: process.cwd()

Parent directory of the build root.

Type: string

A git branch name, can be provided to improve performance or override git.

Type: string

A build version, can be provided to improve performance or use a specific version.

• 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

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.

MPL-2.0 © Seth Holladay

Go make something, dang it.