Skip to content

Commit

Permalink
add justfile with recommended/suggest build aliases
Browse files Browse the repository at this point in the history
  • Loading branch information
maxandersen committed Jan 7, 2025
1 parent 35ccb2e commit a7229a7
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 0 deletions.
22 changes: 22 additions & 0 deletions .justfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@

mvncmd := env_var_or_default("QMVNCMD", "./mvnw -T0.8C")

# build main project quickly
build:
{{mvncmd}} -Dquickly

# build main project fast - skip docs, tests, ITs, invoker, extension validation, gradle tests, truststore
build-fast:
{{mvncmd}} -e -DskipDocs -DskipTests -DskipITs -Dinvoker.skip -DskipExtensionValidation -Dskip.gradle.tests -Dtruststore.skip clean install

# build just docs, skipping as much unnecessary as posible.
build-docs:
{{mvncmd}} -e -DskipTests -DskipITs -Dinvoker.skip -DskipExtensionValidation -Dskip.gradle.tests -Dtruststore.skip -Dno-test-modules -Dasciidoctor.fail-if=DEBUG clean install

# format code according to Quarkus coding conventions
format:
{{mvncmd}} process-sources -Denforcer.skip -Dprotoc.skip

# run Quarkus CLI from local built snapshot
qss:
java -jar ./devtools/cli/target/quarkus-cli-999-SNAPSHOT-runner.jar
6 changes: 6 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -462,6 +462,12 @@ alias qss="java -jar ${HOME}/git/quarkus/devtools/cli/target/quarkus-cli-999-SNA
Using `./mvnw` is often not practical in this case as you might want to call these aliases from a nested directory.
[gum](https://andresalmiray.com/gum-the-gradle-maven-wrapper/) might be useful in this case.

##### Justfile

As a convenience, we have a [justfile](.justfile)) that provides the suggested set of aliases to use to build Quarkus using [just](https://just.systems/).

Run `just -l` to see the list of aliases.

#### Building all modules of an extension

Let's say you want to make changes to the `Jackson` extension. This extension contains the `deployment`, `runtime`
Expand Down

0 comments on commit a7229a7

Please sign in to comment.