Statamic Starter Kit Releases Guide
Unveil the secrets of creating a new version/release for a Starter Kit. Let's use the Resume App as our shining example.
Glimpse into the Process
- The
resume
project represents the live version of the Starter Kit. - The
resumeapp
project is used by developers. They make changes here and then publish/release those changes to theresume
project.
Release Process
- Merge all changes with the
main
branch inresumeapp
. - Give the project a thorough check-up; make sure everything's spick and span.
- Hit
npm run build
. - Got both
resume
andresumeapp
repositories cloned? Perfect! - Run this beauty:
php please starter-kit:export ../resume
. Watch as it exports build files fromresumeapp
toresume
repository. - Open the
resume
project to review the new changes. Discard any unnecessary files as needed. - Pick a fancy version number, like
1.5
, and forge a new branch in theresume
project (e.g.,git switch -c 1.5
). Commit, push, and show off your shiny new branch. - Create a Pull Request (PR) for the new branch (e.g., 1.5).
- Review the PR and address any feedback or issues.
- Merge that PR into the
resume
project'smain
branch. - Get latest changes with a
git pull
in themain
branch. - Navigate to the Releases section, and click on "Draft new Release."
- Tag it (e.g.,
v1.5
), lock down theTarget
to the newest commit, and title it with your version number (e.g.,v1.5
). - Format the release description using the following template:
This release adds support for Statamic v4
### What's New
- Added LuckySEO for simple SEO Management
### What's Improved
- Updated dependencies
### What's Changed
- Removed old Antlers Config file
- Click "Publish Release" to finalize the new release.
- Voila! Your release is now live, kicking, and ready to rumble.