Expose svu functionality as a library and internal refactoring #126
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
685eb50 to
efbd576
Compare
|
Hi, I have resolved the conflicts and checked that PR #125 works as expected. During testing I found out that there's a bug in #125 or that the README.md is incorrect:
But I got different result from both the code in the main branch and with my changes applied: $ go install github.com/caarlos0/svu@main
go: downloading github.com/caarlos0/svu v1.11.1-0.20230912125155-881d9c3a6e5d
$ svu --version
svu version dev
module version: v1.11.1-0.20230912125155-881d9c3a6e5d, checksum: h1:g7aZc5Zh0HxpTKRVbJvl2o7aFI0ZSt7Gcybw3T4rhRY=
$ git tag
v1.2.3-alpha.2+123
$ git log
commit 579ce447d1589ba0bd37cfaa30ca14f4067a3690 (HEAD -> main, tag: v1.2.3-alpha.2+123)
Author: Adrian Haasler García <dev@ahaasler.com>
Date: Tue Sep 12 20:54:44 2023 +0200
feat: add a
$ svu current
v1.2.3-alpha.2+123
$ svu prerelease
v1.2.3-alpha.3
$ svu prerelease --pre-release alpha.33 --build 243
v1.2.3-alpha.34+243
$ ~/workspace/svu/svu current
v1.2.3-alpha.2+123
$ ~/workspace/svu/svu prerelease
v1.2.3-alpha.3
$ ~/workspace/svu/svu prerelease --pre-release alpha.33 --build 243
v1.2.3-alpha.34+243Notice the |
|
hmm, looks like a bug indeed @bradleyjones do you want to take a look? |
|
Fix for that issue here #134 |
efbd576 to
42a78d8
Compare
|
Hi, I have resolved the conflicts to include #134. |
|
awesome, thank you! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR addresses the need to use
svuas a go library directly in code (partially addresses #123) and introduces internal refactoring for maintainability.I've exposed the public API in
pkg/svu, allowing developers to usesvuas an import name directly in their code asgithub.com/caarlos0/svu/pkg/svu.The exposed API uses a variadic options pattern, which mitigates the risk of future interface breaking changes. This approach ensures easy maintenance through adapter functions and flexibility for
internal/svuto implement changes and new features without being restricted with the API contract.I had to move some functionality from the main package to
internal/svu. This does introduce a dependency oninternal/gitininternal/svuthat can be resolved if needed, maybe moving that code topkg/svuinstead?I've defined constants with command names and tag-mode options to prevent mismatches. However, this change has not been extended to the CLI yet, just in case it's not desired.
Open PR Conflict:
I've noticed an open PR (#125) that conflicts with these changes. I'm open to adapting my code to resolve any conflicts that may arise once that PR is merged. Alternatively, I'm willing to assist in adapting the code in #125 to ensure a smoother merge process if this PR is merged before.
I welcome any input, adjustments, or recommendations from both the community and maintainers to improve this solution and maximize its usefulness for
svuusers.