OpenLiberty / guides-common

Common Guide files
Other
9 stars 6 forks source link

Cover how to use Maven to build and package from CLI? #889

Open yeekangc opened 3 years ago

yeekangc commented 3 years ago

The current version of the guide doesn't cover how to use Maven from CLI to build and package an application.

Should consider including these beyond the use of liberty:run and liberty:dev. Or, provide pointers to Getting Started guide where appropriate.

NK-debug commented 1 year ago

mvn liberty:help

[INFO] Scanning for projects...
[INFO]
[INFO] ----------------< io.openliberty.guides:ServletSample >-----------------
[INFO] Building ServletSample 1.0-SNAPSHOT
[INFO] --------------------------------[ war ]---------------------------------
[INFO]
[INFO] --- liberty-maven-plugin:3.5.1:help (default-cli) @ ServletSample ---
[INFO] liberty-maven-plugin 3.5.1
  Liberty Maven Plugin : Install, Start/Stop, Package, Create Server,
  Deploy/Undeploy applications

This plugin has 24 goals:

liberty:clean
  Clean the logs, workarea, dropins and apps directories.

liberty:compile-jsp
  Compile the JSPs in the src/main/webapp folder.

liberty:configure-arquillian

liberty:create
  Create a liberty server

liberty:debug
  Start a liberty server in debug mode

liberty:deploy
  Copy applications to the specified directory of the Liberty server. The
  ResolutionScope.COMPILE_PLUS_RUNTIME includes compile + system + provided +
  runtime dependencies. The copyDependencies functionality will include
  dependencies with all those scopes, and transitive dependencies with scope
  compile + system + runtime. Provided scope transitive dependencies are not
  included by default (built-in maven behavior).

liberty:dev
  Start a liberty server in dev mode import to set ResolutionScope for TEST as
  it helps build full transitive dependency classpath

liberty:devc
  Start dev mode for containers

liberty:display-url
  Display an application URL in the default browser.

liberty:dump
  Dump diagnostic information from the server into an archive.

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

liberty:install-feature
  This mojo installs a feature packaged as a Subsystem Archive (esa) to the
  runtime.

liberty:install-server
  Install a liberty server

liberty:java-dump
  Dump diagnostic information from the server JVM.

liberty:package
  Package a liberty server

liberty:prepare-feature
  This mojo generates JSON files so user features can be installed from a
  specified BOM

liberty:run
  Start a liberty server

liberty:start
  Start a liberty server

liberty:status
  Check a liberty server status

liberty:stop
  Stop a liberty server

liberty:test-start
  Start a liberty server if tests are not skipped

liberty:test-stop
  Quickly bypass stopping server if server isn't started

liberty:undeploy
  Undeploy application from liberty server. If no parameters have been defined
  the mojo will undeploy all applications from the server.

liberty:uninstall-feature
  This mojo uninstalls a feature packaged as a Subsystem Archive (esa) from the
  runtime.