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

[ENH] Update environment variables and remove deprecated version tag #65

Merged
merged 6 commits into from
Jul 12, 2024

Conversation

alyssadai
Copy link
Contributor

@alyssadai alyssadai commented Jul 12, 2024

Changes proposed in this pull request:

Checklist

This section is for the PR reviewer

  • PR has an interpretable title with a prefix ([ENH], [FIX], [REF], [TST], [CI], [MNT], [INF], [MODEL], [DOC]) (see our Contributing Guidelines for more info)
  • PR links to GitHub issue with mention Closes #XXXX
  • Tests pass
  • Checks pass

For new features:

  • Tests have been added

For bug fixes:

  • There is at least one test that would fail under the original bug conditions.

@surchs surchs self-requested a review July 12, 2024 19:14
Copy link
Contributor

@surchs surchs left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @alyssadai, looks good.
The changes that relate to auth need a clarification that auth is under active development and unless you are deploying nightly/developing yourself you can ignore them for now.

We don't want folks who are making deployments now (as e.g. workshop attendees will probably do) to get confused.

I'll still approve it, but please take a look at these comments first and then 🧑‍🍳

template.env Outdated Show resolved Hide resolved
template.env Show resolved Hide resolved
Comment on lines 22 to 24
`NB_ENABLE_AUTH` Yes Whether to enable authentication for cohort queries. One of [true, false] `true` Docker, Python
`NB_QUERY_CLIENT_ID` Yes OAuth client ID for the query tool. Required if NB_ENABLE_AUTH is set to true. - Docker, Python
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Like below, I think we should clarify here that these variables are not (yet) needed for prod deployments because auth is under active development still. Not sure how to best do that. Maybe you have a good idea?

Copy link
Contributor Author

@alyssadai alyssadai Jul 12, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How about in parentheses at the start of the description (Experimental, for dev deploments only) / (PREVIEW) ? Or something similar

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Will use (Experimental, for dev deployments only) for now :)

@alyssadai alyssadai changed the title Update environment variables and remove deprecated version tag [ENH] Update environment variables and remove deprecated version tag Jul 12, 2024
@alyssadai alyssadai merged commit e2508ab into main Jul 12, 2024
@alyssadai alyssadai deleted the update-env-vars branch July 12, 2024 20:02
@alyssadai alyssadai added pr-minor Non-breaking feature or enhancement, will increment minor version (0.+1.0) and removed pr-minor Non-breaking feature or enhancement, will increment minor version (0.+1.0) labels Aug 7, 2024
Copy link
Contributor

neurobagel-bot bot commented Aug 7, 2024

🚀 PR was released in v0.0.1 🚀

@neurobagel-bot neurobagel-bot bot added the released This issue/pull request has been released. label Aug 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
released This issue/pull request has been released.
Projects
None yet
2 participants