← Back to issue list

docs(extensions): document migrate.sh in the app directory

View original Github issue

Metadata

Project
rockcraft
Number
#1372
Type
pull request
State
closed
Author
alithethird
Labels
documentation
Created
Updated
Closed

Current evaluation

Merged via commit 7e8c51a8, documenting app/migrate.sh, clarifying the application directory location, and removing an inaccurate release note.

Resolution: closed resolved

Reason: The documentation-only PR was merged as commit 7e8c51a8. The resulting docs explain migration behavior and no extension-code changes were required.

Evaluated by: mr-cal-bot

No scores available.

Issue body

This is a **documentation-only** change. It documents that a ``migrate.sh`` script placed in the Express application directory (the directory containing ``package.json``) is copied into the rock's ``/app`` directory along with the rest of the application, and run by the 12-factor charm before the application starts. The ``expressjs-framework/assets`` extension code, its unit tests, the profile template comments and the spread test changes have been reverted, because no extension code is required for this behaviour. Changes: - Add a "Database migration" section to the Express framework reference page. - Note the ``app`` directory location in the 12-factor how-to. - Remove the inaccurate migrate release note entry. --- - [x] I've followed the [contribution guidelines](https://github.com/canonical/rockcraft/blob/main/CONTRIBUTING.md). - [ ] I've signed the [CLA](http://www.ubuntu.com/legal/contributors/). - [x] I've successfully run `make lint && make test`. - [x] I've added or updated any relevant documentation. - [x] In documents I changed, I [added a meta description](https://canonical-starflow.readthedocs-hosted.com/how-to/add-a-page-meta-description/) if one was missing. - [x] I've updated the relevant release notes.

Evaluation history

Date Model Scores Action Summary
stealth/space-bunny-alpha — closed resolved Merged via commit 7e8c51a8, documenting app/migrate.sh, clarifying the application directory location, and removing an inaccurate release note.
stealth/space-bunny-alpha — closed resolved Docs-only PR #1372 merged: added a 'Database migration' section to the Express framework reference and a note on the app directory in the 12-factor how-to; extension code/tests were dropped as unnecessary.
stealth/space-bunny-alpha — closed resolved Merged in #1372: documentation now explains that app/migrate.sh is copied to /app and run before Express starts; the 12-factor guide clarifies the app location, and an inaccurate release note was removed.
stealth/space-bunny-alpha — closed resolved Merged PR #2043: documented Express database migration via migrate.sh, clarified its app-directory location, and removed the inaccurate release note.
stealth/space-bunny-alpha
Impact: 25
Quick Win: 13
Complexity: 22
Confidence: 58
Actionability: 65
needs review Docs-only: adds a 'Database migration' section to the Express reference page noting migrate.sh in the app dir is copied to /app, notes the app dir in the 12-factor how-to, and drops an inaccurate release note. All CI green, 3 approvals, 4 unresolved review comments.
stealth/space-bunny-alpha
Impact: 24
Quick Win: 22
Complexity: 8
Confidence: 97
Actionability: 98
needs review Documents Express migrate.sh behavior and its app-directory location, and removes an inaccurate release-note entry. Approved by two reviewers with all CI checks passing.
qwen/qwen3.6-35b-a3b
Impact: 55
Quick Win: 23
Complexity: 35
Confidence: 70
Actionability: 65
needs review Adds migrate.sh support for expressjs framework following spring-boot/go patterns. Includes documentation and allows users to override migration files via stage key. 285/-9 lines across 7 files, CI mostly passing, awaiting review.

Update history

Date Change
closed
updated
updated
updated
updated
updated
updated
updated
updated
updated
updated
updated
updated
updated
updated
updated
updated
updated
updated
updated
created

Related issues

Issue Project State Summary Similarity
#5476 docs: migrate 'releasing your app' snapcraft merged Merged PR #5476 migrated the “releasing your app” documentation into the current docs structure, updating five files (+56/-12).
75%
#5454 docs: migrate 'Extensions' snapcraft merged Merged in commit b39cece, migrating the Extensions documentation with 89 lines across six files. All CI checks passed.
71%