-
-
Notifications
You must be signed in to change notification settings - Fork 540
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[5.x] Give starter kit devs an opt-in config to help make parts of their kits composer updatable #11064
Open
jesseleite
wants to merge
8
commits into
5.x
Choose a base branch
from
starter-kit-addons
base: 5.x
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jesseleite
changed the title
Allow starter kits to live on as addons via opt-in config
[5.x] Allow starter kits to live on as addons via opt-in config
Nov 6, 2024
jackmcdade
changed the title
[5.x] Allow starter kits to live on as addons via opt-in config
[5.x] Allow starter kits to be updatable with composer via opt-in config
Nov 6, 2024
Whoops, tried to rename branch with github's UI, didn't mean to close 😆 |
jesseleite
changed the title
[5.x] Allow starter kits to be updatable with composer via opt-in config
[5.x] Give starter kit devs an opt-in config to help make parts of their kits composer updatable
Nov 11, 2024
6 tasks
jesseleite
force-pushed
the
starter-kit-addons
branch
from
November 26, 2024 20:21
3341070
to
bdfce39
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Note: This PR does NOT make everything in a starter kit magically updatable; It merely adds the ABILITY for a starter kit developer to architect their kit in such a way that parts of a kit be composer updatable!
The Problem
Currently, starter kits are installed via composer, and they uninstall themselves at the end of the install process, giving full ownership of to the end user of all installed files. This is very intentional for things like simple 'theme' kits, where there's no reason for templates and styles to live on in the user's composer.json or vendor directory.
If a starter kit dev wishes to push updatable bits to users, they have to package up those updatable bits into a separate package/addon, and include in their starter kit's
dependencies
config. Again, this is also very intentional, but it now means the starter kit dev has to maintain two separate repositories for one 'kit', which complicates starter kit development.The Proposition
The idea of this PR is to allow starter kits to remain installed as living composer-updatable packages. If the kit dev intends to push updates to their users, they can simply add
updatable: true
to theirstarter-kit.yaml
config, and the starter kit repository will remain in their composer.json and vendor directory after a successful install.This allows the end user to...
composer update
for bugfixesphp please starter-kit:module-install
newly added modules (this command coming soon)And allows the starter kit dev to...
Todo