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

#578: Fix automatic dependency update #579

Merged
merged 10 commits into from
Jun 3, 2024
+215 −78
Merged

#578: Fix automatic dependency update #579

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
912ef3d
#578: Fix automatic dependency update
kaklakariada Jun 3, 2024
48657eb
Update plugin versions
kaklakariada Jun 3, 2024
6c0c2d3
Remove requirement
kaklakariada Jun 3, 2024
bdce966
#577: Fix code for failing NPM dependency URL
kaklakariada Jun 3, 2024
e917c8c
Adapt unit tests
kaklakariada Jun 3, 2024
a1988cf
#577: Don't fail for missing URL
kaklakariada Jun 3, 2024
7f3681b
Fix javadoc generation
kaklakariada Jun 3, 2024
c00d7f5
Merge branch 'kaklakariada/issue577' into kaklakariada/issue578
kaklakariada Jun 3, 2024
0bdd409
Increment requirement revision
kaklakariada Jun 3, 2024
4fee27a
Update changelog
kaklakariada Jun 3, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 5 additions & 9 deletions .github/workflows/dependencies_update.yml
View file
Open in desktop

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

8 changes: 4 additions & 4 deletions dependencies.md
View file
Open in desktop

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

1 change: 1 addition & 0 deletions doc/changes/changelog.md
View file
Open in desktop

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

110 changes: 110 additions & 0 deletions doc/changes/changes_4.3.2.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,110 @@
# Project Keeper 4.3.2, released 2024-06-03

Code name: Fix automatic dependency update

## Summary

This release fixes creation of the automatic dependency update Pull Request. Due to restrictions of GitHub workflows it is not possible to run `project-keeper fix` which potentially updates other workflows. Please follow the instructions in the generated Pull Request and run PK fix manually. See #578 for details.

## Bugfixes

* #578: Fixed automatic dependency update
* #577: Fixed reading NPM dependencies with a missing project URL

## Dependency Updates

### Project Keeper Root Project

#### Plugin Dependency Updates

* Updated `org.apache.maven.plugins:maven-deploy-plugin:3.1.1` to `3.1.2`
* Updated `org.apache.maven.plugins:maven-enforcer-plugin:3.4.1` to `3.5.0`

### Project Keeper Shared Model Classes

#### Plugin Dependency Updates

* Updated `org.apache.maven.plugins:maven-enforcer-plugin:3.4.1` to `3.5.0`
* Updated `org.apache.maven.plugins:maven-javadoc-plugin:3.6.3` to `3.7.0`
* Updated `org.sonarsource.scanner.maven:sonar-maven-plugin:3.11.0.3922` to `4.0.0.4121`
* Updated `org.sonatype.plugins:nexus-staging-maven-plugin:1.6.13` to `1.7.0`

### Project Keeper Core

#### Compile Dependency Updates

* Updated `com.exasol:project-keeper-shared-model-classes:4.3.1` to `4.3.2`

#### Runtime Dependency Updates

* Updated `com.exasol:project-keeper-java-project-crawler:4.3.1` to `4.3.2`

#### Test Dependency Updates

* Updated `com.exasol:project-keeper-shared-test-setup:4.3.1` to `4.3.2`

#### Plugin Dependency Updates

* Updated `org.apache.maven.plugins:maven-enforcer-plugin:3.4.1` to `3.5.0`
* Updated `org.apache.maven.plugins:maven-javadoc-plugin:3.6.3` to `3.7.0`
* Updated `org.sonarsource.scanner.maven:sonar-maven-plugin:3.11.0.3922` to `4.0.0.4121`
* Updated `org.sonatype.plugins:nexus-staging-maven-plugin:1.6.13` to `1.7.0`

### Project Keeper Command Line Interface

#### Compile Dependency Updates

* Updated `com.exasol:project-keeper-core:4.3.1` to `4.3.2`
* Updated `org.apache.maven:maven-model:3.9.6` to `3.9.7`

#### Test Dependency Updates

* Updated `com.exasol:project-keeper-shared-test-setup:4.3.1` to `4.3.2`

#### Plugin Dependency Updates

* Updated `org.apache.maven.plugins:maven-assembly-plugin:3.6.0` to `3.7.1`
* Updated `org.apache.maven.plugins:maven-enforcer-plugin:3.4.1` to `3.5.0`
* Updated `org.apache.maven.plugins:maven-javadoc-plugin:3.6.3` to `3.7.0`
* Updated `org.sonarsource.scanner.maven:sonar-maven-plugin:3.11.0.3922` to `4.0.0.4121`
* Updated `org.sonatype.plugins:nexus-staging-maven-plugin:1.6.13` to `1.7.0`

### Project Keeper Maven Plugin

#### Compile Dependency Updates

* Updated `com.exasol:project-keeper-core:4.3.1` to `4.3.2`

#### Plugin Dependency Updates

* Updated `org.apache.maven.plugins:maven-enforcer-plugin:3.4.1` to `3.5.0`
* Updated `org.apache.maven.plugins:maven-jar-plugin:3.3.0` to `3.4.1`
* Updated `org.apache.maven.plugins:maven-javadoc-plugin:3.6.3` to `3.7.0`
* Updated `org.apache.maven.plugins:maven-plugin-plugin:3.11.0` to `3.13.1`
* Updated `org.sonarsource.scanner.maven:sonar-maven-plugin:3.11.0.3922` to `4.0.0.4121`
* Updated `org.sonatype.plugins:nexus-staging-maven-plugin:1.6.13` to `1.7.0`

### Project Keeper Java Project Crawler

#### Compile Dependency Updates

* Updated `com.exasol:project-keeper-shared-model-classes:4.3.1` to `4.3.2`

#### Plugin Dependency Updates

* Updated `org.apache.maven.plugins:maven-enforcer-plugin:3.4.1` to `3.5.0`
* Updated `org.apache.maven.plugins:maven-javadoc-plugin:3.6.3` to `3.7.0`
* Updated `org.apache.maven.plugins:maven-plugin-plugin:3.11.0` to `3.13.1`
* Updated `org.sonarsource.scanner.maven:sonar-maven-plugin:3.11.0.3922` to `4.0.0.4121`
* Updated `org.sonatype.plugins:nexus-staging-maven-plugin:1.6.13` to `1.7.0`

### Project Keeper Shared Test Setup

#### Compile Dependency Updates

* Updated `com.exasol:project-keeper-shared-model-classes:4.3.1` to `4.3.2`

#### Plugin Dependency Updates

* Updated `org.apache.maven.plugins:maven-enforcer-plugin:3.4.1` to `3.5.0`
* Updated `org.sonarsource.scanner.maven:sonar-maven-plugin:3.11.0.3922` to `4.0.0.4121`
7 changes: 5 additions & 2 deletions doc/requirements/design.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -745,7 +745,7 @@ Covers:
* [`dsn~dependency-updater.workflow.generate~1`](#generate-dependencies_updateyml-workflow)

#### `dependencies_update.yml` Workflow Starts PK `fix` Mode Twice
`dsn~dependency-updater.workflow.start-pk-fix~1`
`dsn~dependency-updater.workflow.start-pk-fix~2`

PK generates the `dependencies_update.yml` workflow so that it starts PK's `fix` mode twice after updating dependencies.

Expand All @@ -754,7 +754,10 @@ Rationale:
* After updating dependency versions, the workflow runs PK `fix` to update the dependencies section in the changes file.
* PK `fix` will potentially update PK to a newer version in `pom.xml` (see [`dsn~self-update~1`](#project-keeper-self-update)). So the workflow runs PK `fix` a second time (using the updated PK version) to update all generated files.

Needs: impl
Note:
Due to restrictions of GitHub permissions it is not possible for a workflow triggered by an event to modify GitHub workflows (see https://github.com/orgs/community/discussions/35410). That's why pushing the changes fail. A workaround would be to use a separate PAT, but this is too much effort.

We decided to skip running PK fix. The user must checkout the branch locally and run PK fix manually.

Covers:
* [`dsn~dependency-updater.workflow.generate~1`](#generate-dependencies_updateyml-workflow)
Expand Down
8 changes: 4 additions & 4 deletions maven-project-crawler/pk_generated_parent.pom
View file
Open in desktop

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

8 changes: 4 additions & 4 deletions parent-pom/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,10 +28,10 @@
</repository>
</distributionManagement>
<properties>
<revision>4.3.1</revision>
<revision>4.3.2</revision>
<!-- Integration test ProjectKeeperMojoIT starts a Maven build which requires Java 17. -->
<java.version>17</java.version>
<maven.version>3.9.6</maven.version>
<maven.version>3.9.7</maven.version>
<minimum.maven.version>3.6.3</minimum.maven.version>
<junit.version>5.10.2</junit.version>
<xmlunit.version>2.10.0</xmlunit.version>
Expand Down Expand Up @@ -89,7 +89,7 @@
<dependency>
<groupId>org.apache.maven.plugin-tools</groupId>
<artifactId>maven-plugin-annotations</artifactId>
<version>3.13.0</version>
<version>3.13.1</version>
<scope>provided</scope>
</dependency>
<dependency>
Expand Down Expand Up @@ -259,7 +259,7 @@
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-plugin-plugin</artifactId>
<version>3.11.0</version>
<version>3.13.1</version>
</plugin>
</plugins>
</pluginManagement>
Expand Down
4 changes: 2 additions & 2 deletions pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-enforcer-plugin</artifactId>
<version>3.4.1</version>
<version>3.5.0</version>
<executions>
<execution>
<id>enforce-maven</id>
Expand Down Expand Up @@ -70,7 +70,7 @@
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-deploy-plugin</artifactId>
<version>3.1.1</version>
<version>3.1.2</version>
<configuration>
<skip>true</skip>
</configuration>
Expand Down
8 changes: 4 additions & 4 deletions project-keeper-cli/pk_generated_parent.pom
View file
Open in desktop

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

16 changes: 4 additions & 12 deletions project-keeper-cli/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,6 @@
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-assembly-plugin</artifactId>
<version>3.6.0</version>
<configuration>
<finalName>project-keeper-cli-${project.version}</finalName>
<archive>
Expand All @@ -99,17 +98,10 @@
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<configuration>
<!-- Javadoc causes error "error: package java.util.logging is not visible
import java.util.logging.*;
(package java.util.logging is declared in module java.logging, but module jakarta.json does not read it)". -->
<additionalOptions>
<option>--add-modules</option>
<option>java.logging</option>
<option>--add-reads</option>
<option>jakarta.json=java.logging</option>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I fixed this using <option>org.glassfish.jakarta.json=java.sql</option> but I guess this also works.

</additionalOptions>
<!-- Ignore warning "warning: The code being documented uses modules but the packages defined in https://github.com/exasol/project-keeper/apidocs/ are in the unnamed module." with Java 17-->
<failOnWarnings>false</failOnWarnings>
<!-- Javadoc generation fails with error 'error: module not found: jakarta.xml.bind'.
This option deactivates modules as we don't use modules anyway.
See https://maven.apache.org/plugins/maven-javadoc-plugin/javadoc-mojo.html#legacymode -->
<legacyMode>true</legacyMode>
</configuration>
</plugin>
</plugins>
Expand Down
8 changes: 4 additions & 4 deletions project-keeper-maven-plugin/pk_generated_parent.pom
View file
Open in desktop

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

2 changes: 1 addition & 1 deletion project-keeper-maven-plugin/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-jar-plugin</artifactId>
<version>3.3.0</version>
<version>3.4.1</version>
<configuration>
<archive>
<manifest>
Expand Down
Loading
Loading