Skip to content

Releases

1.1.2

Choose a tag to compare

@github-actions github-actions released this 14 Nov 09:42

Fixed

  • The community scorecard of 1.1.1 lists 22 warnings in the e2e helpers (e2e/fixtures.ts, e2e/demo-garmin.ts, e2e/live-key.ts): the scanner lints every file a tsconfig.json covers, and e2e/tsconfig.json (added in 1.1.1 for npm run typecheck) made it cover them. That config is now tsconfig.e2e.json in the root, with the same options, and npm run typecheck checks e2e/ through it. The scanner finds only files named tsconfig.json, so it skips e2e/ again, as it did up to 1.1.0. The warnings were Obsidian runtime rules (window.setTimeout, no globalThis, no node:child_process) that do not apply to Playwright code, which runs in Node, and no-unsafe-* on values read from Obsidian through evaluate. Nothing in main.js changes.

1.1.1

Choose a tag to compare

@github-actions github-actions released this 14 Nov 01:06

Changed

  • The dev kit is obsidian-plugin-dev-kit 0.3.0 (moved with opdk kit upgrade v0.3.0), so that opdk scan reports what the community scorecard reports. Four things follow. TypeScript is 6 (typescript ^6.0.3, was ^5.6.0); the code needed no changes to compile. The ESLint config is renamed from eslint.config.js to eslint.config.mjs, because the scanner does not read .mjs files and a .js config that imports the kit gets two warnings there; npm run lint lints the same files as before. The scan.ignore key is gone from opdk.config.mjs (the kit removed it: a skipped file was still on the public scorecard), so opdk scan now reads site/ too and found 20 CSS warnings in the GitHub Pages stylesheets, which are fixed: the !important rules on code in the explorer, the block index and the key list now win by specificity, and the reduced-motion rule names the animated elements instead of using *; the "On this page" list is a two-column grid filled top to bottom (each list sets its row count) instead of CSS columns; the unused :has() rule is removed; ui-monospace is dropped from the code font stack (the next font in it, SF Mono, is the same face) and links lose the 1px underline thickness (the browser default is used, offset unchanged). Screenshots of the home page and all guides before and after, at 1280 and 390 pixels wide, differ by a few single pixels at the ends of link underlines and nowhere else. opdk scan now prints 0 findings and one advisory line for site/assets/site.js, which no tsconfig covers.
  • The dev kit is obsidian-plugin-dev-kit 0.2.0 (was 0.1.0), moved with its new opdk kit upgrade command: the tag in package.json, the lockfile and the two kit workflow lines (ci.yml, release.yml) name commit 32a1860. Its lint preset reports a bare window.<member> again, the check the old scorecard-check.cjs had; Garmy has none. opdk release check now also fails when those three places disagree. Typecheck, lint, 499 unit tests, build, opdk scan, opdk release check, readme:check, site:check and the e2e pass on it.
  • The sleep and HRV guide says the Choose step groups appear under the Everything kind, and names the Sleep and HRV and recovery kinds.
  • The site no longer copies the phone-* stills, which only feed the directory pictures (tools/listing.mjs).
  • Build, lint, scanner, end-to-end harness, README films and release are done by obsidian-plugin-dev-kit 0.1.0 (the opdk command, installed from its v0.1.0 tag). Garmy's own settings are in opdk.config.mjs. The scripts it replaces are deleted: assert-bundle.cjs, scorecard-check.cjs, e2e-setup.sh, capture.mjs, version-sync.cjs, make-zip.cjs and assert-versions.cjs.
  • The release bundle is built by opdk build and is now minified: main.js goes from 336087 to 285177 bytes (114154 bytes gzipped, was 121404; both measured as gzip -c main.js | wc -c on the build of origin/main and of this branch). The platform stays browser, and the kit also marks @codemirror/state and @codemirror/view as external, which Garmy does not import. The kit's bundle check (no process, node: imports, __dirname) replaces scripts/assert-bundle.cjs. The esbuild devDependency is gone, the kit brings its own.
  • npm run scorecard:check runs opdk scan (the scanner's own ESLint configuration for eslint-plugin-obsidianmd 0.5.1, plus CSS, source and manifest checks) instead of scripts/scorecard-check.cjs. The old script's check for a bare window.<member> (other than timers) in src/ is gone: the kit scanner does not check it yet. The scan reads every tracked file, so the GitHub Pages site (site/, a static web page that never ships in main.js) is listed under scan.ignore; without that it reports 36 lint and 20 CSS findings in site/assets/, which the old script and the lint config skipped as well.
  • eslint.config.mjs is obsidianPlugin() from the kit, with Garmy's own ignore list, and npm run lint runs with --max-warnings=0. The eslint-plugin-obsidianmd (was 0.4.2), typescript-eslint and @eslint/js devDependencies are removed: the kit pins its own eslint-plugin-obsidianmd and typescript-eslint, and @eslint/js is no longer needed. The @typescript-eslint/no-misused-promises rule is replaced by obsidianmd/no-misused-promises.
  • The e2e harness is the kit's obsidian-plugin-dev-kit/e2e module: e2e/fixtures.ts is one createObsidianTest call and playwright.config.ts is defineObsidianConfig(). npm run e2e is npm run build && playwright test, so the specs run against the minified bundle; npm run e2e:setup and scripts/e2e-setup.sh are gone. Every test still gets its own Obsidian process, vault copy and user-data folder, now installed, trusted and waited for by the kit instead of fixed sleeps (1500 ms in win, 800 ms and 1500 ms in sync.spec.ts, two of 1500 ms in existing-notes.spec.ts). The generated e2e-vault.pristine/.obsidian/plugins/ folder and its .gitignore entry are gone: the kit installs Garmy and Dashy into the temp copy. The kit refuses a Garmy main.js older than src/; the Dashy checkout installed beside it is not checked, so a Dashy build needs no override.
  • The e2e specs use the kit's helpers: obsidian.openSettings("garmidian") (the settings spec no longer hunts for a second window), obsidian.waitForMetadataCache(), obsidian.replace() for the fake Garmin (fakeGarmin(obsidian, ...) and installDemoGarmin(obsidian, ...) return the fake's handle, and the units spec counts requests with calls()), obsidian.evaluate() in place of most of the globalThis as unknown as { app ... } casts (setKey and openWizard in e2e/fixtures.ts keep theirs), obsidian.runCommand(), obsidian.hideProperties(), obsidian.setTheme(), obsidian.clearNotices(), obsidian.readingView(), obsidian.scrollThrough() and obsidian.mobile() in the capture spec, and onlyWhen("CAPTURE") / onlyWhen("GARMIN_LIVE") in place of test.skip. Both gates now need the value 1, as npm run capture sets; GARMIN_LIVE=true no longer runs the live spec.
  • npm run typecheck also checks e2e/ through e2e/tsconfig.json.
  • The README films (film-wizard, film-rebuild, film-languages, film-library in docs/screens) are shot with the kit's demo fixture (a film of stills, film.shot({ hold })) and encoded by opdk demo (settings in opdk.config.mjs). npm run capture is build, the capture spec and opdk demo; scripts/capture.mjs is deleted, and npm run capture -- <word> is gone: npx opdk demo film-library re-encodes one film. The frames are 2x on any display (the library poster was 980 x 1000, now 1960 x 2000), the clock is frozen at 2026-11-11, the ribbon, status bar, tab headers and side panels are hidden, a retake replaces the frames instead of appending to the old ones, and a visible cursor shows where the mouse last moved. The GIFs keep 160 colours at 8 fps and their widths; the first frame is still the poster. The stills are retaken in the bullets below.
  • Releases are cut with npx opdk release patch (or minor, major, an exact X.Y.Z; --dry-run first) in place of version-sync.cjs and a hand-pushed tag. It bumps package.json, package-lock.json, manifest.json and versions.json (an existing versions.json entry is never rewritten), moves the CHANGELOG entries under the new version, commits, pushes the annotated tag (tags were lightweight before) and waits for release.yml. That workflow is the kit's reusable one, pinned to its full commit: it builds with a read-only token, attests main.js, manifest.json and styles.css, and makes a draft whose notes are the CHANGELOG section of the version (the release page showed GitHub's generated list before). opdk release then checks the draft against a local build of the tag, publishes it and only then pushes the branch. No zip is built or attached any more (npm run release:zip and make-zip.cjs are gone), and release.yml runs the unit tests in a test job before the kit's release jobs. opdk release itself runs no tests, so run npm run release:check first, which now starts with opdk release check (versions, versions.json, manifest rules, CHANGELOG section, build, byte-for-byte reproducibility, minAppVersion against the API). Do not release unpushed commits.
  • ci.yml calls the kit's plugin-ci.yml (pinned to the same commit) for lint, typecheck, unit tests, opdk scan, opdk release check, the build and the garmidian-bundle artifact, and keeps readme:check as a job of its own. Runners are ubuntu-24.04 and actions are pinned to commits (they were ubuntu-latest and major tags). The bundle artifact no longer holds a zip.
  • @playwright/test and electron are pinned to exact versions (1.65.0 and 44.10.2) as the kit documents; jsdom and vite are devDependencies for the unit tests, and obsidian-test-mocks is pinned to 8.0.0 with Dependabot ignoring its major updates.
  • vitest.config.ts is defineUnitConfig() from the kit: Garmy's own stub for the node tests, obsidian-test-mocks in jsdom for the wizard and settings tests. The coverage gate (90 percent, 80 for branches) now counts src/app/wizard.ts and src/app/settings.ts too.
  • pages.yml runs on ubuntu-24.04 and pins every action to a full commit with its version in a comment (checkout v7.0.1, setup-node v7.1.0, configure-pages v6.0.0, upload-pages-artifact v5.0.0, deploy-pages v5.0.1; the first two are the commits ci.yml and release.yml already use). The checkout no longer keeps the token (persist-credentials: false). The permissions are unchanged: contents: read for the checkout, pages: write and id-token: write for the deploy. The ci.yml bullet above says runners a...
Read more

1.1.0

Choose a tag to compare

@github-actions github-actions released this 09 Nov 18:09

Full Changelog: 1.0.1...1.1.0

1.0.1

Choose a tag to compare

@github-actions github-actions released this 06 Nov 14:08

Full Changelog: 1.0.0...1.0.1

1.0.0

Choose a tag to compare

@github-actions github-actions released this 06 Nov 13:54