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

If neurobagel .jsonld files are not ephemeral, should they include the version of the CLI? #57

Open
surchs opened this issue Nov 6, 2023 · 1 comment
Labels
_flag:stale [BOT ONLY] Flag issue that hasn't been updated in a while and needs to be triaged again

Comments

@surchs
Copy link
Contributor

surchs commented Nov 6, 2023

We want .jsonld files to be ephemeral. But for the moment they are not, in practice. We tell people to collect them centrally and then upload them with our scripts. This implies to a user that the .jsonld files can be reused to reupload data at a later point.

One big assumption this violates is that the jsonld files will always be created with the most recent version of the CLI. And if the CLI and thus the datamodel have progressed via a breaking change since the .jsonld files were made, bad things will happen in unexpected ways.

So we should decide if we either:

  • want to build enough tooling that .jsonld files can go back to being ephemeral
  • tell people to rerun the CLI every time anyway
  • have the CLI version as part of the .jsonld and then make checks on the version to avoid unexpected bag things happening
Copy link

We want to keep our issues up to date and active. This issue hasn't seen any activity in the last 75 days.
We have applied the _flag:stale label to indicate that this issue should be reviewed again.
When you review, please reread the spec and then apply one of these three options:

  • prioritize: apply the flag:schedule label to suggest moving this issue into the backlog now
  • close: if the issue is no longer relevant, explain why (give others a chance to reply) and then close.
  • archive: sometimes an issue has important information or ideas but we won't work on it soon. In this case
    apply the someday label to show that this won't be prioritized. The stalebot will ignore issues with this
    label in the future. Use sparingly!

@github-actions github-actions bot added the _flag:stale [BOT ONLY] Flag issue that hasn't been updated in a while and needs to be triaged again label Jan 21, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
_flag:stale [BOT ONLY] Flag issue that hasn't been updated in a while and needs to be triaged again
Projects
Status: No status
Development

No branches or pull requests

1 participant