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

Single canonical parseable location for the version #90

Open
confluence opened this issue Oct 18, 2023 · 0 comments
Open

Single canonical parseable location for the version #90

confluence opened this issue Oct 18, 2023 · 0 comments
Assignees

Comments

@confluence
Copy link
Collaborator

There should be a single location in the repository where the current version is stored, and this information should be parsed and used in these places instead of a separate hardcoded value:

  • the documentation index
  • the documentation changelog
  • the frontend
  • the backend

Currently the primary location for this value is the documentation changelog, but it's embedded in a markdown table and not easily parseable. I think that what we need is a separate machine-readable changelog file.

Bumping the protobuf submodule in the backend or frontend should be sufficient to update the ICD version in those repos.

This will eliminate a lot of annoyance involved in keeping the values in all these locations in sync.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant