Skip to content
This repository was archived by the owner on Jun 30, 2026. It is now read-only.

Commit 57393e6

Browse files
hqarawluseschrewetobias-urb
authored
release version 0.0.1
* docs: add release management and contribution guidelines. * docs: add CHANGELOG.md * docs: add CONTRIBUTING.md * docs: add versioning in CONTRIBUTING.md * docs: update readme * docs: add release management to contributing.md * docs: correct readme contribution guideline reference * chore: set version to 0.0.1 * Create main.yml * feat: add release pipeline * chore: change branch name for testing * chore: change branch name to main * fix: remove publishing from the PR pipeline * feat: add gradle publish to release pipeline * feat: add pull request template * Feat/tp41 379 test crud repository as data repository in dsp lib (#63) * feat: add dsp-mongodb module * feat: add dsp-lib and dsp-jpa modules, move files from src folder to dsp-lib * refactor: delete src folder and unnecessary files * feat: add factory interfaces for NegotiationRecord and TransferRecord instantiation * feat: add factory for NegotiationRecordRepository and TransferRecordRepository * feat: add repository factory for JPA and revise JPA and Mongo implementation * feat: first running version * feat: refactored unit tests * feat: adapted pipeline script * fix: naming coherence --------- Co-authored-by: Tobias Urbanek <tobias.urbanek@isst.fraunhofer.de> * fix: disable bootJar task * chore: re-done build in code ql --------- Co-authored-by: Ernst-Christoph Schrewe <132669361+eschrewe@users.noreply.github.com> Co-authored-by: Tobias Urbanek <tobias.urbanek@isst.fraunhofer.de> Co-authored-by: Ernst-Christoph Schrewe <ernst-christoph.schrewe@isst.fraunhofer.de>
1 parent 62a4251 commit 57393e6

74 files changed

Lines changed: 1770 additions & 657 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.github/pull_request_template.md‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
## 🚀 Pull Request Checklist (focused for use on `main` branch)
2+
3+
4+
### 🔍 General
5+
- [ ] The purpose of this PR is clearly described
6+
- [ ] The PR merges cleanly with no unresolved conflicts
7+
- [ ] All review comments and change requests from previous reviewers have been addressed
8+
9+
### 🧪 Code Quality
10+
- [ ] Code compiles and runs locally without errors
11+
- [ ] Unit tests are written for new or modified logic
12+
- [ ] Existing unit/integration tests pass (`./gradlew clean build`)
13+
- [ ] No commented-out or debug code (e.g., `System.out.println`)
14+
- [ ] Code follows the project’s style and formatting rules
15+
16+
### 🛡️ Main Branch Rules
17+
- [ ] **No `-SNAPSHOT` versions present in `build.gradle.kts` or any dependency**
18+
- [ ] No temporary or test code (e.g., dummy endpoints, sample services, etc.)
19+
- [ ] Versioning has been bumped appropriately (if applicable) — no development versions left
20+
21+
### 📝 Documentation
22+
- [ ] Public APIs or endpoints are documented (Swagger/OpenAPI, Markdown, or Javadoc)
23+
- [ ] README or related documentation has been updated (if necessary)
24+
25+
### 🔁 Review & Approval
26+
- [ ] At least one reviewer has approved the changes
27+
- [ ] CI pipeline has passed successfully
28+
29+
---
30+
31+
Please ensure the PR description below explains the **what** and **why**:
32+
33+
Summary
34+
<!-- A short summary of the changes introduced -->
35+
Motivation
36+
<!-- Why are these changes needed? What problem is solved? -->
37+
Notes
38+
<!-- Any additional context or known issues -->

‎.github/workflows/codeql.yml‎

Lines changed: 14 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -44,11 +44,20 @@ jobs:
4444
# For more details on CodeQL's query packs, refer to: https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
4545
queries: +security-extended,security-and-quality
4646

47-
# Autobuild attempts to build any compiled languages (C/C++, C#, Go, Java, or Swift).
48-
# Automates dependency installation for Python, Ruby, and JavaScript, optimizing the CodeQL analysis setup.
49-
# If this step fails, then you should remove it and run the build manually (see below)
50-
- name: Autobuild
51-
uses: github/codeql-action/autobuild@v3.29.0
47+
- name: Checkout Code
48+
uses: actions/checkout@v4
49+
50+
- name: Set up JDK
51+
uses: actions/setup-java@v4
52+
with:
53+
java-version: '21'
54+
distribution: 'temurin'
55+
56+
- name: Setup Gradle
57+
uses: gradle/actions/setup-gradle@v4
58+
59+
- name: Build with Gradle
60+
run: ./gradlew build
5261

5362
- name: Perform CodeQL Analysis
5463
uses: actions/upload-artifact@v4

‎.github/workflows/pipeline.yml‎

Lines changed: 1 addition & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -54,27 +54,4 @@ jobs:
5454
- name: Run Tests
5555
run: ./gradlew test
5656

57-
publish:
58-
needs: test
59-
runs-on: ubuntu-latest
60-
permissions:
61-
contents: read
62-
packages: write
63-
64-
steps:
65-
- name: Checkout Code
66-
uses: actions/checkout@v4
67-
68-
- name: Set up JDK
69-
uses: actions/setup-java@v4
70-
with:
71-
java-version: '21'
72-
distribution: 'temurin'
73-
74-
- name: Setup Gradle
75-
uses: gradle/actions/setup-gradle@v4
76-
77-
- name: Publish to GitHub Packages
78-
run: ./gradlew publish
79-
env:
80-
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
57+

‎.github/workflows/release-pipeline.yml‎

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
name: Release Pipeline
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
8+
jobs:
9+
release:
10+
runs-on: ubuntu-latest
11+
12+
steps:
13+
- name: Checkout code
14+
uses: actions/checkout@v4
15+
16+
- name: Extract version from Gradle (strip -SNAPSHOT)
17+
id: extract_version
18+
run: |
19+
version_line=$(grep "^systemProp.libVersion" gradle.properties)
20+
raw_version=$(echo "$version_line" | sed -E 's/systemProp\.libVersion[[:space:]]*=[[:space:]]*([0-9]+\.[0-9]+\.[0-9]+(-SNAPSHOT)?)/\1/')
21+
clean_version=$(echo $raw_version | sed 's/-SNAPSHOT//')
22+
echo "Raw version: $raw_version"
23+
echo "Clean version: $clean_version"
24+
echo "version=$clean_version" >> $GITHUB_OUTPUT
25+
26+
- uses: rickstaa/action-create-tag@v1
27+
id: "tag_create"
28+
with:
29+
tag: v${{ steps.extract_version.outputs.version }}
30+
tag_exists_error: false
31+
message: "Latest release of the DSP Lib"
32+
33+
- name: Create GitHub Release
34+
uses: softprops/action-gh-release@v2
35+
with:
36+
tag_name: v${{ steps.extract_version.outputs.version }}
37+
env:
38+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
39+
publish:
40+
needs: release
41+
runs-on: ubuntu-latest
42+
permissions:
43+
contents: read
44+
packages: write
45+
46+
steps:
47+
- name: Checkout Code
48+
uses: actions/checkout@v4
49+
50+
- name: Set up JDK
51+
uses: actions/setup-java@v4
52+
with:
53+
java-version: '21'
54+
distribution: 'temurin'
55+
56+
- name: Setup Gradle
57+
uses: gradle/actions/setup-gradle@v4
58+
59+
- name: Publish to GitHub Packages
60+
run: ./gradlew publish
61+
env:
62+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

‎CHANGELOG.md‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# Change
2+
3+
## Version 0.0.1 (Initial Release)
4+
_Release Date: 2025-03-05_
5+
6+
### Added
7+
- Initial Release 0.0.1
8+
9+
---
10+
11+
## Version History
12+
13+
### Version X.X.X
14+
_Release Date: XX_
15+
16+
### Changed
17+
- Feature X: Description of the new feature.
18+
19+
### Fixed
20+
- Bug fix 1: Description of the bug that was fixed.
21+
22+
### Added
23+
- Initial release with basic features.

‎CONTRIBUTING.md‎

Lines changed: 148 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,148 @@
1+
<!-- omit in toc -->
2+
# Contributing to Dataspace Protocol Lib
3+
4+
First off, thanks for taking the time to contribute!
5+
6+
All types of contributions are encouraged and valued. See the [Table of Contents](#table-of-contents) for different ways to help and details about how this project handles them. Please make sure to read the relevant section before making your contribution. It will make it a lot easier for us maintainers and smooth out the experience for all involved. The community looks forward to your contributions.
7+
8+
9+
<!-- omit in toc -->
10+
## Table of Contents
11+
12+
- [I Have a Question](#i-have-a-question)
13+
- [I Want To Contribute](#i-want-to-contribute)
14+
- [Release Management](#release-management)
15+
- [Reporting Bugs](#reporting-bugs)
16+
- [Suggesting Enhancements](#suggesting-enhancements)
17+
- [Your First Code Contribution](#your-first-code-contribution)
18+
- [Improving The Documentation](#improving-the-documentation)
19+
- [Styleguides](#styleguides)
20+
- [Commit Messages](#commit-messages)
21+
- [Join The Project Team](#join-the-project-team)
22+
23+
24+
25+
## I Have a Question
26+
27+
> If you want to ask a question, we assume that you have read the available [Documentation]().
28+
29+
Before you ask a question, it is best to search for existing [Issues](https://github.com/factory-x-contributions/dataspace-protocol-lib/issues) that might help you. In case you have found a suitable issue and still need clarification, you can write your question in this issue. It is also advisable to search the internet for answers first.
30+
31+
If you then still feel the need to ask a question and need clarification, we recommend the following:
32+
33+
- Open an [Issue](https://github.com/factory-x-contributions/dataspace-protocol-lib/issues/new).
34+
- Provide as much context as you can about what you're running into.
35+
- Provide project and platform versions (nodejs, npm, etc), depending on what seems relevant.
36+
37+
We will then take care of the issue as soon as possible.
38+
39+
40+
## I Want To Contribute
41+
42+
> ### Legal Notice <!-- omit in toc -->
43+
> When contributing to this project, you must agree that you have authored 100% of the content, that you have the necessary rights to the content and that the content you contribute may be provided under the project licence.
44+
45+
### Release Management
46+
47+
#### Branch Structure
48+
49+
- **Main Branch**:
50+
- The `main` branch is the primary branch for releases. Every new commit to `main` is treated as a new release.
51+
52+
- **Development Branch**:
53+
- The `development` branch is used for integrating feature branches. It serves as a staging area before merging into `main`.
54+
55+
#### Release Process
56+
57+
1. **Feature Development**:
58+
- Create feature branches off the `development` branch for new features or bug fixes.
59+
60+
2. **Merging**:
61+
- Merge stable feature branches into the `development` branch.
62+
- Once features in `development` are stable and ready for release, merge `development` into `main`.
63+
64+
3. **Versioning**:
65+
- Use [Semantic Versioning](https://semver.org/) (e.g., v1.0.0) for all releases.
66+
- Tag each release in the `main` branch with the corresponding version number.
67+
68+
69+
### Versioning
70+
71+
We use [Semantic Versioning](https://semver.org/) for our releases. Please ensure that any changes you make adhere to our versioning scheme.
72+
73+
- **MAJOR**: For breaking changes.
74+
- **MINOR**: For backward-compatible enhancements.
75+
- **PATCH**: For backward-compatible bug fixes.
76+
77+
### Reporting Bugs
78+
79+
<!-- omit in toc -->
80+
#### Before Submitting a Bug Report
81+
82+
A good bug report shouldn't leave others needing to chase you up for more information. Therefore, we ask you to investigate carefully, collect information and describe the issue in detail in your report. Please complete the following steps in advance to help us fix any potential bug as fast as possible.
83+
84+
- Make sure that you are using the latest version.
85+
- Determine if your bug is really a bug and not an error on your side e.g. using incompatible environment components/versions (Make sure that you have read the [documentation](). If you are looking for support, you might want to check [this section](#i-have-a-question)).
86+
- To see if other users have experienced (and potentially already solved) the same issue you are having, check if there is not already a bug report existing for your bug or error in the [bug tracker](https://github.com/factory-x-contributions/dataspace-protocol-lib/issues?q=label%3Abug).
87+
- Also make sure to search the internet (including Stack Overflow) to see if users outside of the GitHub community have discussed the issue.
88+
- Collect information about the bug:
89+
- Stack trace (Traceback)
90+
- OS, Platform and Version (Windows, Linux, macOS, x86, ARM)
91+
- Version of the interpreter, compiler, SDK, runtime environment, package manager, depending on what seems relevant.
92+
- Possibly your input and the output
93+
- Can you reliably reproduce the issue? And can you also reproduce it with older versions?
94+
95+
<!-- omit in toc -->
96+
#### How Do I Submit a Good Bug Report?
97+
98+
> You must never report security related issues, vulnerabilities or bugs including sensitive information to the issue tracker, or elsewhere in public. Instead sensitive bugs must be sent by email to <>.
99+
<!-- You may add a PGP key to allow the messages to be sent encrypted as well. -->
100+
101+
We use GitHub issues to track bugs and errors. If you run into an issue with the project:
102+
103+
- Open an [Issue](https://github.com/factory-x-contributions/dataspace-protocol-lib/issues/new). (Since we can't be sure at this point whether it is a bug or not, we ask you not to talk about a bug yet and not to label the issue.)
104+
- Explain the behavior you would expect and the actual behavior.
105+
- Please provide as much context as possible and describe the *reproduction steps* that someone else can follow to recreate the issue on their own. This usually includes your code. For good bug reports you should isolate the problem and create a reduced test case.
106+
- Provide the information you collected in the previous section.
107+
108+
Once it's filed:
109+
110+
- The project team will label the issue accordingly.
111+
- A team member will try to reproduce the issue with your provided steps. If there are no reproduction steps or no obvious way to reproduce the issue, the team will ask you for those steps and mark the issue as `needs-repro`. Bugs with the `needs-repro` tag will not be addressed until they are reproduced.
112+
- If the team is able to reproduce the issue, it will be marked `needs-fix`, as well as possibly other tags (such as `critical`), and the issue will be left to be [implemented by someone](#your-first-code-contribution).
113+
114+
<!-- You might want to create an issue template for bugs and errors that can be used as a guide and that defines the structure of the information to be included. If you do so, reference it here in the description. -->
115+
116+
117+
### Suggesting Enhancements
118+
119+
This section guides you through submitting an enhancement suggestion for Dataspace Protocol Lib, **including completely new features and minor improvements to existing functionality**. Following these guidelines will help maintainers and the community to understand your suggestion and find related suggestions.
120+
121+
<!-- omit in toc -->
122+
#### Before Submitting an Enhancement
123+
124+
- Make sure that you are using the latest version.
125+
- Read the [documentation]() carefully and find out if the functionality is already covered, maybe by an individual configuration.
126+
- Perform a [search](https://github.com/factory-x-contributions/dataspace-protocol-lib/issues) to see if the enhancement has already been suggested. If it has, add a comment to the existing issue instead of opening a new one.
127+
- Find out whether your idea fits with the scope and aims of the project. It's up to you to make a strong case to convince the project's developers of the merits of this feature. Keep in mind that we want features that will be useful to the majority of our users and not just a small subset. If you're just targeting a minority of users, consider writing an add-on/plugin library.
128+
129+
<!-- omit in toc -->
130+
#### How Do I Submit a Good Enhancement Suggestion?
131+
132+
Enhancement suggestions are tracked as [GitHub issues](https://github.com/factory-x-contributions/dataspace-protocol-lib/issues).
133+
134+
- Use a **clear and descriptive title** for the issue to identify the suggestion.
135+
- Provide a **step-by-step description of the suggested enhancement** in as many details as possible.
136+
- **Describe the current behavior** and **explain which behavior you expected to see instead** and why. At this point you can also tell which alternatives do not work for you.
137+
- You may want to **include screenshots or screen recordings** which help you demonstrate the steps or point out the part which the suggestion is related to. You can use [LICEcap](https://www.cockos.com/licecap/) to record GIFs on macOS and Windows, and the built-in [screen recorder in GNOME](https://help.gnome.org/users/gnome-help/stable/screen-shot-record.html.en) or [SimpleScreenRecorder](https://github.com/MaartenBaert/ssr) on Linux. <!-- this should only be included if the project has a GUI -->
138+
- **Explain why this enhancement would be useful** to most Dataspace Protocol Lib users. You may also want to point out the other projects that solved it better and which could serve as inspiration.
139+
140+
### Your First Code Contribution
141+
142+
143+
### Improving The Documentation
144+
145+
146+
## Styleguides
147+
### Commit Messages
148+

0 commit comments

Comments
 (0)