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] Implemented NB_FEDERATE_REMOTE_PUBLIC_NODES env var #90

Merged
merged 10 commits into from
May 29, 2024
Merged

Conversation

rmanaem
Copy link
Contributor

@rmanaem rmanaem commented May 27, 2024

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 has a label for the release changelog or skip-release (to be applied by maintainers only)
  • 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.

@rmanaem rmanaem added the pr-minor Non-breaking feature or enhancement, will increment minor version (0.+1.0) label May 27, 2024
@coveralls
Copy link
Collaborator

coveralls commented May 27, 2024

Pull Request Test Coverage Report for Build 9274359452

Warning: This coverage report may be inaccurate.

This pull request's base commit is no longer the HEAD commit of its target branch. This means it includes changes from outside the original pull request, including, potentially, unrelated coverage changes.

Details

  • 28 of 29 (96.55%) changed or added relevant lines in 2 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage decreased (-0.08%) to 96.914%

Changes Missing Coverage Covered Lines Changed/Added Lines %
tests/test_utility.py 12 13 92.31%
Totals Coverage Status
Change from base Build 9224646794: -0.08%
Covered Lines: 471
Relevant Lines: 486

💛 - Coveralls

@surchs surchs self-requested a review May 28, 2024 15:41
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 @rmanaem, this seems to do the trick. I do think we should

  • provide basic docs for this new feature. if README isn't the place, then please make a PR against the ENV var table in the main docs and link here
  • add a basic integration test to make sure the ENV var does what we think it does
  • unless I forgot, this is our first use of ENV vars in this tool. So let's add a template.env with the new variable and a short docstring explaining what it does.

edit: I may be misremembering what the default was for providing template.env files in the repos themselves. But we should document the ENV var in the main docs, and ideally also as a docker run example in the README so I can get started quick. let me know what you think

app/api/utility.py Show resolved Hide resolved
app/api/utility.py Show resolved Hide resolved
app/api/utility.py Outdated Show resolved Hide resolved
app/api/utility.py Outdated Show resolved Hide resolved
app/api/utility.py Outdated Show resolved Hide resolved
@rmanaem rmanaem changed the title Implemented NB_FEDERATE_REMOTE_PUBLIC_NODES env var [ENH] Implemented NB_FEDERATE_REMOTE_PUBLIC_NODES env var May 28, 2024
@rmanaem
Copy link
Contributor Author

rmanaem commented May 28, 2024

provide basic docs for this new feature. if README isn't the place, then please make a PR against the ENV var table in the main docs and link here

Addressing that here neurobagel/recipes#60

add a basic integration test to make sure the ENV var does what we think it does

Test has been added

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.

awesome, thanks @rmanaem. This looks good

🧑‍🍳

@rmanaem rmanaem merged commit e556014 into main May 29, 2024
5 checks passed
@rmanaem rmanaem deleted the feat-62 branch May 29, 2024 14:29
@surchs
Copy link
Contributor

surchs commented Jun 12, 2024

🚀 PR was released in v0.2.0 🚀

@surchs surchs added the released This issue/pull request has been released. label Jun 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
pr-minor Non-breaking feature or enhancement, will increment minor version (0.+1.0) released This issue/pull request has been released.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add env var to disable federating over remote public nodes
3 participants