-
Notifications
You must be signed in to change notification settings - Fork 6k
Add a new cli command to output version information (2nd attempt) #3892 #3899
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
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
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
45 changes: 45 additions & 0 deletions
45
modules/swagger-codegen-cli/src/main/java/io/swagger/codegen/cmd/Version.java
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,45 @@ | ||
| package io.swagger.codegen.cmd; | ||
|
|
||
| import java.io.IOException; | ||
| import java.io.InputStream; | ||
| import java.util.Properties; | ||
|
|
||
| import io.airlift.airline.Command; | ||
| import org.slf4j.Logger; | ||
| import org.slf4j.LoggerFactory; | ||
|
|
||
| @Command(name = "version", description = "Show version information") | ||
| public class Version implements Runnable { | ||
|
|
||
| private static final Logger LOGGER = LoggerFactory.getLogger(Meta.class); | ||
|
|
||
| private static final String VERSION_PLACEHOLDER = "${project.version}"; | ||
|
|
||
| private static final String UNREADABLE_VERSION = "unreadable"; | ||
| private static final String UNSET_VERSION = "unset"; | ||
| private static final String UNKNOWN_VERSION = "unknown"; | ||
|
|
||
| public static String readVersionFromResources() { | ||
| Properties versionProperties = new Properties(); | ||
| try (InputStream is = Version.class.getResourceAsStream("/version.properties")) { | ||
| versionProperties.load(is); | ||
| } catch (IOException ex) { | ||
| LOGGER.error("Error loading version properties", ex); | ||
| return UNREADABLE_VERSION; | ||
| } | ||
|
|
||
| String version = versionProperties.getProperty("version", UNKNOWN_VERSION).trim(); | ||
| if (VERSION_PLACEHOLDER.equals(version)) { | ||
| return UNSET_VERSION; | ||
| } else { | ||
| return version; | ||
| } | ||
| } | ||
|
|
||
| @Override | ||
| public void run() { | ||
| String version = readVersionFromResources(); | ||
| System.out.println(version); | ||
| } | ||
|
|
||
| } |
1 change: 1 addition & 0 deletions
1
modules/swagger-codegen-cli/src/main/resources/version.properties
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| version = ${project.version} |
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.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I fear there might have some side effects as we are filtering all the files under src/main/resources, not just the version.properties one – including all the templates.
To make sure that there are none, could you actually run all the petstore samples and see if there are any changes in the output?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Unless I'm missing anything build-wise, I think this should not be a problem because the filtering is enabled just for the
swagger-codegen-cliartifact and should not apply to the resources fromswagger-codegenartifact (which is where all the templates are included as resources).Running the samples should be a good practice anyway, so I'll try to find the time to do so, however.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ah, good point, I missed this.