create_build_info_js

This script will create a JavaScript file at the given path containing build and source control information.

The given path can either be relative to the base directory (-d) or an absolute path—intermediate directories will not be created.

The following parameters are optional:

d

the base directory ($PWD if not given)

f

overwrite the existing file

The value of build.id is depending on where this script is run:

locally

the current timestamp

AppVeyor

the value of the APPVEYOR_BUILD_ID environment variable

Bitbucket

the value of the BITBUCKET_BUILD_NUMBER environment variable

CircleCI

the value of the CIRCLE_WORKFLOW_ID environment variable

GitHub

the value of the GITHUB_RUN_ID environment variable

GitLab

the value of the CI_PIPELINE_ID environment variable

Jenkins

the value of the BUILD_ID environment variable

TeamCity

the value of the BUILD_NUMBER environment variable

Travis

the value of the TRAVIS_BUILD_ID environment variable

The value of build.time is either the value of the SOURCE_DATE_EPOCH environment variable or the current timestamp.

The following will give you the timestamp of the HEAD commit:

SOURCE_DATE_EPOCH="$(git log --max-count=1 --pretty=format:%ct)"

This script will add source control information if the base directory (-d) is under Git version control, i.e., either the top-level directory or one its subdirectories.

/tmp
├── git_repo
│   └── .git
│   └── src
└── other
-d /tmp

source control information will not be added

-d /tmp/git_repo

source control information will be added

-d /tmp/git_repo/src

source control information will be added

-d /tmp/other

source control information will not be added

The value of git.commit.id is the hash of the HEAD commit of the checked-out branch; the suffix -next will be appended if the working tree is dirty.

Usage

$ scripts/web/create_build_info_js.sh build-info.js

$ scripts/web/create_build_info_js.sh -f /tmp/build-info.js
$ scripts/web/create_build_info_js.sh -d ~/git_repo src/build-info.js
$ scripts/web/create_build_info_js.sh src/build-info.js

⇓

src/build-info.js
/** @type {{build: {id: string, time: string}, git: {commit: {id: string, time: string}, branch: string}}} */
export const buildInfo = {
  build: {
    id: '1710116787',
    time: '2024-03-11T00:26:27Z',
  },
  git: {
    branch: 'main',
    commit: {
      id: '4768a3cf26cecc00a23be6acdf430809e4bb67a7',
      time: '2024-03-11T00:25:48Z',
    },
  },
};
$ SOURCE_DATE_EPOCH=0 scripts/web/create_build_info_js.sh src/build-info.js

⇓

src/build-info.js
...
  build: {
...
    time: '1970-01-01T00:00:00Z',
  },
...

More Information