Skip to content

Modify user-agent header to ensure current gophercloud version is provided #2519

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

Merged
merged 1 commit into from
Jan 27, 2023
Merged

Conversation

UmBsublime
Copy link
Contributor

@UmBsublime UmBsublime commented Nov 29, 2022

Fixes #2511

In addition to this change a new github action will be required to ensure there is no version drift.
This version should stay in-line with the current release of gophercloud

Copy link

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for submitting your first PR! Be sure that we will be looking at it but keep in mind
this sometimes takes a while.
Please let the maintainers know if your PR has not got enough attention after a few days.
If any doubt, please consult our PR tutorial.

@coveralls
Copy link

coveralls commented Nov 29, 2022

Coverage Status

Coverage: 80.086%. Remained the same when pulling c5f62f9 on UmBsublime:dev/version into 15a9feb on gophercloud:master.

@pierreprinetti
Copy link
Member

Unless you have reasons to be more specific, I would propose to only mention the major version number: "gophercloud/v1". The maintenance burden would then be much lower.
I also suggest the v prefix so that once we hit v2 it's going to be different from the 2.0.0 we've used so far.

@UmBsublime
Copy link
Contributor Author

@pierreprinetti That would for sure be suitable. If you prefer this approach I will adapt accordingly.

My logic for wanting the exact version comes from an operator perspective.
Having the specific version helps specifically with this point.

  • Identify clients using known "bugged" version of any SDK (has happened with other SDKs in the past)

Other than that it's simply for statistics (and personal curiosity about how often people update).

@UmBsublime
Copy link
Contributor Author

Latest test failures appear to be related to a hiccup on CI apt mirrors. Not sure how to re-trigger them

E: Failed to fetch http://azure.archive.ubuntu.com/ubuntu/pool/main/e/edk2/qemu-efi-arm_0~20191122.bd85bf54-2ubuntu3.3_all.deb  404  Not Found [IP: 52.147.219.192 80

@UmBsublime
Copy link
Contributor Author

@pierreprinetti any blockers with this PR or are we simply awaiting next release for merge ?

@pierreprinetti
Copy link
Member

@mandre
What if we merge this, and add instructions in a release process document? I am working on it right now.

@UmBsublime
Copy link
Contributor Author

Hi @pierreprinetti,

I see this PR missed the v1.1.1 release and also that v1.2.0 is coming up.

Would it be possible to include this in the 1.2.0 release or does it need it's own patch release?

@pierreprinetti pierreprinetti mentioned this pull request Jan 27, 2023
@pierreprinetti
Copy link
Member

pierreprinetti commented Jan 27, 2023

@UmBsublime
I am proposing to add "bump the user-agent" in our new release document. It would then be part of the release process, and we could build some muscle memory around that. I have added (a slightly modified version of) this commit to the v1.2.0 preparation PR. Let's see what the other maintainers think.

I have modified your PR so that:

  • the version string in the user-agent is the full thing, x.y.z. I am aware that I was the guy telling you to only put v1; however I figured that now with a proper release doc we might manage
  • we can bump the version string in one single place. The tests will just pick that up.

Thank you!

@pierreprinetti pierreprinetti self-assigned this Jan 27, 2023
@pierreprinetti pierreprinetti added this to the v1.2.0 milestone Jan 27, 2023
@pierreprinetti pierreprinetti merged commit 3763b92 into gophercloud:master Jan 27, 2023
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

Successfully merging this pull request may close these issues.

Should the user-agent always contain gophercloud/2.0.0
3 participants