Expose running version on CLI and Web

rudymatela commented 2 years ago

Closes: #123

Expose the running version of Hoff in the CLI and Web.

This is useful for avoiding mistakes when deploying: the version number will clearly indicate which version is deployed at a given URL and in the logs.

See the updated CLI and web interfaces below:

$ nix run -c stack exec hoff -- --help
A gatekeeper for your commits

Usage: hoff <config-file> [--read-only] [--version]

Available options:
  --read-only              Run in read-only mode
  --version                Displays version and exit
  -h,--help                Show this help text

$ nix run -c stack exec hoff -- --version
Hoff v0.26.2

$ nix run -c stack exec hoff config.json --no-nix-pure
Starting Hoff v0.26.2
Config file: config.json
Read-only: False
Loaded project state from './run/state/git-sandbox.json'.
[Info] logic loop received event: Synchronize
...

On the web interface, the version is discreetly displayed at the bottom-right of all pages, see:

version-on-web

repo

TODO

[x] Add Version module exposing version :: String;
[x] Add --version switch;
[x] State version when starting Hoff;
[x] Test that Version.version and hoff.cabal:version: are the same if possible
- [x] ... and also that hoff.nix has the same version as well...
[x] Document --version and --read-only switches (upon --help);
[x] Display version on the web interface
[x] Create sibling PR to update internal documentation with an extra deploy step (src/Version.hs) bump
[x] ~Add @hoffbot version command?~ Not now. I will do this in a separate PR.

rudymatela commented 2 years ago

@alex-mckenna I think I have addressed your comments :grin:. Can you please review again?

rudymatela commented 2 years ago

I will not merge this now. Since these changes are quite self-contained, it is a good candidate to test #137 for real after it is deployed soon. :steam_locomotive: :train: :train: :train: ...

rudymatela commented 2 years ago

@OpsBotPrime merge on Friday

OpsBotPrime commented 2 years ago

Pull request approved for merge by @rudymatela, waiting for rebase behind one pull request.

OpsBotPrime commented 2 years ago

Speculatively rebased as 4481d93dee2a0506863ecd9080a2b7e0b90ae907 behind #166, waiting for CI …

OpsBotPrime commented 2 years ago

CI job started.

rudymatela commented 2 years ago

This is a merge train example. https://github.com/channable/hoff/issues/160 (Never mind this comment. I am just gathering a list to analyse.)

channable / hoff

Expose running version on CLI and Web #157

TODO