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

Jump to bottom

[SR-15312] [Swift-DocC] Add 'version' command to docc command line tool #229

Closed
ethan-kusters opened this issue Oct 13, 2021 · 1 comment
Closed

[SR-15312] [Swift-DocC] Add 'version' command to docc command line tool #229

ethan-kusters opened this issue Oct 13, 2021 · 1 comment
Labels
bug Something isn't working

Comments

@ethan-kusters
Copy link
Contributor

Previous ID SR-15312
Radar rdar://58842647
Original Reporter @ethan-kusters
Type Bug
Status Closed
Resolution Invalid
Additional Detail from JIRA
Votes 1
Component/s Swift-DocC
Labels Bug, StarterBug
Assignee None
Priority Medium

md5: 765556f0235e43786ce452dab96df62e

Issue Description:

docc should output it's current version to the command line.

This could be similar to the behavior of the `swift --version` command and output the current version of `docc` along with a commit hash.
@swift-ci
Copy link

Comment by Adin Cebic (JIRA)

Hello @ethan-kusters I tried implementing "version" command and hit some opstacles and drew possible conclusion why such command was not built in the first place.

Firstly, readme.md file in swift-docc repository states following:

> Swift-DocC's CLI tool ( docc) will be integrated into the Swift toolchain and follows the Swift compiler's versioning scheme.

So what ever the current Swift version is, you can assume that it is the same for docc CLI.

Secondly, there is no obvious place to write current docc version since SPM promotes using git tags for that. In case of this CLI, no git tags are created by project maintainers.

@swift-ci swift-ci transferred this issue from apple/swift-issues Apr 25, 2022
@shahmishal shahmishal transferred this issue from apple/swift May 3, 2022
This issue was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
bug Something isn't working
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@ethan-kusters @swift-ci