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

Inconsistent use of GitHub releases #1110

Open
1 task done
horzadome opened this issue Oct 3, 2024 · 3 comments
Open
1 task done

Inconsistent use of GitHub releases #1110

horzadome opened this issue Oct 3, 2024 · 3 comments
Labels
bug Something isn't working

Comments

@horzadome
Copy link

horzadome commented Oct 3, 2024

Steps To Reproduce

Hit Github API with a request for latest version of CLI as documented in Bitwarden docs.
We get redirected to the latest napi release instead of CLI release:

❯ curl -s https://api.github.com/repos/bitwarden/sdk/releases/latest | jq -r '.tag_name' | sed 's/bws-v//'
napi-v1.0.0

Expected Result

Redirect to the latest CLI release

Actual Result

Redirect to latest release, which is currently a release of napi which does not contain CLI assets

Additional Context

GitHub releases are supposed to be used in a very specific way - with semantic version as the top level (release name) and various released components as its assets.
That way permalinks like /latest and /tag/xyz have the expected behavior.
At the moment SDK Repo is publishing multiple components (napi, python, cli) under the same release, so Github APIs are pretty much useless for integrations.
Perfect example of the problem is in Bitwarden's docs https://bitwarden.com/help/gitlab-integration/
If we take GitHub API request for /latest version of CLI from those docs, all of our integrations break as soon as napi or Python SDK is published because that's the latest and doesn't contain CLI.

One way to fix this is to separate napi, cli and python sdk in separate repos so they can all have individual release streams.
Another way is to version them together and always release them all as assets of each version.

Operating System

Windows, macOS, Linux

Operating System Version

No response

Build Version

1.0

Issue Tracking Info

  • I understand that work is tracked outside of Github. A PR will be linked to this issue should one be opened to address it, but Bitwarden doesn't use fields like "assigned", "milestone", or "project" to track progress.
@horzadome horzadome added the bug Something isn't working label Oct 3, 2024
@chelyabinsk
Copy link

chelyabinsk commented Oct 5, 2024

Related to my issue

@returntrip
Copy link

@bransondarnell
Copy link

bransondarnell commented Oct 14, 2024

@horzadome
I had the same thing happen... i modified to this...

curl -s https://api.github.com/repos/bitwarden/sdk/tags | jq -r '[.[] | select(.name | startswith("bws-v"))][0].name' | sed 's/bws-v//'

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

4 participants