Add install step for developers #1492
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
williamjallen
force-pushed
the
dev-install
branch
from
7d1a7f6
to
6d34e70
Compare
williamjallen
force-pushed
the
dev-install
branch
from
6d34e70
to
3b7693c
Compare
williamjallen
force-pushed
the
dev-install
branch
from
4ed8589
to
a171e8b
Compare
josephsnyder
approved these changes
Aug 17, 2023
github-merge-queue
bot
removed this pull request from the merge queue due to failed status checks
github-merge-queue
bot
removed this pull request from the merge queue due to no response for status checks
github-merge-queue bot
pushed a commit
that referenced
this pull request
Nov 22, 2023
CDash administrators must run several commands to update a CDash system. For administrators who are unfamiliar with CDash, this creates an unnecessary burden. This PR introduces a new global `cdash_install` script which runs all of the necessary installation steps. It's worth noting that Laravel's "maintenance mode" will be activated for the duration of the installation. That will prevent users from accessing the system, and will block submissions. In the future, I plan to update this script to allow submissions to be accepted while the system is in maintenance mode, but that is a significant undertaking which is beyond the scope of this PR. #1492 added a `cdash_install` script for developers to sync files between the host and Docker container. That script has been renamed `cdash_copy_source`. The new `cdash_install` script runs `cdash_copy_source` before the regular installation script is run by default when the container is build with development mode turned on.
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.
The developer experience is currently rather poor for developers using our Docker environment. Without custom patches, the only way to test new code changes is to rebuild the image and start a new container.
Given that we now have separate production and development configurations, I thought it might be helpful to upstream an installation patch I have been using locally for some time. The source code directory is mounted as a read-only volume in
/cdash_src, and thecdash_installalias runs a script which copies new code changes into the/cdashdirectory. This is particularly useful when paired with a separate terminal session runningnpm run watch-poll, which automatically compiles all of our static assets with mix whenever new changes are made.The alternative to this approach is to to simply mount
/cdashas a shared volume. The downside of mounting a shared volume to/cdashis that the volume must either be read-only, with all compilation occurring on the host side, and thus requiring the developer to havenpmandphp/composerinstalled, or to have a read-write volume with the potential for code running in the container to inadvertently overwrite the source code on the host. After accidentally writing files in the midst of my local source code several times, I found that mounting a read-only volume to/cdash_srcand then copying the code to/cdashwas the most effective way to develop CDash.I've personally found that the changes in this PR vastly improve my productivity as a CDash developer but I'm interested in any comments other developers may have regarding this matter.