Always use production config.json in index-resources GH Action #983
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
Add reminder to also update revision number in `env/testing/config.json`
Ensures that the index-resource workflow always uses the production config as our Heroku apps default to NODE_ENV=production.¹ ¹ <https://docs.nextstrain.org/projects/nextstrain-dot-org/en/latest/infrastructure.html#environment-or-config-variables>
nextstrain-bot
temporarily deployed
to
nextstrain-s-production-wydqbw
| @@ -22,7 +22,8 @@ The nextstrain.org testing & production configs currently set this to | |||
| ``s3://nextstrain-inventories/resources/v<revision_number>.json.gz``. | |||
|
|
|||
| If you make any updates that changes the structure or the contents of the resource | |||
| index JSON, then bump the ``<revision_number>`` within the configs (``env/production/config.json``) | |||
| index JSON, then bump the ``<revision_number>`` within the configs | |||
| (``env/testing/config.json`` and ``env/production/config.json``) | |||
There was a problem hiding this comment.
Is there a situation where the <revision_number> should differ in these files?
There was a problem hiding this comment.
Hmm, env/testing/config.json is only used for local testing right now so I don't think so?
(Maybe if we ever set up a completely separate testing instance on AWS there would be reason for them to differ?)
There was a problem hiding this comment.
Ok - in this case I continue to think that we should add a check in CI that they are the same. Otherwise it's too easy to overlook the docs, get things working locally, and then overwrite the production version.
There was a problem hiding this comment.
Good suggestion! I added in 9d45dd0
Based on feedback from @jameshadfield <#983 (comment)> Ensure that the testing and production configs have matching RESOURCE_INDEX so that we don't accidentally upload an expected resource index version.
victorlin
approved these changes
Aug 14, 2024
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.
Description of proposed changes
Ensures that the index-resource workflow always uses the production config as our Heroku apps default to NODE_ENV=production.¹
¹ https://docs.nextstrain.org/projects/nextstrain-dot-org/en/latest/infrastructure.html#environment-or-config-variables
Related issue(s)
Resolves #980
Checklist