-
Notifications
You must be signed in to change notification settings - Fork 2
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
Add info on how to run the-build for development. #118
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@becw this looks great. Thanks! One question: IIRC there is typically some work needed to update an existing site to the newest version of the build? Would that be useful to document here too? (Or am I remembering wrong and that's just for the-vagrant?)
I also added two tweaks: one just clarifying a step, and the other adding --dev
because I tested the existing and it moved the-build
from require-dev
to require
The work required to update from one version of the-build to the next totally depends on what the changes are between the versions. For the-vagrant, I include this info in the release notes, and I've started to do this in the-build as well. Basically:
I think this info is kind of fiddly, which is why I include it with release notes -- it works better when it's applied to a specific situation. Re: the change you made on how to check out the repository, I'm not sure about that -- I included the list as a short intro/overview to the doc. Running |
And, re-reading the diff of this PR, I realize that the info is a little all over the place -- I totally see why you added that info, even if I think it should be in a different place :) |
@becw yea, rereading the instructions I see that the top where I added was meant to be a summary, then the details are below. I also think I missed the |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@becw This documentation looks good to me! I hit a couple of snags going through the quick start steps for the drupal-skeleton
(see comments below) but I can reference them in that repo. This will be helpful for devs, thansk!
|
||
``` | ||
cd my-site | ||
composer require palantirnet/the-build:dev-release-2.0 --prefer-source --dev |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This worked perfectly for me. 👍
|
||
## Creating a new site for testing | ||
|
||
Follow the [Quick Start guide for palantirnet/drupal-skeleton](https://github.com/palantirnet/drupal-skeleton#quick-start). Before installing the-build in step 3, update the required version of the-build: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I ran into some composer dependency version collisions, namely: the-build
requiring drupal/coder:~8.2.12
and drupal-skeleton
requiring drupal/coder:^8.0
during the first step composer create-project
Since the-build
is a dependency requirement of drupal-skeleton
and requires drupal/coder
, I'm curious if it's necessary to have drupal/coder
also listed as a dev dependency in drupal-skeleton
?
Once I manually did composer require drupal/coder:~8.2.12
in my new site I was able to insntall the rest of the dependencies, including requiring the release-2.0
branch from the-build
See palantirnet/drupal-skeleton#82 for a PR which makes this update in drupal-skeleton
Once the project was created successfully, I did have some one other issue continuing with the drupal-skeleton
quick start steps: a 404 for the GET request to the platformsh default settings file during the-build-installer
because the repo was renamed. See #122.
Addresses #114.