Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add commit sha to version information #5531

Merged
merged 1 commit into from
Jul 11, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Add commit sha to version information
thornbill committed May 21, 2024
commit 8961a19154f071a875afbcda7386487ecf5b282d
1 change: 1 addition & 0 deletions .eslintrc.js
Original file line number Diff line number Diff line change
@@ -263,6 +263,7 @@ module.exports = {
'UserParentalControlPage': 'writable',
'Windows': 'readonly',
// Build time definitions
__COMMIT_SHA__: 'readonly',
__JF_BUILD_VERSION__: 'readonly',
__PACKAGE_JSON_NAME__: 'readonly',
__PACKAGE_JSON_VERSION__: 'readonly',
7 changes: 6 additions & 1 deletion src/controllers/dashboard/dashboard.js
Original file line number Diff line number Diff line change
@@ -208,7 +208,12 @@ function refreshActiveRecordings(view, apiClient) {

function reloadSystemInfo(view, apiClient) {
view.querySelector('#buildVersion').innerText = __JF_BUILD_VERSION__;
view.querySelector('#webVersion').innerText = __PACKAGE_JSON_VERSION__;

let webVersion = __PACKAGE_JSON_VERSION__;
if (__COMMIT_SHA__) {
webVersion += ` (${__COMMIT_SHA__})`;
}
view.querySelector('#webVersion').innerText = webVersion;

queryClient
.fetchQuery(getSystemInfoQuery(toApi(apiClient)))
1 change: 1 addition & 0 deletions src/global.d.ts
Original file line number Diff line number Diff line change
@@ -15,6 +15,7 @@ export declare global {
'viewshow': CustomEvent;
}

const __COMMIT_SHA__: string;
const __JF_BUILD_VERSION__: string;
const __PACKAGE_JSON_NAME__: string;
const __PACKAGE_JSON_VERSION__: string;
6 changes: 5 additions & 1 deletion src/index.jsx
Original file line number Diff line number Diff line change
@@ -60,7 +60,11 @@ function loadCoreDictionary() {

function init() {
// Log current version to console to help out with issue triage and debugging
console.log(`${__PACKAGE_JSON_NAME__} version ${__PACKAGE_JSON_VERSION__} build ${__JF_BUILD_VERSION__}`);
console.info(
`[${__PACKAGE_JSON_NAME__}]
version: ${__PACKAGE_JSON_VERSION__}
commit: ${__COMMIT_SHA__}
build: ${__JF_BUILD_VERSION__}`);

// This is used in plugins
window.Events = Events;
10 changes: 10 additions & 0 deletions webpack.common.js
Original file line number Diff line number Diff line change
@@ -23,6 +23,15 @@ const LibarchiveWasm = [
];

const DEV_MODE = process.env.NODE_ENV !== 'production';
let COMMIT_SHA = '';
try {
COMMIT_SHA = require('child_process')
.execSync('git describe --always --dirty')
.toString()
.trim();
} catch (err) {
console.warn('Failed to get commit sha. Is git installed?', err);
}

const NODE_MODULES_REGEX = /[\\/]node_modules[\\/]/;

@@ -48,6 +57,7 @@ const config = {
},
plugins: [
new DefinePlugin({
__COMMIT_SHA__: JSON.stringify(COMMIT_SHA),
__JF_BUILD_VERSION__: JSON.stringify(
process.env.WEBPACK_SERVE ?
'Dev Server' :
Loading