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

Version Metadata Standardization #121

Closed
amydevs opened this issue Feb 6, 2024 · 1 comment · Fixed by #122
Closed

Version Metadata Standardization #121

amydevs opened this issue Feb 6, 2024 · 1 comment · Fixed by #122
Assignees
Labels
development Standard development r&d:polykey:supporting activity Supporting core activity

Comments

@amydevs
Copy link
Contributor

amydevs commented Feb 6, 2024

Specification

This issue aims to standardize the versionMetadata supplied by the agentStatus RPC call and labels stored on the generated Docker images.

This specification applies in the context of official PK-CLI only! Third-party Polykey Agent applications may choose to follow this spec, but it is not guaranteed.

The versionMetadata under the context of PK-CLI should follow these rules:

  • It should be of type { [key: string]: string }.
  • The object structure can only have string values.
  • The object structure cannot be nested.
  • Version data related to PK-CLI itself (commitHash, version) should not be prefixed.
  • Version data related to the PK library it is using should be prefixed with lib (libVersion, libCommitHash, etc).
  • Other prefixes maybe decided in the future if needed.

The reason for the specific object structure is to maintain compatibility with Docker Image Labels, as well as maintain readability and prevent unneeded nesting within the polykey agent status command.

Additional context

Previous discussion on version metadata: MatrixAI/Polykey#599

Tasks

  1. Rename non-conforming versionMetadata keys to be correct.
@amydevs amydevs added the development Standard development label Feb 6, 2024
@amydevs amydevs self-assigned this Feb 6, 2024
@CMCDragonkai
Copy link
Member

What do you think of things like desktop, mobile? Will they have their own prefixes? Or will they not bother with that? Cause they will be presenting their own version anyway.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
development Standard development r&d:polykey:supporting activity Supporting core activity
Development

Successfully merging a pull request may close this issue.

2 participants