Skip to content

Commit

Permalink
#485: Added note about --projects . command line option to user gui…
Browse files Browse the repository at this point in the history
…de (#487)

* #485 Add note about --projects . command line option

* Increment version

* Add changelog entry
  • Loading branch information
kaklakariada authored Oct 26, 2023
1 parent a4e08d0 commit 28b5e27
Show file tree
Hide file tree
Showing 5 changed files with 73 additions and 6 deletions.
21 changes: 17 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -161,16 +161,29 @@ The verification is bound to the maven `package` lifecycle phase. So it is autom

You can also run the checks manually using:

```shell script
```sh
mvn project-keeper:verify
```

In addition this plugin can also fix the project structure. For that use:

```shell script
```sh
mvn project-keeper:fix
```

For multi-module projects these commands may fail with the following error:

```
[ERROR] No plugin found for prefix 'project-keeper' in the current project and in the plugin groups [org.apache.maven.plugins, org.codehaus.mojo] available from the repositories [local (/home/user/.m2/repository), central (https://repo.maven.apache.org/maven2)] -> [Help 1]
```

In this case add command line option `--projects .`:

```sh
mvn project-keeper:verify --projects .
mvn project-keeper:fix --projects .
```

You can skip the execution of project-keeper by adding `-Dproject-keeper.skip=true` to your maven command.

### Standalone Command Line Interface
Expand All @@ -179,14 +192,14 @@ Use the `project-keeper-cli` for analyzing non-Maven projects like Golang.

Run the following commands to verify a project:

```shell
```sh
cd path/to/project
java -jar path/to/project-keeper-cli-2.7.1.jar verify
```

Run the following commands to fix the project structure:

```shell
```sh
cd path/to/project
java -jar path/to/project-keeper-cli-2.7.1.jar fix
```
Expand Down
1 change: 1 addition & 0 deletions doc/changes/changelog.md

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

53 changes: 53 additions & 0 deletions doc/changes/changes_2.9.15.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
# Project Keeper 2.9.15, released 2023-??-??

Code name:

## Summary

## Documentation

* #485: Added note about `--projects .` command line option to user guide

## Dependency Updates

### Project Keeper Core

#### Compile Dependency Updates

* Updated `com.exasol:project-keeper-shared-model-classes:2.9.14` to `2.9.15`

#### Runtime Dependency Updates

* Updated `com.exasol:project-keeper-java-project-crawler:2.9.14` to `2.9.15`

#### Test Dependency Updates

* Updated `com.exasol:project-keeper-shared-test-setup:2.9.14` to `2.9.15`

### Project Keeper Command Line Interface

#### Compile Dependency Updates

* Updated `com.exasol:project-keeper-core:2.9.14` to `2.9.15`

#### Test Dependency Updates

* Updated `com.exasol:project-keeper-shared-test-setup:2.9.14` to `2.9.15`

### Project Keeper Maven Plugin

#### Compile Dependency Updates

* Updated `com.exasol:project-keeper-core:2.9.14` to `2.9.15`

### Project Keeper Java Project Crawler

#### Compile Dependency Updates

* Updated `com.exasol:project-keeper-shared-model-classes:2.9.14` to `2.9.15`

### Project Keeper Shared Test Setup

#### Compile Dependency Updates

* Updated `com.exasol:project-keeper-shared-model-classes:2.9.14` to `2.9.15`
2 changes: 1 addition & 1 deletion doc/developers_guide/developers_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ Usually you need to

In some cases PK runs maven as a shell command. Maven will then search your for PK module "project crawler" in the version identical to PK opened in your IDE. The following command publishes project crawler to your local maven repository `~/.m2`:

```shell
```sh
mvn clean install -DskipTests
```

Expand Down
2 changes: 1 addition & 1 deletion parent-pom/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
</repository>
</distributionManagement>
<properties>
<revision>2.9.14</revision>
<revision>2.9.15</revision>
<maven.version>3.9.5</maven.version>
<minimum.maven.version>3.6.3</minimum.maven.version>
<junit.version>5.10.0</junit.version>
Expand Down

0 comments on commit 28b5e27

Please sign in to comment.