Make EXAMPLE presets be legitimate starting points #142
Labels
enhancement
New feature or request
passed-dev-qa
Optional state. Use this when QAing other peoples fixes in another branch.ready to be merged to main
Problem this feature will solve
Workspace EXAMPLES require hand configuration of
.gp/bash/init-project.sh
in order to work on subsequent initializations, once initial scaffolding files have been saved to the repository. EXAMPLES should be stand-alone starting points once initial scaffolding files have been saved to the repository, meaning they should not require alteration ofgitpod-laravel-starter
internal bash scripts to properly initialize.In other words:
Workspace urls successfully initialized with an EXAMPLE env variable passed in will not configure properly once initial scaffolding files have been saved to version control and a new workspace is initialized from that repository.
Background
.gp/bash/project-init.sh
handles project specific initialization routines.Proposed Solution
Ensure that examples initialize themselves from
.gp/bash/project-init.sh
rather than from it's.gp/bash/examples<init example script>.sh
file..gp/bash/examples<init example script>.sh
should really only download and untar the archive for project specfic files of that particular example.A legitimate starting point will properly initialize itself after initial project scaffolding files have been saved to the repository.
README.md
with information and any caveats in regard to using an EXAMPLE as a starting point.Constraints and Assumptions
.gp/bash/init-project.sh
file.must untar it's archive using the
--overwrite` option.starter.ini
(such asphpmyadmin
) except the front end scaffolding to use (React, Vue, Bootstrap) will be installed. Note that this may differ from the original EXAMPLE. It is up to the user to set theirstarter.ini
how they want it. In other words, an EXAMPLE will not supercedestarter.ini
once initial scaffolding files have been saved to the repository.Alternatives or Workarounds
Not recommended:
Configure a particular EXAMPLE to be persistant once initial scaffolding files are in VCS by hacking and slashing the internal bash scripts of
gitpod-laravel-starter
The text was updated successfully, but these errors were encountered: