Skip to content
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

Document how to define a custom environment, eg. for CI #79

Open
1 task
roborourke opened this issue Oct 24, 2019 · 0 comments
Open
1 task

Document how to define a custom environment, eg. for CI #79

roborourke opened this issue Oct 24, 2019 · 0 comments
Labels
could have Could be done, or nice to have, low priority for now good first issue Good for newcomers

Comments

@roborourke
Copy link
Contributor

roborourke commented Oct 24, 2019

The configuration defaults are currently tailored to our stack and the local environments and doesn't properly account for cases where a custom environment and set of overrides would be needed, for instance on CircleCI.

It's possible to define the constant HM_ENV_TYPE and use that value in the config environments section so we should document how to do that.

Props to @Nikschavan for raising this.


Acceptance criteria:

  • Add a section to the configuration.md doc in the getting started guides titled "Defining a custom environment"
    • Explain the use cases eg. changing config for a CI environment
    • Add an example of defining HM_ENV_TYPE in the .config/load.php if any CircleCI or Travis CI environment variables are found
    • Show an example config using this custom environment to turn off certain features
@rmccue rmccue added the could have Could be done, or nice to have, low priority for now label Feb 4, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
could have Could be done, or nice to have, low priority for now good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

4 participants