Skip to content

refactor: move internal/pkg/version to internal/version #428

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.

Sign up for GitHub

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
mwbrooks merged 2 commits into from
Mar 23, 2026
Merged

refactor: move internal/pkg/version to internal/version #428

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c082ce3
refactor: move internal/pkg/version to internal/version
mwbrooks Mar 21, 2026
993a6f5
Merge branch 'main' into mwbrooks-refactor-internal-pkg-version
mwbrooks Mar 23, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .circleci/config.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -159,7 +159,7 @@ jobs:
- run:
name: Run GoReleaser. Without actually publishing.
command: |
LDFLAGS="-s -w -X 'github.com/slackapi/slack-cli/internal/pkg/version.Version=$BUILD_VERSION'"
LDFLAGS="-s -w -X 'github.com/slackapi/slack-cli/internal/version.Version=$BUILD_VERSION'"
make LDFLAGS="$LDFLAGS" build-snapshot
- run:
name: Show binaries are generated correctly
Expand Down
2 changes: 1 addition & 1 deletion .claude/CLAUDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -171,7 +171,7 @@ Versions use semantic versioning with git tags (format: `v*.*.*`).
Version is generated dynamically using `git describe` and injected at build time:

```bash
LDFLAGS=-X 'github.com/slackapi/slack-cli/internal/pkg/version.Version=`git describe --tags --match 'v*.*.*'`'
LDFLAGS=-X 'github.com/slackapi/slack-cli/internal/version.Version=`git describe --tags --match 'v*.*.*'`'
```

**Versioning Rules**:
Expand Down
2 changes: 1 addition & 1 deletion Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
# limitations under the License.

# Common variables
LDFLAGS=-X 'github.com/slackapi/slack-cli/internal/pkg/version.Version=`git describe --tags --match 'v*.*.*'`'
LDFLAGS=-X 'github.com/slackapi/slack-cli/internal/version.Version=`git describe --tags --match 'v*.*.*'`'
BUILD_VERSION = `git describe --tags --match 'v*.*.*' | sed 's/v//'`
RELEASE_VERSION := $(shell git describe --tags --match 'v*.*.*')
testdir ?= ...
Expand Down
2 changes: 1 addition & 1 deletion cmd/doctor/check.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,12 +26,12 @@ import (
"github.com/slackapi/slack-cli/internal/config"
"github.com/slackapi/slack-cli/internal/deputil"
"github.com/slackapi/slack-cli/internal/iostreams"
"github.com/slackapi/slack-cli/internal/pkg/version"
"github.com/slackapi/slack-cli/internal/shared"
"github.com/slackapi/slack-cli/internal/shared/types"
"github.com/slackapi/slack-cli/internal/slackerror"
"github.com/slackapi/slack-cli/internal/style"
"github.com/slackapi/slack-cli/internal/update"
"github.com/slackapi/slack-cli/internal/version"
Comment on lines -29 to +34
Copy link
Member

@zimeg zimeg Mar 21, 2026

Choose a reason for hiding this comment

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

🔭 praise: This is a nice diff to find!

"golang.org/x/text/cases"
"golang.org/x/text/language"
)
Expand Down
2 changes: 1 addition & 1 deletion cmd/doctor/check_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,12 +23,12 @@ import (
"github.com/slackapi/slack-cli/internal/config"
"github.com/slackapi/slack-cli/internal/deputil"
"github.com/slackapi/slack-cli/internal/hooks"
"github.com/slackapi/slack-cli/internal/pkg/version"
"github.com/slackapi/slack-cli/internal/shared"
"github.com/slackapi/slack-cli/internal/shared/types"
"github.com/slackapi/slack-cli/internal/slackcontext"
"github.com/slackapi/slack-cli/internal/slackdeps"
"github.com/slackapi/slack-cli/internal/slackerror"
"github.com/slackapi/slack-cli/internal/version"
"github.com/slackapi/slack-cli/test/slackmock"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/mock"
Expand Down
2 changes: 1 addition & 1 deletion cmd/doctor/doctor_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,12 +24,12 @@ import (
"github.com/slackapi/slack-cli/internal/config"
"github.com/slackapi/slack-cli/internal/deputil"
"github.com/slackapi/slack-cli/internal/hooks"
"github.com/slackapi/slack-cli/internal/pkg/version"
"github.com/slackapi/slack-cli/internal/shared"
"github.com/slackapi/slack-cli/internal/shared/types"
"github.com/slackapi/slack-cli/internal/slackcontext"
"github.com/slackapi/slack-cli/internal/slackdeps"
"github.com/slackapi/slack-cli/internal/slackerror"
"github.com/slackapi/slack-cli/internal/version"
"github.com/slackapi/slack-cli/test/slackmock"
"github.com/slackapi/slack-cli/test/testutil"
"github.com/stretchr/testify/assert"
Expand Down
2 changes: 1 addition & 1 deletion cmd/root.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,12 +46,12 @@ import (
"github.com/slackapi/slack-cli/internal/cmdutil"
"github.com/slackapi/slack-cli/internal/experiment"
"github.com/slackapi/slack-cli/internal/iostreams"
"github.com/slackapi/slack-cli/internal/pkg/version"
"github.com/slackapi/slack-cli/internal/shared"
"github.com/slackapi/slack-cli/internal/slackcontext"
"github.com/slackapi/slack-cli/internal/slackerror"
"github.com/slackapi/slack-cli/internal/style"
"github.com/slackapi/slack-cli/internal/update"
"github.com/slackapi/slack-cli/internal/version"
"github.com/spf13/cobra"
"github.com/spf13/pflag"
)
Expand Down
2 changes: 1 addition & 1 deletion cmd/upgrade/upgrade.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,10 @@ import (
"fmt"
"strings"

"github.com/slackapi/slack-cli/internal/pkg/version"
"github.com/slackapi/slack-cli/internal/shared"
"github.com/slackapi/slack-cli/internal/style"
"github.com/slackapi/slack-cli/internal/update"
"github.com/slackapi/slack-cli/internal/version"
"github.com/spf13/cobra"
)

Expand Down
2 changes: 1 addition & 1 deletion cmd/version/version.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,9 @@ import (

"github.com/opentracing/opentracing-go"
"github.com/slackapi/slack-cli/internal/cmdutil"
"github.com/slackapi/slack-cli/internal/pkg/version"
"github.com/slackapi/slack-cli/internal/shared"
"github.com/slackapi/slack-cli/internal/style"
"github.com/slackapi/slack-cli/internal/version"
"github.com/spf13/cobra"
)

Expand Down
2 changes: 1 addition & 1 deletion internal/config/dotenv.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ import (
"strings"

"github.com/joho/godotenv"
"github.com/slackapi/slack-cli/internal/pkg/version"
"github.com/slackapi/slack-cli/internal/version"
"github.com/spf13/afero"
)

Expand Down
2 changes: 1 addition & 1 deletion internal/pkg/auth/login.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,12 +25,12 @@ import (
"github.com/slackapi/slack-cli/internal/auth"
"github.com/slackapi/slack-cli/internal/config"
"github.com/slackapi/slack-cli/internal/iostreams"
"github.com/slackapi/slack-cli/internal/pkg/version"
"github.com/slackapi/slack-cli/internal/shared"
"github.com/slackapi/slack-cli/internal/shared/types"
"github.com/slackapi/slack-cli/internal/slackerror"
"github.com/slackapi/slack-cli/internal/slacktrace"
"github.com/slackapi/slack-cli/internal/style"
"github.com/slackapi/slack-cli/internal/version"
"golang.org/x/mod/semver"
)

Expand Down
3 changes: 1 addition & 2 deletions internal/shared/clients.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,8 +95,7 @@ func NewClientFactory(options ...func(*ClientFactory)) *ClientFactory {
// TODO: Temporary hack to get around circular dependency in internal/api/client.go since that imports version
Copy link
Member Author

@mwbrooks mwbrooks Mar 21, 2026

Choose a reason for hiding this comment

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

thought: I did a little research and I believe this TODO is was solved by our slackcontext.Version(ctx) improvements.

I don't want to remove this comment in this PR, because it's out-of-scope, but I'll start to work on a follow-up PR that removes this comment and potentially some other cleanup related to this.

Copy link
Member

@zimeg zimeg Mar 21, 2026

Choose a reason for hiding this comment

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

@mwbrooks Do be warned - The versions expected for login methods upstream can be reliant on something related to version prefixes... 👻

I'm optimistic from the slackcontext enhancements as well but wanted to share prior edge known.

Copy link
Member Author

@mwbrooks mwbrooks Mar 23, 2026

Choose a reason for hiding this comment

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

🧠 Oh yes, that's a good point! I've put together PR #429 and I'll circle back to test the login. I could definitely use your help on thinking about edge-cases in it.

// Follows pattern demonstrated by the GitHub CLI here https://github.com/cli/cli/blob/5a46c1cab601a3394caa8de85adb14f909b811e9/pkg/cmd/factory/default.go#L29
// Used by the APIClient for its userAgent
// Currently needed because trying to get the version of the CLI from pkg/version/version.go would cause a circular dependency
// We can get rid of this once we refactor the code relationship between pkg/ and internal/
// Currently needed because trying to get the version of the CLI from internal/version would cause a circular dependency
// userAgent can get Slack CLI version from context which is defined in main.go, this approach bypass circular dependency. The clients.CLIVersion is retained for future code refactor purpose and serve SetVersion function
clients.CLIVersion = ""

Expand Down
0 internal/pkg/version/version.go → internal/version/version.go
View file
Open in desktop
Copy link
Member Author

@mwbrooks mwbrooks Mar 21, 2026

Choose a reason for hiding this comment

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

farewell: So long and thanks for all the fish pkg 🐬

File renamed without changes.
0 internal/pkg/version/version_test.go → internal/version/version_test.go
View file
Open in desktop
File renamed without changes.
2 changes: 1 addition & 1 deletion main.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,10 +26,10 @@ import (
"github.com/slackapi/slack-cli/internal/goutils"
"github.com/slackapi/slack-cli/internal/iostreams"
"github.com/slackapi/slack-cli/internal/ioutils"
"github.com/slackapi/slack-cli/internal/pkg/version"
"github.com/slackapi/slack-cli/internal/shared"
"github.com/slackapi/slack-cli/internal/slackcontext"
"github.com/slackapi/slack-cli/internal/tracer"
"github.com/slackapi/slack-cli/internal/version"
"github.com/uber/jaeger-client-go"
)

Expand Down
Loading