logseq / logseq/publish-spa

Version string of the Logseq static build not easily identifyable in SPA build

Open
#20 2 comments 0 reactions 0 assignees View on GitHub
enhancement
Dominant language
Clojure
Stars
313
Forks
29
PR merge metrics
No merged PRs in 30d

Description

It is not easy to identify the version of the used Logseq static build and the publish-spa version that was used during publication.

It would help a lot if (at least as a debug option) the version tag of publish-spa and the logseq static build is included either in the html source as metadata or in the SPA UI reachable over an about link in the help section.

Why is adding your own page not sufficient?
The purpose is to have a proof of the actual used version instead of the intended versions, to spot misconfiguration or failed attempts to update the code.

#### challenges

- The commandline command `logseq-publish-spa` has no --version output option or drops it during execution
- The command `logseq-publish-spa` has no verbose option to dump the version of the static logseq build, you just rely on the given path.

If not available like suggested:

- how can the version be retrieved manually from the final SPA build or from the installed code?
- the actual state of the checkout (git status) is not enough, since the `yarn install` does not offer useful output in his warnings.
- the full (re-)install command I used was:
```
logseq % yarn install --frozen-lockfile && yarn gulp:build && clojure -M:cljs release publishing
```
- Maybe there is a different syntax necessary to update properly

Contributor guide

No contributing guide indexed for this repository

Research direction

Start with the `logseq-publish-spa` command and the publication command shown in the issue, then inspect how the static build and publish-spa versions are currently passed through the build. Decide whether the version proof belongs in CLI output, final SPA metadata, or the UI. Done means the final published SPA exposes the actual versions used, or the command provides a documented manual retrieval path.

Written by the indexing model from the issue text.

Assessment

Tech stack
clojure
Domain
build-system, cli, release
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.