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.

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

Jump to bottom

Provide schemaspy:help goal #17

Merged
merged 1 commit into from
Aug 8, 2016
Merged

Provide schemaspy:help goal #17

merged 1 commit into from
Aug 8, 2016

Conversation

mnuessler
Copy link
Contributor

This pull request adds configuration to auto-generate a help goal.

As a user I find it helpful if a plugin provides a help goal, so that I can invoke schemaspy:help in the shell and get a list of available goals and usage description. Such a goal can be auto-generated at build time using the maven-plugin-plugin.

Example:
mvn com.wakaleo.schemaspy:maven-schemaspy-plugin:help

This plugin has 2 goals:

schemaspy:help
  Display help information on maven-schemaspy-plugin.
  Call mvn schemaspy:help -Ddetail=true -Dgoal=<goal-name> to display parameter
  details.

schemaspy:schemaspy
  The SchemaSpy Maven plugin report.

mvn com.wakaleo.schemaspy:maven-schemaspy-plugin:help -Ddetail=true -Dschemaspy

schemaspy:schemaspy
  The SchemaSpy Maven plugin report.

  Available parameters:

    allowHtmlInComments
      Allow HTML In Comments. Any HTML embedded in comments normally gets
      encoded so that it's rendered as text. This option allows it to be
      rendered as HTML.

    commentsInitiallyDisplayed
      Comments Initially Displayed. Column comments are normally hidden by
      default. This option displays them by default.

    connprops
      Specifies additional properties to be used when connecting to the
      database. Specify the entries directly, escaping the ='s with \= and
      separating each key\=value pair with a ;. May also be a file name, useful
      for hiding connection properties from public logs.

[...]

@wakaleo wakaleo merged commit 4cc5b18 into wakaleo:master Aug 8, 2016
@mnuessler mnuessler deleted the help-mojo branch August 8, 2016 14:41
@mnuessler
Copy link
Contributor Author

Thanks for still merging it after 3 years. ;)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@mnuessler @wakaleo