Skip to content

Commit 6d5bedf

Browse files
author
Pratik Lala
committed
Apply consumption-note fixes, CI/CD, and open-source readiness improvements
All changes relative to main (feature/open-source-release-new merge base): Core fixes: - JsonTransformer: @DaTa@Getter (remove unintended public setters); all output maps switched to LinkedHashMap for deterministic field order, including tempResults in handleArraySchema; standardise WARN log format to 'key=value' with single-quoted values throughout - JsonSchemaLoader: @DaTa@Getter; constructors made unchecked — wraps URISyntaxException as IllegalStateException and IOException as UncheckedIOException so callers don't need to declare checked exceptions - MissingFieldsException: add getFieldList() returning List<String> - Add Apache 2.0 LICENSE file README improvements: - Fix manual install command (mvn clean package → mvn clean install -DskipTests) - Add JAVA_HOME prerequisite note for macOS - Fix Quickstart snippet to show unchecked exception handling - Add exception-handling note to all config-loading snippets - Correct getFields() doc comment; add getFieldList() mention - Add "all fields evaluated before throwing" note - Add SLF4J backend and JSONPath DEBUG-logging Troubleshooting entries - Update Error handling section to reflect unchecked JsonSchemaLoader API pom.xml: - Add <developers> block (all seven team members) - Add <scm> and <distributionManagement> (required by Maven Central) - Add release profile: maven-source-plugin, maven-javadoc-plugin, maven-gpg-plugin, versions-maven-plugin Tests: - MockitoAnnotations.initMocks → openMocks - Remove JUnit 4 dependency; standardise entirely on JUnit 5 - Fix validateFields helpers to use JUnit 5 message-last parameter order CI/CD: - .github/workflows/ci.yml: build + test on every push/PR (Java 11/17/21) - .github/workflows/release.yml: publish to Maven Central + create GitHub Release on version tag push (v*.*.*) or manual workflow_dispatch - .github/settings.xml: Maven server config for OSSRH credentials Made-with: Cursor
1 parent df20832 commit 6d5bedf

File tree

8 files changed

+551
-37
lines changed

8 files changed

+551
-37
lines changed

.github/settings.xml

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
<!--
2+
Maven settings used by the GitHub Actions release workflow.
3+
Credentials are injected from GitHub repository secrets at runtime.
4+
Do NOT hard-code any values here.
5+
-->
6+
<settings xmlns="http://maven.apache.org/SETTINGS/1.0.0"
7+
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
8+
xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.0.0
9+
https://maven.apache.org/xsd/settings-1.0.0.xsd">
10+
<servers>
11+
<server>
12+
<id>ossrh</id>
13+
<username>${env.OSSRH_USERNAME}</username>
14+
<password>${env.OSSRH_PASSWORD}</password>
15+
</server>
16+
</servers>
17+
</settings>

.github/workflows/ci.yml

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
name: CI — Build and Test
2+
3+
on:
4+
push:
5+
branches: ["**"]
6+
tags-ignore: ["v*"]
7+
pull_request:
8+
branches: ["**"]
9+
10+
jobs:
11+
build:
12+
name: Build and Test (Java ${{ matrix.java }})
13+
runs-on: ubuntu-latest
14+
strategy:
15+
matrix:
16+
java: ['11', '17', '21']
17+
18+
steps:
19+
- name: Checkout
20+
uses: actions/checkout@v4
21+
22+
- name: Set up JDK ${{ matrix.java }}
23+
uses: actions/setup-java@v4
24+
with:
25+
java-version: ${{ matrix.java }}
26+
distribution: corretto
27+
cache: maven
28+
29+
- name: Build and test
30+
run: mvn --batch-mode clean verify
31+
32+
- name: Upload test results
33+
if: always()
34+
uses: actions/upload-artifact@v4
35+
with:
36+
name: test-results-java-${{ matrix.java }}
37+
path: target/surefire-reports/
38+
retention-days: 7
39+
40+
- name: Upload coverage report
41+
if: matrix.java == '11'
42+
uses: actions/upload-artifact@v4
43+
with:
44+
name: coverage-report
45+
path: target/site/jacoco/
46+
retention-days: 7

.github/workflows/release.yml

Lines changed: 86 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
1+
name: Release — Publish to Maven Central
2+
3+
# Triggers:
4+
# - Push a version tag: git tag v1.0.1 && git push origin v1.0.1
5+
# - Manual dispatch from the GitHub Actions UI with an explicit version
6+
on:
7+
push:
8+
tags:
9+
- "v*.*.*"
10+
workflow_dispatch:
11+
inputs:
12+
version:
13+
description: "Version to release (e.g. 1.0.1) — do not include the 'v' prefix"
14+
required: true
15+
16+
jobs:
17+
publish:
18+
name: Build, Sign, and Publish
19+
runs-on: ubuntu-latest
20+
permissions:
21+
contents: write # needed to create the GitHub Release
22+
23+
steps:
24+
- name: Checkout
25+
uses: actions/checkout@v4
26+
with:
27+
fetch-depth: 0
28+
29+
- name: Set up JDK 11
30+
uses: actions/setup-java@v4
31+
with:
32+
java-version: '11'
33+
distribution: corretto
34+
cache: maven
35+
36+
- name: Determine version
37+
id: version
38+
run: |
39+
if [ -n "${{ github.event.inputs.version }}" ]; then
40+
VERSION="${{ github.event.inputs.version }}"
41+
else
42+
# Strip the leading 'v' from the tag name
43+
VERSION="${GITHUB_REF_NAME#v}"
44+
fi
45+
echo "version=$VERSION" >> "$GITHUB_OUTPUT"
46+
echo "Releasing version: $VERSION"
47+
48+
- name: Set Maven version
49+
run: |
50+
mvn --batch-mode versions:set \
51+
-DnewVersion=${{ steps.version.outputs.version }} \
52+
-DgenerateBackupPoms=false
53+
54+
- name: Build and test
55+
run: mvn --batch-mode clean verify
56+
57+
- name: Import GPG key
58+
run: |
59+
echo "${{ secrets.GPG_PRIVATE_KEY }}" | gpg --batch --import
60+
# Trust the key fully
61+
KEY_ID=$(gpg --list-secret-keys --with-colons | grep '^sec' | cut -d: -f5 | head -1)
62+
echo "$KEY_ID:6:" | gpg --import-ownertrust
63+
64+
- name: Publish to Maven Central
65+
env:
66+
OSSRH_USERNAME: ${{ secrets.OSSRH_USERNAME }}
67+
OSSRH_PASSWORD: ${{ secrets.OSSRH_PASSWORD }}
68+
GPG_PASSPHRASE: ${{ secrets.GPG_PASSPHRASE }}
69+
run: |
70+
mvn --batch-mode deploy \
71+
-P release \
72+
-s .github/settings.xml \
73+
-DskipTests \
74+
-Dgpg.passphrase="${GPG_PASSPHRASE}"
75+
76+
- name: Create GitHub Release
77+
uses: softprops/action-gh-release@v2
78+
with:
79+
tag_name: v${{ steps.version.outputs.version }}
80+
name: v${{ steps.version.outputs.version }}
81+
generate_release_notes: true
82+
make_latest: true
83+
files: |
84+
target/json2jsontransformer-*.jar
85+
env:
86+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

LICENSE

Lines changed: 202 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,202 @@
1+
2+
Apache License
3+
Version 2.0, January 2004
4+
http://www.apache.org/licenses/
5+
6+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7+
8+
1. Definitions.
9+
10+
"License" shall mean the terms and conditions for use, reproduction,
11+
and distribution as defined by Sections 1 through 9 of this document.
12+
13+
"Licensor" shall mean the copyright owner or entity authorized by
14+
the copyright owner that is granting the License.
15+
16+
"Legal Entity" shall mean the union of the acting entity and all
17+
other entities that control, are controlled by, or are under common
18+
control with that entity. For the purposes of this definition,
19+
"control" means (i) the power, direct or indirect, to cause the
20+
direction or management of such entity, whether by contract or
21+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
22+
outstanding shares, or (iii) beneficial ownership of such entity.
23+
24+
"You" (or "Your") shall mean an individual or Legal Entity
25+
exercising permissions granted by this License.
26+
27+
"Source" form shall mean the preferred form for making modifications,
28+
including but not limited to software source code, documentation
29+
source, and configuration files.
30+
31+
"Object" form shall mean any form resulting from mechanical
32+
transformation or translation of a Source form, including but
33+
not limited to compiled object code, generated documentation,
34+
and conversions to other media types.
35+
36+
"Work" shall mean the work of authorship, whether in Source or
37+
Object form, made available under the License, as indicated by a
38+
copyright notice that is included in or attached to the work
39+
(an example is provided in the Appendix below).
40+
41+
"Derivative Works" shall mean any work, whether in Source or Object
42+
form, that is based on (or derived from) the Work and for which the
43+
editorial revisions, annotations, elaborations, or other modifications
44+
represent, as a whole, an original work of authorship. For the purposes
45+
of this License, Derivative Works shall not include works that remain
46+
separable from, or merely link (or bind by name) to the interfaces of,
47+
the Work and Derivative Works thereof.
48+
49+
"Contribution" shall mean any work of authorship, including
50+
the original version of the Work and any modifications or additions
51+
to that Work or Derivative Works thereof, that is intentionally
52+
submitted to Licensor for inclusion in the Work by the copyright owner
53+
or by an individual or Legal Entity authorized to submit on behalf of
54+
the copyright owner. For the purposes of this definition, "submitted"
55+
means any form of electronic, verbal, or written communication sent
56+
to the Licensor or its representatives, including but not limited to
57+
communication on electronic mailing lists, source code control systems,
58+
and issue tracking systems that are managed by, or on behalf of, the
59+
Licensor for the purpose of discussing and improving the Work, but
60+
excluding communication that is conspicuously marked or otherwise
61+
designated in writing by the copyright owner as "Not a Contribution."
62+
63+
"Contributor" shall mean Licensor and any individual or Legal Entity
64+
on behalf of whom a Contribution has been received by Licensor and
65+
subsequently incorporated within the Work.
66+
67+
2. Grant of Copyright License. Subject to the terms and conditions of
68+
this License, each Contributor hereby grants to You a perpetual,
69+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70+
copyright license to reproduce, prepare Derivative Works of,
71+
publicly display, publicly perform, sublicense, and distribute the
72+
Work and such Derivative Works in Source or Object form.
73+
74+
3. Grant of Patent License. Subject to the terms and conditions of
75+
this License, each Contributor hereby grants to You a perpetual,
76+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77+
(except as stated in this section) patent license to make, have made,
78+
use, offer to sell, sell, import, and otherwise transfer the Work,
79+
where such license applies only to those patent claims licensable
80+
by such Contributor that are necessarily infringed by their
81+
Contribution(s) alone or by combination of their Contribution(s)
82+
with the Work to which such Contribution(s) was submitted. If You
83+
institute patent litigation against any entity (including a
84+
cross-claim or counterclaim in a lawsuit) alleging that the Work
85+
or a Contribution incorporated within the Work constitutes direct
86+
or contributory patent infringement, then any patent licenses
87+
granted to You under this License for that Work shall terminate
88+
as of the date such litigation is filed.
89+
90+
4. Redistribution. You may reproduce and distribute copies of the
91+
Work or Derivative Works thereof in any medium, with or without
92+
modifications, and in Source or Object form, provided that You
93+
meet the following conditions:
94+
95+
(a) You must give any other recipients of the Work or
96+
Derivative Works a copy of this License; and
97+
98+
(b) You must cause any modified files to carry prominent notices
99+
stating that You changed the files; and
100+
101+
(c) You must retain, in the Source form of any Derivative Works
102+
that You distribute, all copyright, patent, trademark, and
103+
attribution notices from the Source form of the Work,
104+
excluding those notices that do not pertain to any part of
105+
the Derivative Works; and
106+
107+
(d) If the Work includes a "NOTICE" text file as part of its
108+
distribution, then any Derivative Works that You distribute must
109+
include a readable copy of the attribution notices contained
110+
within such NOTICE file, excluding those notices that do not
111+
pertain to any part of the Derivative Works, in at least one
112+
of the following places: within a NOTICE text file distributed
113+
as part of the Derivative Works; within the Source form or
114+
documentation, if provided along with the Derivative Works; or,
115+
within a display generated by the Derivative Works, if and
116+
wherever such third-party notices normally appear. The contents
117+
of the NOTICE file are for informational purposes only and
118+
do not modify the License. You may add Your own attribution
119+
notices within Derivative Works that You distribute, alongside
120+
or as an addendum to the NOTICE text from the Work, provided
121+
that such additional attribution notices cannot be construed
122+
as modifying the License.
123+
124+
You may add Your own copyright statement to Your modifications and
125+
may provide additional or different license terms and conditions
126+
for use, reproduction, or distribution of Your modifications, or
127+
for any such Derivative Works as a whole, provided Your use,
128+
reproduction, and distribution of the Work otherwise complies with
129+
the conditions stated in this License.
130+
131+
5. Submission of Contributions. Unless You explicitly state otherwise,
132+
any Contribution intentionally submitted for inclusion in the Work
133+
by You to the Licensor shall be under the terms and conditions of
134+
this License, without any additional terms or conditions.
135+
Notwithstanding the above, nothing herein shall supersede or modify
136+
the terms of any separate license agreement you may have executed
137+
with Licensor regarding such Contributions.
138+
139+
6. Trademarks. This License does not grant permission to use the trade
140+
names, trademarks, service marks, or product names of the Licensor,
141+
except as required for reasonable and customary use in describing the
142+
origin of the Work and reproducing the content of the NOTICE file.
143+
144+
7. Disclaimer of Warranty. Unless required by applicable law or
145+
agreed to in writing, Licensor provides the Work (and each
146+
Contributor provides its Contributions) on an "AS IS" BASIS,
147+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148+
implied, including, without limitation, any warranties or conditions
149+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150+
PARTICULAR PURPOSE. You are solely responsible for determining the
151+
appropriateness of using or redistributing the Work and assume any
152+
risks associated with Your exercise of permissions under this License.
153+
154+
8. Limitation of Liability. In no event and under no legal theory,
155+
whether in tort (including negligence), contract, or otherwise,
156+
unless required by applicable law (such as deliberate and grossly
157+
negligent acts) or agreed to in writing, shall any Contributor be
158+
liable to You for damages, including any direct, indirect, special,
159+
incidental, or consequential damages of any character arising as a
160+
result of this License or out of the use or inability to use the
161+
Work (including but not limited to damages for loss of goodwill,
162+
work stoppage, computer failure or malfunction, or any and all
163+
other commercial damages or losses), even if such Contributor
164+
has been advised of the possibility of such damages.
165+
166+
9. Accepting Warranty or Additional Liability. While redistributing
167+
the Work or Derivative Works thereof, You may choose to offer,
168+
and charge a fee for, acceptance of support, warranty, indemnity,
169+
or other liability obligations and/or rights consistent with this
170+
License. However, in accepting such obligations, You may act only
171+
on Your own behalf and on Your sole responsibility, not on behalf
172+
of any other Contributor, and only if You agree to indemnify,
173+
defend, and hold each Contributor harmless for any liability
174+
incurred by, or claims asserted against, such Contributor by reason
175+
of your accepting any such warranty or additional liability.
176+
177+
END OF TERMS AND CONDITIONS
178+
179+
APPENDIX: How to apply the Apache License to your work.
180+
181+
To apply the Apache License to your work, attach the following
182+
boilerplate notice, with the fields enclosed by brackets "[]"
183+
replaced with your own identifying information. (Don't include
184+
the brackets!) The text should be enclosed in the appropriate
185+
comment syntax for the file format. We also recommend that a
186+
file or class name and description of purpose be included on the
187+
same "printed page" as the copyright notice for easier
188+
identification within third-party archives.
189+
190+
Copyright [yyyy] [name of copyright owner]
191+
192+
Licensed under the Apache License, Version 2.0 (the "License");
193+
you may not use this file except in compliance with the License.
194+
You may obtain a copy of the License at
195+
196+
http://www.apache.org/licenses/LICENSE-2.0
197+
198+
Unless required by applicable law or agreed to in writing, software
199+
distributed under the License is distributed on an "AS IS" BASIS,
200+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201+
See the License for the specific language governing permissions and
202+
limitations under the License.

0 commit comments

Comments
 (0)