Skip to content

Commit

Permalink
Merge branch 'main' into dependabot/npm_and_yarn/extensions/wrapper/c…
Browse files Browse the repository at this point in the history
…lients/typescript-client/babel/traverse-and-trivago/prettier-plugin-sort-imports-7.23.2
  • Loading branch information
tmberthold authored Nov 30, 2023
2 parents 7bcdae7 + 6f595cc commit 8cfc767
Show file tree
Hide file tree
Showing 10 changed files with 124 additions and 130 deletions.
11 changes: 5 additions & 6 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
name: Bug Report
about: Create a report to help us improve
title: ""
labels: "kind/bug"
labels: ["kind/bug", "task/analyze", "scope/ce"]
assignees: ""
---

Expand Down Expand Up @@ -44,8 +44,7 @@ _Add any other context about the problem here._

## Possible Implementation and Work Breakdown

_You already know the root cause of the erroneous state and how to fix it? Feel free to share your thoughts._

- [ ] Task 1
- [ ] Task 2
- ...
```[tasklist]
- [ ] Fix the GitHub Projects Labels, Sprint and other Metadata
- [ ] Refine a Solution Proposal / Work Breakdown
```
27 changes: 27 additions & 0 deletions .github/ISSUE_TEMPLATE/enhancement.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
---
name: Enhancement
about: Implement a task / improve something
title: ""
labels: ["kind/enhancement", "scope/ce"]
assignees: ""
---

# Enhancement

## Description

_A clear and concise description of what the customer wants to happen._

- As a USER who PRECONDITIONS, I want to DO_THING, so I can ACCOMPLISH_GOAL.

## Stakeholders

_Add more on who asked for this, i.e. company, person, how much they pay us, what their tier is, are they a strategic account, etc. Who needs to be kept up-to-date about this feature?_

## Solution Proposal and Work Breakdown

```[tasklist]
- [ ] Fix the GitHub Projects Labels, Sprint and other Metadata
- [ ] Refine a Solution Proposal / Work Breakdown
```

60 changes: 0 additions & 60 deletions .github/ISSUE_TEMPLATE/epic_template.md

This file was deleted.

24 changes: 12 additions & 12 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
---
name: Feature Request
about: Help us with new features
about: Help us improve the sovity CE EDC Connector product experience with new features suggestions
title: ""
labels: "kind/enhancement"
assignees: ""
labels: ["kind/enhancement", "task/analyze", "status/blocked/needs-product", "scope/ce"]
assignees: ["AbdullahMuk"]
---

# Feature Request
Expand All @@ -20,20 +20,20 @@ _e.g., DPF, CI, build, transfer, etc._

## Why Is the Feature Desired?

_Are there any requirements?_
_What problems does that user face that existing functionalities do solve?_

## How does this tie into our current product?
## How does this tie into the current product?

_Describe whether this request is related to an existing workflow, feature, or otherwise something in the product today. Or, does this open us up to new markets and innovative ideas?_
_Describe whether this request is related to an existing workflow, feature, or otherwise something in the product today. Or, does this open us up to new innovative ideas?_

## Stakeholders
## (For sovity Team to complete) Stakeholders

_Add more on who asked for this, i.e. company, person, how much they pay us, what their tier is, are they a strategic account, etc. Who needs to be kept up-to-date about this feature?_

## Solution Proposal and Work Breakdown
## (For sovity Team to complete) Solution Proposal and Work Breakdown

_If possible, provide a (brief!) solution proposal._
```[tasklist]
- [ ] Fix the GitHub Projects Labels, Sprint and other Metadata
- [ ] Refine further action items for this feature request
```

- [ ] Step 1
- [ ] Step 2
- ...
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
---
name: MDS Feature Request
about: Help us improve your product experience with new features suggestions
name: Feature Request (MDS)
about: Help us improve the MDS CE EDC Connector product experience with new features suggestions
title: ""
labels: ["kind/enhancement", "scope/mds"]
assignees: ""
labels: ["kind/enhancement", "task/analyze", "status/blocked/needs-product", "scope/mds", "scope/ce"]
assignees: ["jkbquabeck", "AbdullahMuk"]
---

# Feature Request
Expand Down Expand Up @@ -32,8 +32,8 @@ _Add more on who asked for this, i.e. company, person, how much they pay us, wha

## (For sovity Team to complete) Solution Proposal and Work Breakdown

_If possible, provide a (brief!) solution proposal._
```[tasklist]
- [ ] Fix the GitHub Projects Labels, Sprint and other Metadata
- [ ] Refine further action items for this feature request
```

- [ ] Step 1
- [ ] Step 2
- ...
47 changes: 8 additions & 39 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,43 +1,12 @@
# Pull Request

_Briefly describe WHAT your PR changes, which features it adds/modifies._
_What issues does this PR close?_

## How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration
```[tasklist]
### Checklist
- [ ] The PR title is short and expressive.
- [ ] I have updated the CHANGELOG.md. See [changelog_update.md](https://github.com/sovity/edc-extensions/tree/main/docs/dev/changelog_updates.md) for more information.
- [ ] I have updated the Deployment Migration Notes Section in the CHANGELOG.md for any configuration / external API changes.
- [ ] I have performed a **self-review**
```

- Test A
- Test B
- ...

**Test Configuration**:

- Firmware version:
- Hardware:
- Toolchain:
- SDK:

## Linked Issue(s)

_Use keywords to automate: https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword_

- fixes # (issue)
- closes # (issue)
- ...

## PR is blocked by

- [ ] blocked by # (issue)

# Checklist

- [ ] I have **formatted the title** correctly and precisely
- [ ] My code follows the **style guidelines** of this project
- [ ] I have performed a **self-review** of my own code
- [ ] I have **commented** my code, particularly in hard-to-understand areas and public classes/methods
- [ ] I have made corresponding changes to the **documentation**
- [ ] My changes generate **no new warnings** (performed checkstyle check locally)
- [ ] I have added **tests that prove my fix** is effective or that my feature works
- [ ] New and existing unit **tests pass locally** with my changes
- [ ] Any dependent **changes have been merged** and published in downstream modules
- [ ] I have added/updated **copyright headers**
2 changes: 1 addition & 1 deletion .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ jobs:
- name: "Gradle: Build"
uses: gradle/gradle-build-action@a4cf152f482c7ca97ef56ead29bf08bcd953284c
with:
arguments: build ${{ env.GRADLE_ARGS }} -x test
arguments: build ${{ env.GRADLE_ARGS }}
- name: "Gradle: Publish (Main & Release Only)"
uses: gradle/gradle-build-action@a4cf152f482c7ca97ef56ead29bf08bcd953284c
if: ${{ github.ref == 'refs/heads/main' || startsWith(github.ref, 'refs/tags/v') }}
Expand Down
4 changes: 3 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# Changelog

All notable changes to this project will be documented in this file.
For documentation on how to update this changelog,
please see [changelog_updates.md](docs/dev/changelog_updates.md).

## [x.x.x] - UNRELEASED

Expand All @@ -18,6 +19,7 @@ All notable changes to this project will be documented in this file.

- Improved `:extensions:wrapper:wrapper-common-mappers` for broker: `AssetJsonLdUtils`, made some methods public.
- Added example for using the API Wrapper to offer and consume data.
- Improved development documentation documenting our CHANGELOG.

### Deployment Migration Notes

Expand Down
3 changes: 0 additions & 3 deletions docs/deployment-guide/goals/production/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -124,9 +124,6 @@ EDC_API_AUTH_KEY: ApiKeyDefaultValue
MY_EDC_MAINTAINER_URL: "https://sovity.de"
MY_EDC_MAINTAINER_NAME: "sovity GmbH"

# (MDS Only) Clearing House
EDC_CLEARINGHOUSE_LOG_URL: 'https://clearing.test.mobility-dataspace.eu/messages/log'

# DAPS URL
EDC_OAUTH_TOKEN_URL: 'https://daps.test.mobility-dataspace.eu/token'
EDC_OAUTH_PROVIDER_JWKS_URL: 'https://daps.test.mobility-dataspace.eu/jwks.json'
Expand Down
60 changes: 60 additions & 0 deletions docs/dev/changelog_updates.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
Updating the Changelog
======================

This project uses a [CHANGELOG.md](../../CHANGELOG.md).

## Structure of the Changelog

Each pull request should also update the "Unreleased" section of the changelog.
It should also update the "Deployment Migration Notes" Section of the unreleased section as preparation for the release.

For each release there will be a separate section especially with an "Overview" section containing a summary
from a product perspective.

Releases will especially contain a "Compatible Versions" section with the final docker
images and versions of our Connector Backend and Frontend.

## How to categorize a change

The changelog uses [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
Changes are categorized as either Major, Minor or Patch Changes.

For this project, changes are categorized as the following:

### Major Changes

Major changes include:

- UX / Product overhauls.
- Breaking changes in Connector-To-Connector communication.
- Breaking changes to other deployment units (our UI doesn't count).
- Breaking changes in our API Wrapper Use Case API.

### Minor Changes

Minor changes include:

- Any changes from a product perspective to our UI or API Wrapper UI API.
- Additions to our API Wrapper Use Case API.
- New Product Documentation

### Patch Changes

Patch changes are basically everything else:

- Product Fixes, Bugfixes, Refactorings
- Changes to existing Product Documentation
- New or changes to Developer Documentation
- Everything else

## Released Versions

On releases the "Unreleased" section is emptied in favor of a new section for the release.

Whether a release will bump the major, minor or patch version is decided by the unreleased changes in the changelog.

The Release sections will be cleaned up on release, improved with additional information and made
useful for the customer and people deploying the application, containing both product changes and
deployment migration notes.

More on that can be found in the [Release Issue Template](../../.github/ISSUE_TEMPLATE/release.md).

0 comments on commit 8cfc767

Please sign in to comment.