Manage development.ini and test.ini outside of source control #1727
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
…escribed in cgap-portal PR 637 (and a fix from cgap-portal PR 642).
netsettler
requested review from
aschroed,
alexkb0009,
willronchetti and
dmichaels-harvard
willronchetti
approved these changes
Sep 20, 2022
| @@ -88,6 +88,7 @@ build-after-poetry: # continuation of build after poetry install | |||
| make npm-setup-if-needed | |||
| poetry run python setup_eb.py develop | |||
| make fix-dist-info | |||
| poetry run prepare-local-dev | |||
There was a problem hiding this comment.
You might want to ensure inserts are loaded when this is run
There was a problem hiding this comment.
I'm not sure I understand why inserts are relevant to this. This is just about setting up details that need to be user-specific, like the indexing prefix. Can you elaborate on your concern?
Yes, this is a very old PR. I was surprised it was never merged, but it fortunately seems not to have gotten stale, so I'm trying to revive it.
|
Local testing results: |
|
I've also deployed this branch to |
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.
This PR is conceptually identical to cgap-portal PR 637 but with the fix already incorporated that we later ended up needing as cgap-portal PR 642.
This change is intended only to affect developers who are doing local testing (e.g.,
make testor a call topytest) that would usetest.inior who are doing local deploys (e.g.,make deploy1) that would usedevelopment.ini.This is technically a breaking change, in that it may affect developer scripts, but this should not affect production builds or GA, so we've agreed to only bump the minor version, not the major version. Nevertheless, you should report problems in production, GA, or docker management if you see them.**
Prior to this change,
development.iniandtest.iniwere in source control. This PR changes this so that what's in source control isdevelopment.ini.templateandtest.ini.template. There is a command introduced,prepare-local-devthat you can run to create adevelopment.iniandtest.ini. Once the file exists, theprepare-local-devcommand will not touch it, so you can do other edits as well without concern that they will get checked in. The primary change that this command does is to make a local environment offourfront-devlocal-<yourusername>orfourfront-test-<yourusername>so that testing and debugging that you do locally will be in an environment that does not collide with other users. You can give a--envargument toprepare-local-devto use a different name, though it's probably easier to just edit the resulting file.Note to reviewers (especially @willronchetti): The
test.inicase is a little weird because some things in that file are ignored. We might want to make it so thatconftest_settings.pysomehow pulls data from there or is consistent with there or figure out why they diverge and how to describe when to use one or the other.