Skip to content

Commit 2016eee

Browse files
aindriu-aivenaindriu-aiven
authored
Merge pull request #1 from Aiven-Open/aiven-common-changes
changes for aiven-common changes
2 parents 1718dc6 + 85882fc commit 2016eee

9 files changed

Lines changed: 156 additions & 36 deletions

File tree

‎.github/workflows/Merge_check.yml‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,9 @@ on:
2424
branches:
2525
- 'main'
2626

27+
permissions:
28+
contents: read
29+
2730
# Disallow concurrent runs for the same PR by cancelling in-progress runs
2831
# when new commits are pushed
2932
concurrency:
@@ -63,7 +66,7 @@ jobs:
6366
- name: Extract version info
6467
run: |
6568
echo "version=$(mvn -q -Dexec.executable=echo -Dexec.args='${project.version}' --non-recursive exec:exec)" >> $GITHUB_OUTPUT;
66-
echo "java_version=$(mvn -q -Dexec.executable=echo -Dexec.args='${project.version}' --non-recursive exec:exec)" >> $GITHUB_OUTPUT;
69+
echo "java_version=$(mvn -q -Dexec.executable=echo -Dexec.args='${jdk.version}' --non-recursive exec:exec)" >> $GITHUB_OUTPUT;
6770
id: project
6871

6972
- name: Build ${{ steps.project.outputs.version }}

‎.github/workflows/PR_check.yml‎

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,9 @@ on:
2424
pull_request:
2525
branches: [ main ]
2626

27+
permissions:
28+
contents: read
29+
2730
# Disallow concurrent runs for the same PR by cancelling in-progress runs
2831
# when new commits are pushed
2932
concurrency:
@@ -55,13 +58,6 @@ jobs:
5558
restore-keys: |
5659
${{ runner.os }}-maven-
5760
58-
59-
- name: Extract version info
60-
run: |
61-
echo "version=$(mvn -q -Dexec.executable=echo -Dexec.args='${project.version}' --non-recursive exec:exec)" >> $GITHUB_OUTPUT;
62-
echo "java_version=$(mvn -q -Dexec.executable=echo -Dexec.args='${jdk.version}' --non-recursive exec:exec)" >> $GITHUB_OUTPUT;
63-
id: project
64-
6561
- name: Set up JDK ${{ matrix.java }}
6662
uses: actions/setup-java@v5
6763
with:

‎.github/workflows/publish.yml‎

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,8 @@ name: Publish
2323
on:
2424
workflow_dispatch:
2525

26+
permissions:
27+
contents: read
2628

2729
# Disallow concurrent runs for the same PR by cancelling in-progress runs
2830
# when new commits are pushed
@@ -39,8 +41,12 @@ jobs:
3941
- name: Checkout code
4042
uses: actions/checkout@v6
4143

42-
- name: Extract java version
43-
run: echo "java_version=$(mvn -q -Dexec.executable=echo -Dexec.args='${project.version}' --non-recursive exec:exec)" >> $GITHUB_OUTPUT
44+
- name: Extract version info
45+
run: |
46+
echo "version=$(mvn -q -Dexec.executable=echo -Dexec.args='${project.version}' --non-recursive exec:exec)" >> $GITHUB_OUTPUT;
47+
echo "java_version=$(mvn -q -Dexec.executable=echo -Dexec.args='${jdk.version}' --non-recursive exec:exec)" >> $GITHUB_OUTPUT;
48+
id: project
49+
4450

4551
- name: Set up JDK ${{ steps.project.outputs.java_version }}
4652
uses: actions/setup-java@v5
@@ -50,9 +56,6 @@ jobs:
5056
cache: maven
5157

5258

53-
- name: Extract Maven project version
54-
run: echo "version=$(mvn -q -Dexec.executable=echo -Dexec.args='${project.version}' --non-recursive exec:exec)" >> $GITHUB_OUTPUT
55-
5659
- name: Build ${{ steps.project.outputs.version }})
5760
run: mvn -e -B -V -ntp clean verify
5861
env:

‎CODE_OF_CONDUCT.md‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,21 @@
1+
<!--
2+
Copyright 2026 Aiven Oy and project contributors
3+
4+
Licensed under the Apache License, Version 2.0 (the "License");
5+
you may not use this file except in compliance with the License.
6+
You may obtain a copy of the License at
7+
8+
http://www.apache.org/licenses/LICENSE-2.0
9+
10+
Unless required by applicable law or agreed to in writing,
11+
software distributed under the License is distributed on an
12+
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
13+
KIND, either express or implied. See the License for the
14+
specific language governing permissions and limitations
15+
under the License.
16+
17+
SPDX-License-Identifier: Apache-2
18+
-->
119
# Contributor Covenant Code of Conduct
220

321
## Our Pledge

‎CONTRIBUTING.md‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,21 @@
1+
<!--
2+
Copyright 2026 Aiven Oy and project contributors
3+
4+
Licensed under the Apache License, Version 2.0 (the "License");
5+
you may not use this file except in compliance with the License.
6+
You may obtain a copy of the License at
7+
8+
http://www.apache.org/licenses/LICENSE-2.0
9+
10+
Unless required by applicable law or agreed to in writing,
11+
software distributed under the License is distributed on an
12+
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
13+
KIND, either express or implied. See the License for the
14+
specific language governing permissions and limitations
15+
under the License.
16+
17+
SPDX-License-Identifier: Apache-2
18+
-->
119
# Welcome!
220

321
Contributions are very welcome on kafka-config. When contributing please keep this in mind:

‎README.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,8 @@
1818
-->
1919
======================
2020

21+
[![Main push checks](https://github.com/Aiven-Open/kafka-config/actions/workflows/Merge_check.yml/badge.svg)](https://github.com/Aiven-Open/kafka-config/actions/workflows/Merge_check.yml)
22+
2123
Overview
2224
========
2325
`kafka-config` is a collection of utilities to make configuring and documenting Kafka components easier.

‎SECURITY.md‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,21 @@
1+
<!--
2+
Copyright 2026 Aiven Oy and project contributors
3+
4+
Licensed under the Apache License, Version 2.0 (the "License");
5+
you may not use this file except in compliance with the License.
6+
You may obtain a copy of the License at
7+
8+
http://www.apache.org/licenses/LICENSE-2.0
9+
10+
Unless required by applicable law or agreed to in writing,
11+
software distributed under the License is distributed on an
12+
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
13+
KIND, either express or implied. See the License for the
14+
specific language governing permissions and limitations
15+
under the License.
16+
17+
SPDX-License-Identifier: Apache-2
18+
-->
119
# Security Policy
220

321
## Supported Versions

‎pom.xml‎

Lines changed: 83 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -30,12 +30,66 @@
3030
<name>Aiven configuration utilities for Apache Kafka</name>
3131
<description>Utilities to help manage Kafka configuration and configuration definitions</description>
3232

33+
<inceptionYear>2026</inceptionYear>
34+
35+
<organization>
36+
<name>Aiven</name>
37+
<url>https://www.aiven.io</url>
38+
</organization>
39+
40+
<licenses>
41+
<license>
42+
<name>Apache License 2.0</name>
43+
<url>https://www.apache.org/licenses/LICENSE-2.0</url>
44+
<distribution>repo</distribution>
45+
</license>
46+
</licenses>
47+
48+
<!-- please order developers by surname then given name -->
49+
<developers>
50+
<developer>
51+
<id>aindriu-aiven</id>
52+
<name>Aindriú Lavelle</name>
53+
<email>aindriu.lavelle@aiven.io</email>
54+
<organization>Aiven, OY</organization>
55+
<organizationUrl>https://aiven.io</organizationUrl>
56+
<timezone>Europe/Dublin</timezone>
57+
</developer>
58+
<developer>
59+
<id>claudenw</id>
60+
<name>Claude Warren</name>
61+
<email>claude.warren@aiven.io</email>
62+
<organization>Aiven, OY</organization>
63+
<organizationUrl>https://aiven.io</organizationUrl>
64+
<timezone>Europe/Dublin</timezone>
65+
</developer>
66+
</developers>
67+
68+
<scm>
69+
<connection>scm:git:git://github.com/Aiven-Open/kafka-config.git</connection>
70+
<developerConnection>scm:git:git@github.com:Aiven-Open/kafka-config.git</developerConnection>
71+
<tag>HEAD</tag>
72+
<url>https://github.com/Aiven-Open/kafka-config</url>
73+
</scm>
74+
75+
<distributionManagement>
76+
<snapshotRepository>
77+
<id>central-snapshot</id>
78+
<url>https://central.sonatype.com/repository/maven-snapshots/</url>
79+
</snapshotRepository>
80+
<site>
81+
<id>staging</id>
82+
<!-- For the URL to resolve to the default URL as described in the Apache Site Plugin documentation this URL
83+
must be invalid. A ticket is open to resolve this issue. See https://github.com/apache/maven-site-plugin/issues/1140
84+
-->
85+
<url>invalid:url</url>
86+
</site>
87+
</distributionManagement>
88+
3389
<properties>
34-
<maven.artifact.version>3.9.6</maven.artifact.version>
35-
<jdk.version>17</jdk.version>
36-
<maven.compiler.source>${jdk.version}</maven.compiler.source>
37-
<maven.compiler.target>${jdk.version}</maven.compiler.target>
90+
<aiven.util.version>0.1.0-SNAPSHOT</aiven.util.version>
3891
</properties>
92+
3993
<dependencyManagement>
4094
<dependencies>
4195
<dependency>
@@ -67,12 +121,12 @@
67121
<dependency>
68122
<groupId>io.aiven.commons</groupId>
69123
<artifactId>common-util</artifactId>
70-
<version>0.1.0-SNAPSHOT</version>
124+
<version>${aiven.util.version}</version>
71125
</dependency>
72126
<dependency>
73127
<groupId>org.apache.commons</groupId>
74128
<artifactId>commons-text</artifactId>
75-
<version>1.14.0</version>
129+
<version>${commons.text.version}</version>
76130
</dependency>
77131
<dependency>
78132
<groupId>org.apache.maven</groupId>
@@ -82,56 +136,74 @@
82136
<dependency>
83137
<groupId>org.apache.kafka</groupId>
84138
<artifactId>connect-api</artifactId>
139+
<version>${kafka.version}</version>
85140
<scope>provided</scope>
86141
</dependency>
87142
<dependency>
88143
<groupId>org.apache.kafka</groupId>
89144
<artifactId>connect-runtime</artifactId>
145+
<version>${kafka.version}</version>
90146
<scope>provided</scope>
91147
</dependency>
92148
<dependency>
93149
<groupId>commons-io</groupId>
94150
<artifactId>commons-io</artifactId>
95-
<version>2.21.0</version>
151+
<version>${commons.io.version}</version>
96152
</dependency>
97153
<dependency>
98154
<groupId>org.apache.velocity.tools</groupId>
99155
<artifactId>velocity-tools-generic</artifactId>
156+
<version>${velocity.tools.version}</version>
100157
</dependency>
101158
<dependency>
102159
<groupId>org.assertj</groupId>
103160
<artifactId>assertj-core</artifactId>
161+
<version>${assertj.version}</version>
104162
<scope>test</scope>
105163
</dependency>
106164
<dependency>
107165
<groupId>org.junit.jupiter</groupId>
108166
<artifactId>junit-jupiter-params</artifactId>
167+
<version>${junit.version}</version>
109168
<scope>test</scope>
110169
</dependency>
111170
<dependency>
112171
<groupId>org.apache.commons</groupId>
113172
<artifactId>commons-collections4</artifactId>
173+
<version>${commons.collection4.version}</version>
114174
<scope>test</scope>
115175
</dependency>
116-
117176
</dependencies>
118177

119178
<repositories>
120179
<repository>
121180
<releases>
122181
<enabled>true</enabled>
123-
<updatePolicy>always</updatePolicy>
124182
<checksumPolicy>fail</checksumPolicy>
125183
</releases>
126184
<snapshots>
127185
<enabled>false</enabled>
128186
</snapshots>
187+
<id>Maven</id>
188+
<url>https://repo1.maven.org/maven2/</url>
189+
</repository>
190+
191+
<repository>
129192
<id>central</id>
130193
<url>https://central.sonatype.com/repository/maven</url>
131-
<layout>default</layout>
194+
<releases>
195+
<enabled>true</enabled>
196+
<updatePolicy>always</updatePolicy>
197+
<checksumPolicy>fail</checksumPolicy>
198+
</releases>
199+
<snapshots>
200+
<enabled>false</enabled>
201+
</snapshots>
132202
</repository>
133203

134204
<repository>
205+
<id>central-snapshot</id>
206+
<url>https://central.sonatype.com/repository/maven-snapshots/</url>
135207
<releases>
136208
<enabled>false</enabled>
137209
</releases>
@@ -140,9 +212,6 @@
140212
<updatePolicy>always</updatePolicy>
141213
<checksumPolicy>fail</checksumPolicy>
142214
</snapshots>
143-
<id>central-snapshot</id>
144-
<url>https://central.sonatype.com/repository/maven-snapshots/</url>
145-
<layout>default</layout>
146215
</repository>
147216
</repositories>
148217

@@ -163,15 +232,7 @@
163232
</archive>
164233
</configuration>
165234
</plugin>
166-
<plugin>
167-
<groupId>org.sonatype.central</groupId>
168-
<artifactId>central-publishing-maven-plugin</artifactId>
169-
<version>0.9.0</version>
170-
<extensions>true</extensions>
171-
<configuration>
172-
<publishingServerId>central</publishingServerId>
173-
</configuration>
174-
</plugin>
235+
175236
<plugin>
176237
<groupId>org.apache.maven.plugins</groupId>
177238
<artifactId>maven-site-plugin</artifactId>
@@ -217,7 +278,6 @@
217278
<plugin>
218279
<groupId>org.sonatype.central</groupId>
219280
<artifactId>central-publishing-maven-plugin</artifactId>
220-
<version>0.9.0</version>
221281
<extensions>true</extensions>
222282
<configuration>
223283
<publishingServerId>central-snapshot</publishingServerId>

‎src/site/markdown/index.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,8 @@
1818
-->
1919
# Aiven Commons Kafka Config (kafka-config)
2020

21+
[![Main push checks](https://github.com/Aiven-Open/kafka-config/actions/workflows/Merge_check.yml/badge.svg)](https://github.com/Aiven-Open/kafka-config/actions/workflows/Merge_check.yml)
22+
2123
`kafka-config` is a collection of utilities to make configuring and documenting Kafka components easier.
2224

2325

0 commit comments

Comments
 (0)