Which branch/version/configuration/build has been deployed to which data center/server/environment?
middleman-build-reporter is a Middleman extension to help you understand what code has been deployed to an environment, and whether you're viewing cached or stale build artifacts.
Features:
- Generate YAML and/or JSON files reporting build-time/version details for your Middleman app.
- Fingerprint each Middleman HTML template with a
<!-- FINGERPRINT -->comment surfacing build-time/version details.
middleman-build-reporter can output YAML and/or JSON:
The build/build.yaml:
branch: master
revision: 244921c81c9e21a1973659df5f702937b91cfcd4
build_time: 2014-09-20 10:50:55 -0400
version: 1.2.3The build/build.json:
{
"branch": "master",
"revision": "244921c81c9e21a1973659df5f702937b91cfcd4",
"build_time": "2014-09-20 10:50:55 -0400",
"version": "1.2.3"
}middleman-build-reporter also offers a build_reporter_fingerprint helper to fingerprint HTML templates:
<!--
FINGERPRINT:
---
branch: master
revision: c786c0addcde128a0823c40ebb4a3ab453411f10
build_time: '2014-10-21 07:27:51 -0400'
version: 1.2.3
-->
In your Gemfile:
gem 'middleman-build-reporter'Install it:
$ bundle installActivate it within your config.rb:
activate :build_reporter
Supported configuration
activate :build_reporter do |build|
# optional; the path to your project repository root
# this must be absolute or relative from your build directory
# defaults to app root
build.repo_root = '../../../'
# optional; the version of your app
# defaults to ''
build.version = '1.2.3'
# optional; the build reporter file name
# defaults to 'build'
build.reporter_file = 'build'
# optional; an array of desired build reporter file formats
# supported formats: yaml, json
# defaults to ['yaml']
build.reporter_file_formats = ['yaml', 'json']
endUse the build_reporter_fingerprint to fingerprint your HTML templates with build/version details:
Example usage in layouts/layout.erb:
<body>
<h1>Some Site</h1>
</body>
<%= build_reporter_fingerprint %>Example fingerprint HTML comment:
<body>
<h1>Some Site</h1>
</body>
<!--
FINGERPRINT:
---
branch: master
revision: c786c0addcde128a0823c40ebb4a3ab453411f10
build_time: '2014-10-21 07:27:51 -0400'
version: 1.2.3
-->Add any additional build details to a .build_reporter.yml file in your project's root.
The .build_reporter.yml can be produced as part of your app's build process, or manually managed.
The .build_reporter.yml:
---
foo: 'bar'
baz: 'bim'
The output build/build.yaml:
branch: master
revision: 244921c81c9e21a1973659df5f702937b91cfcd4
build_time: 2014-09-20 10:50:55 -0400
version: 1.2.3
foo: bar
baz: bim
The .build_reporter.yml file can also override the values set by Middleman::BuildReporter::Reporter.
The .build_reporter.yml:
---
revision: 'some_revision'
build_time: 'some_other_time'
The output build/build.yaml:
branch: master
revision: some_revision
build_time: some_other_time
version: 1.2.3
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent