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

Request: Versioned client API package #12300

Open
tsaarni opened this issue Mar 15, 2022 · 2 comments
Open

Request: Versioned client API package #12300

tsaarni opened this issue Mar 15, 2022 · 2 comments
Labels
stage/accepted Confirmed, and intend to work on. No timeline committment though. theme/api HTTP API and SDK issues theme/ci type/enhancement

Comments

@tsaarni
Copy link

tsaarni commented Mar 15, 2022

Currently Nomad release tags cover only the server module at github.com/hashicorp/nomad. The submodule containing client API github.com/hashicorp/nomad/api is not versioned, which leads to applications consuming the latest from main directly via pseudo-version. Example of this can be seen in Vault go.mod.

Problem:

  • Using pseudo-version makes it very difficult to address vulnerability alerts from scanners, since it is not clear how the pseudo-version relates to a specific Nomad release. Application using version v0.0.0-20211006193434-215bf04bc650 can be flagged with all historical vulnerabilities.
  • Application fetching latest from main could theoretically end up using non-working version that was never inteded to be consumed by public.

Proposal:

Add versioning also to github.com/hashicorp/nomad/api submodule. This can be done by adding a second release tag which is prefixed with the submodule path. v1.2.6 becomes api/v1.2.6. Tagging submodules is described in go documentation.

@DerekStrickland DerekStrickland self-assigned this Mar 16, 2022
@DerekStrickland DerekStrickland removed their assignment Mar 19, 2022
@lgfa29 lgfa29 added theme/ci stage/accepted Confirmed, and intend to work on. No timeline committment though. theme/api HTTP API and SDK issues labels Mar 23, 2022
@lgfa29
Copy link
Contributor

lgfa29 commented Mar 23, 2022

Thanks @tsaarni, this is something we talked about in the past.

@IamTheFij
Copy link
Contributor

I was just doing some digging and I found that these are actually duplicate issues: #19613

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
stage/accepted Confirmed, and intend to work on. No timeline committment though. theme/api HTTP API and SDK issues theme/ci type/enhancement
Projects
Status: Needs Roadmapping
Development

No branches or pull requests

4 participants