Skip to content

Update _app\version.json with version of template#926

Merged
chrisvire merged 1 commit into
sillsdev:mainfrom
chrisvire:feature/pwa-release
Jan 14, 2026
Merged

Update _app\version.json with version of template#926
chrisvire merged 1 commit into
sillsdev:mainfrom
chrisvire:feature/pwa-release

Conversation

@chrisvire
Copy link
Copy Markdown
Member

@chrisvire chrisvire commented Jan 14, 2026

Summary by CodeRabbit

  • New Features

    • App now exposes build/version metadata including a timestamp for each build.
  • Documentation

    • Added a “Release” section explaining how to determine the PWA version and the steps to create a new release.
  • Chores

    • Bumped package version to 13.3.2.

✏️ Tip: You can customize this high-level summary in your review settings.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Jan 14, 2026

Warning

Rate limit exceeded

@chrisvire has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 22 minutes and 12 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between be18d89 and 60b1fc9.

⛔ Files ignored due to path filters (1)
  • package-lock.json is excluded by !**/package-lock.json
📒 Files selected for processing (3)
  • README.md
  • package.json
  • svelte.config.js
📝 Walkthrough

Walkthrough

Adds a Release section to README, bumps package.json version to 13.3.2, and injects a composite build version (package version + timestamp) into SvelteKit config via svelte.config.js.

Changes

Cohort / File(s) Summary
Release documentation
README.md
Adds a new "Release" section explaining how to determine the PWA version from _app/version.json, how AppBuilders tracks versions, and release steps (update package.json version, merge to main, tag main with v{version}).
Package metadata
package.json
Version updated from 0.0.1 to 13.3.2. No other script or behavioral changes in this diff.
Build configuration
svelte.config.js
Imports readFileSync to read package.json, defines templateVersion and buildTimestamp, and adds config.kit.version.name set to ${templateVersion}-${buildTimestamp}. No other control-flow changes.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Poem

🐰 I nibbled the changelog, found a version so spry,
Thirteen point three two with a timestamp nearby.
I hopped through the build to tuck names in the kit,
Tagged and documented—now release time is lit!

🚥 Pre-merge checks | ✅ 2 | ❌ 1
❌ Failed checks (1 warning)
Check name Status Explanation Resolution
Title check ⚠️ Warning The title mentions updating '_app\version.json' but the actual changes involve updating README with release instructions, bumping package.json version, and modifying svelte.config.js to read version metadata—not directly updating the version.json file itself. Consider a more accurate title such as 'Add release documentation and version tracking to SvelteKit config' or 'Update version tracking in package.json and SvelteKit config'.
✅ Passed checks (2 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@chrisvire chrisvire force-pushed the feature/pwa-release branch from 6728654 to be18d89 Compare January 14, 2026 19:05
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 2

🤖 Fix all issues with AI agents
In `@package.json`:
- Around line 25-26: The package.json "release" script currently points to a
non-existent ./release.sh which will cause npm run release to fail; either add a
new executable release.sh to the repo (make it POSIX-compatible, executable, and
implement the release steps) and keep "release": "./release.sh", or change
package.json to call a cross-platform Node script or an npm-script-based series
of commands (e.g., create a "scripts/release.js" entrypoint or use tools like
cross-env or node ./scripts/release.js) and update "release" to reference that;
also ensure the "release:help" entry remains accurate and that any
shell-specific commands are replaced with cross-platform equivalents to support
Windows.

In `@README.md`:
- Line 80: Fix the typographical spacing error in the README by inserting a
space between "_app/version.json" and "AppBuilders" so the sentence reads
"_app/version.json. AppBuilders includes..." (find and replace the wrong token
"_app/version.json.AppBuilders" or adjust the sentence around the
`version`/`_app/version.json` reference).
📜 Review details

Configuration used: defaults

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 6c91cca and 6728654.

⛔ Files ignored due to path filters (1)
  • package-lock.json is excluded by !**/package-lock.json
📒 Files selected for processing (3)
  • README.md
  • package.json
  • svelte.config.js
🧰 Additional context used
🧠 Learnings (1)
📚 Learning: 2025-06-16T18:49:02.188Z
Learnt from: judah-sotomayor
Repo: sillsdev/appbuilder-pwa PR: 840
File: src/lib/components/NoteDialog.svelte:94-95
Timestamp: 2025-06-16T18:49:02.188Z
Learning: The appbuilder-pwa project uses Svelte 5, as evidenced by "svelte": "^5" in package.json and the use of Svelte 5 runes syntax like $props() and $derived(). In Svelte 5, onclick is the preferred event handler syntax over on:click.

Applied to files:

  • package.json
🔇 Additional comments (4)
svelte.config.js (2)

1-8: LGTM - Version extraction logic is sound.

Reading package.json synchronously at config load time is appropriate for build-time configuration. The approach establishes package.json as the single source of truth for versioning.


33-35: The kit.version configuration is correct for SvelteKit 2.x.

The composite version string will be written to _app/version.json at build time (served path). The deterministic format (${templateVersion}-${buildTimestamp}) is suitable and ensures consistent versioning.

package.json (1)

3-3: Version bump aligns with release workflow.

The version bump to 13.3.2 aligns with the documented release workflow where package.json serves as the source of truth for the template version used by svelte.config.js.

README.md (1)

78-84: Release documentation is clear and helpful.

The release section provides useful guidance for maintainers. The workflow aligns with the changes in package.json and svelte.config.js.

✏️ Tip: You can disable this entire section by setting review_details to false in your review settings.

Comment thread package.json Outdated
Comment thread README.md Outdated

### Release

The version of the PWA can be read from the property `version` from the file `_app/version.json`.AppBuilders includes the latest tagged version of the repo. Before making a new release with the AppBuilders, do the following:
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Fix typographical error.

There's a missing space between "version.json" and "AppBuilders":

_app/version.json.AppBuilders includes_app/version.json. AppBuilders includes

📝 Suggested fix
-The version of the PWA can be read from the property `version` from the file `_app/version.json`.AppBuilders includes the latest tagged version of the repo. Before making a new release with the AppBuilders, do the following:
+The version of the PWA can be read from the property `version` from the file `_app/version.json`. AppBuilders includes the latest tagged version of the repo. Before making a new release with the AppBuilders, do the following:
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
The version of the PWA can be read from the property `version` from the file `_app/version.json`.AppBuilders includes the latest tagged version of the repo. Before making a new release with the AppBuilders, do the following:
The version of the PWA can be read from the property `version` from the file `_app/version.json`. AppBuilders includes the latest tagged version of the repo. Before making a new release with the AppBuilders, do the following:
🤖 Prompt for AI Agents
In `@README.md` at line 80, Fix the typographical spacing error in the README by
inserting a space between "_app/version.json" and "AppBuilders" so the sentence
reads "_app/version.json. AppBuilders includes..." (find and replace the wrong
token "_app/version.json.AppBuilders" or adjust the sentence around the
`version`/`_app/version.json` reference).

@chrisvire chrisvire force-pushed the feature/pwa-release branch from be18d89 to 18baa63 Compare January 14, 2026 19:08
@chrisvire chrisvire force-pushed the feature/pwa-release branch from 18baa63 to 60b1fc9 Compare January 14, 2026 19:10
@chrisvire chrisvire merged commit d4fa563 into sillsdev:main Jan 14, 2026
3 checks passed
@chrisvire chrisvire deleted the feature/pwa-release branch January 14, 2026 19:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant