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

integrate sdkVersion with git tags #12

Open
davidalpert opened this issue Oct 4, 2022 · 4 comments
Open

integrate sdkVersion with git tags #12

davidalpert opened this issue Oct 4, 2022 · 4 comments
Labels
enhancement New feature or request
Milestone

Comments

@davidalpert
Copy link
Contributor

Proposed changes

Add a Makefile and/or github workflow to auto-update the in-code sdkVersion so that it matches the version tags.

Context

Go modules use git tags to manage dependencies and the tooling supports installing specific versions of the module/package based on git tags. This is such a strong convention that Go documentation recommends a publishing process for go modules.

It appears that the sdkVersion value in the code and the tags in the repo have drifted.

This drift means that api calls to the Deepgram API made using this code may be difficult to track and diagnose as the sdkVersion used in the calls will probably not reflect the tagged releases.

Possible Implementation

In my own Go projects I have opted for a hybrid model where I use a Makefile with a few release targets:

release-major                  release major version
release-minor                  release minor version
release-patch                  release patch version

These targets also use conventional commits to generate and update a CHANGELOG.md file packaged into the release commit.

Other information

If any or all of this would be of use I am happy to put together a pull request.

@jpvajda jpvajda added the enhancement New feature or request label Mar 8, 2023
@SandraRodgers
Copy link
Contributor

@davidalpert I know you wrote this up a long time ago. I'm working on getting this SDK to a better state and I think your recommendation would be a great improvement. Are you still interested in putting together a pull request?

@davidalpert
Copy link
Contributor Author

I missed this notification but I could maybe take a look this weekend.

@jpvajda
Copy link
Contributor

jpvajda commented Oct 27, 2023

@dvonthenen 👋 I was curious what your thoughts were on this issue?

@dvonthenen
Copy link
Contributor

dvonthenen commented Oct 27, 2023

This relies on CI making updates. Will move this over to the post-v1 release

@dvonthenen dvonthenen added this to the Go SDK Post-v1 milestone Oct 27, 2023
@dvonthenen dvonthenen modified the milestones: Go SDK v1.2, Go SDK v1.3 Feb 21, 2024
@dvonthenen dvonthenen modified the milestones: Go SDK v1.3, Go SDK v1.4 May 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

4 participants