Adding details about new recipes:update command #16301
Merged
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
5 tasks
gnito-org
reviewed
Dec 17, 2021
javiereguiluz
approved these changes
Dec 27, 2021
fabpot
added a commit
to symfony/flex
that referenced
this pull request
Jan 19, 2022
This PR was squashed before being merged into the 1.x branch. Discussion ---------- Merge-powered recipe update system Hi! tl;dr; Updating recipes was a pain. Now its easy: the new `recipes:update` command performs a smart "patch" to your project of what actually changed in the recipe. [](https://asciinema.org/a/456707) If you run simply `composer recipes:update`, then it will ask you what to update, from a list of only the out-dated recipes (thanks to @shadowc for the idea!): <img width="696" alt="Screen Shot 2021-12-17 at 11 18 09 AM" src="https://user-images.githubusercontent.com/121003/146575617-8ca7c6c8-1897-4fb4-be33-cdd5bf6894c0.png"> As you can see, if there are conflicts, you fix them like normal git conflicts. In addition to the unit tests, I've tried this on a fairly out-dated project and it worked *brilliantly*. This was NOT possible until @nicolas-grekas open sourced the Flex server - so a HUGE thanks 🎆 ### How It Works A) Whenever `symfony/recipes` (or contrib) has a new commit, a GitHub action *already* stores each recipe as JSON, which becomes the "recipe API": https://github.com/symfony/recipes/tree/flex/main. A change to that action (symfony/recipes#1037) and the recipes-checker (symfony-tools/recipes-checker#2) will add an "archived/" directory that contains EVERY version of every recipe. You can see an example in my fork: https://github.com/weaverryan/recipes/tree/flex/main/archived B) When you run `recipes:update <package/name>`, we fetch the "original" recipe and "new" recipe and then pass both to each "configurator". Its job is to say what files would exist and what they would look if the "original" recipe were installed now and if the "new" recipe were installed now. C) We use these "original files" and "new files" to generate a patch file. D) We apply that patch file to the user's actual project. There are a few tricks here, like temporarily inserting the git "blob" for what the "original" version of the file would look like. That allows for a 3-way merge. So, while it was a bit of work, it's a fairly straightforward process. It makes keeping your recipes up to date both easy and rewarding. ## TODOS * [x] Merge recipes-checker PR symfony-tools/recipes-checker#2 * [x] Merge symfony/recipes PR symfony/recipes#1037 * [x] Update `Downloader` in this PR to remove 2x TODOs that the above PR's will enable * [x] Make sure the `archived/` directory is populated for both `recipes` and `recipes-contrib` - see symfony-tools/recipes-checker#3 and symfony/recipes#1038 * [x] Document that this now exists symfony/symfony-docs#16301 Cheers! Commits ------- 3ee7719 Merge-powered recipe update system
wouterj
changed the title
](https://asciinema.org/a/456707){kind=link}
wouterj
force-pushed
the
recipe-update
branch
from
803ee03
to
11d87ad
Compare
|
Thanks @weaverryan! As this is about Symfony Flex, I've merged it into 4.4 instead of 5.4. |
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.
See: symfony/flex#845
The
versionaddedversion may still change if we decide to put this into the 1.x branch.