Skip to content

Commit

Permalink
initial commit
Browse files Browse the repository at this point in the history
  • Loading branch information
paullatzelsperger committed Jun 26, 2023
0 parents commit 5ec012d
Show file tree
Hide file tree
Showing 58 changed files with 3,508 additions and 0 deletions.
58 changes: 58 additions & 0 deletions .github/ISSUE_TEMPLATE/adoption_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
---
name: Adoption Request
about: Submit your feature to the project
title: 'Adoption Request'
labels: 'adoption'
assignees: ''

---

# Adoption Request

_Thank you for wanting to contribute to the project! We are very happy to see the functionalities of the EDC being extended. Providing this open-source is a great opportunity for others with similar requirements and to avoid additional work._

_For any details about the guidelines for submitting features, please take a look at the [contribution categories](https://github.com/eclipse-edc/Connector/blob/main/contribution_categories.md)._


## General information

Please provide some information about your project or code contribution.

_If you choose to be referenced as a "friend", these will be added to the [known friends list](https://github.com/eclipse-edc/Connector/blob/main/known_friends.md)._
_If you choose to add your feature as a core EDC component, links to your current code and correlated issues, discussions, and pull requests are of great importance._

| Title | Description | Contact | Links
| :--- | :--- | :--- | :---
| _My awesome project_ | _This is an example._ | _e-mail-address_ | _link to repository, homepage, discussion, etc._


## Adoption level

Next, please tell us what level of adoption you intend to provide. _(pick only one)_

- [ ] Reference a feature as "friend"
- [ ] Incorporate a feature as core EDC component



## Adoption in EDC core

_If you chose to add your feature as a core EDC component, please answer the following questions._

### Why should this contribution be adopted?
_Please argue why this feature must be hosted upstream and be maintained by the EDC core team._

### Could it be achieved with existing functionality? If not, why?
_If there is any existing code that can achieve the same thing with little modification, that is usually the preferable way for the EDC core team. We aim to keep the code succinct and want to avoid similar/duplicate code. Make sure you understand the EDC code base well!_

### Are there multiple use cases or applications who will benefit from the contribution?
_Basically, we want you to motivate who will use that feature and why, thereby arguing the fact that it is well-suited to be adopted in the core code base. One-off features are better suited to be maintained externally._

### Can it be achieved without introducing third-party dependencies? If not, which ones?
_EDC is a platform rather than an application, therefore we are extremely careful when it comes to introducing third party libraries. The reasons are diverse: security, license issues and over all JAR weight, just to mention a few important ones._

### Would this feature limit platform independence in any way? If so, how and why?
_Features that do not work well in clustered environments are difficult to adopt, since EDC is designed from the ground up to be stateless and clusterable. Similarly, features, that have dependencies onto certain operating systems are difficult to argue._

### Is it going to be a self-contained feature, or would it cut across the entire code base?
_Features that have a large impact on the code base are very complex to thoroughly test, they have a high chance to destabilize the code and require careful inspection. Self-contained features on the other hand are easier to isolate and test._
47 changes: 47 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
---
name: Bug Report
about: Create a report to help us improve
title: ''
labels: [ "bug_report", "triage" ]
assignees: ''

---

# Bug Report

## Describe the Bug

_A clear and concise description of the bug._

### Expected Behavior

_A clear and concise description of what you expected to happen._

### Observed Behavior

_A clear and concise description of what happened instead._

## Steps to Reproduce

Steps to reproduce the behavior:

1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

## Context Information

_Add any other context about the problem here._

- Used version [e.g. EDC v1.0.0]
- OS: [e.g. iOS, Windows]
- ...

## Detailed Description

_If applicable, add screenshots and logs to help explain your problem._

## Possible Implementation

_You already know the root cause of the erroneous state and how to fix it? Feel free to share your thoughts._
12 changes: 12 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
blank_issues_enabled: false
contact_links:
- name: Open up a blank issue
url: https://github.com/eclipse-edc/Connector/issues/new
about: Don’t see your issue here? Open up a blank one
- name: Ask a question or get support
url: https://github.com/eclipse-edc/Connector/discussions/categories/q-a
about: Ask a question or request support for using the Eclipse Dataspace Connector
- name: Take a look at the documentation
url: https://github.com/eclipse-edc/Connector/tree/main/docs
about: Browse the documentation for more information
25 changes: 25 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
name: Feature Request
about: Help us with new ideas
title: ''
labels: [ "feature_request", "triage" ]
assignees: ''

---

# Feature Request

_If you are missing a feature or have an idea how to improve this project that should first be discussed, please feel
free to open up a [discussion](https://github.com/eclipse-edc/Connector/discussions/categories/ideas)._

## Which Areas Would Be Affected?

_e.g., DPF, CI, build, transfer, etc._

## Why Is the Feature Desired?

_Are there any requirements?_

## Solution Proposal

_If possible, provide a (brief!) solution proposal._
18 changes: 18 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
## What this PR changes/adds

_Briefly describe WHAT your pr changes, which features it adds/modifies._

## Why it does that

_Briefly state why the change was necessary._

## Further notes

_List other areas of code that have changed but are not necessarily linked to the main feature. This could be method
signature changes, package declarations, bugs that were encountered and were fixed inline, etc._

## Linked Issue(s)

Closes # <-- _insert Issue number if one exists_

_Please be sure to take a look at the [contributing guidelines](https://github.com/eclipse-edc/Connector/blob/main/CONTRIBUTING.md#submit-a-pull-request) and our [etiquette for pull requests](https://github.com/eclipse-edc/Connector/blob/main/pr_etiquette.md)._
54 changes: 54 additions & 0 deletions .github/actions/bump-version/action.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
name: "Bump version in gradle.properties"
description: "Increments the patch version of the version found in gradle.properties, appends -SNAPSHOT"
inputs:
target_branch:
default: 'main'
description: "Branch on which the version bump is to be done."
required: false
base_version:
description: "The current version, which is to be bumped to the next snapshot"
required: false

runs:
using: "composite"
steps:
- uses: actions/checkout@v3
- name: read version from gradle.properties
shell: bash
run: |
# Prepare git env
git config user.name "eclipse-edc-bot"
git config user.email "[email protected]"
# checkout target
git fetch origin
git checkout ${{ inputs.target_branch }}
# use current version from input
baseVersion=${{ inputs.base_version }}
existingVersion=$(grep "version" gradle.properties | awk -F= '{print $2}')
# read the major, minor, and patch components, consume -SNAPSHOT
IFS=.- read -r RELEASE_VERSION_MAJOR RELEASE_VERSION_MINOR RELEASE_VERSION_PATCH SNAPSHOT<<<"$baseVersion"
INC=0
# Compute new snapshot version, do not increment snapshot on non-final releases, e.g. -rc1
if [ -z $SNAPSHOT ]; then
echo "$baseVersion is a final release version, increase patch for next snapshot"
INC=1
else
echo "$baseVersion is not a final release version (contains \"$SNAPSHOT\"), will not increase patch"
fi
# construct the new version
newVersion="$RELEASE_VERSION_MAJOR.$RELEASE_VERSION_MINOR.$((RELEASE_VERSION_PATCH+$INC))"-SNAPSHOT
# replace every occurrence of =$baseVersion with =$newVersion
grep -rlz "$existingVersion" . --exclude=\*.{sh,bin} | xargs sed -i "s/$existingVersion/$newVersion/g"
echo "Bumped the version from $baseVersion to $newVersion"
# Commit and push to the desired branch, defaults to 'main'
git add .
git commit --message "Bump version from $baseVersion to $newVersion [skip ci]"
git push origin ${{ inputs.target_branch }}
21 changes: 21 additions & 0 deletions .github/actions/run-tests/action.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
name: "Run tests"
description: "Run tests and archive test results for subsequent publication"
inputs:
command:
required: true
description: "The shell command to run tests"
runs:
using: "composite"
steps:
- name: Run Tests
shell: bash
run: ${{ inputs.command }}

- name: Upload Test Results
uses: actions/upload-artifact@v3
if: always()
with:
name: Test Results ${{ github.job }}
path: |
**/test-results/**/*.xml
**/build/reports/jacoco/test/jacocoTestReport.xml
9 changes: 9 additions & 0 deletions .github/actions/setup-build/action.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
name: "Setup Gradle"
description: "Setup Gradle"
runs:
using: "composite"
steps:
- uses: actions/setup-java@v3
with:
java-version: '17'
distribution: 'temurin'
21 changes: 21 additions & 0 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
version: 2
updates:
# maintain dependencies for GitHub actions
- package-ecosystem: "github-actions"
directory: "/"
schedule:
interval: "weekly" # default = monday
open-pull-requests-limit: 5
labels:
- "dependencies"
- "github_actions"

# maintain dependencies for Gradle
- package-ecosystem: "gradle" # checks build.gradle(.kts) and settings.gradle(.kts)
directory: "/"
schedule:
interval: "daily"
open-pull-requests-limit: 5
labels:
- "dependencies"
- "java"
18 changes: 18 additions & 0 deletions .github/release.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# This file determines how the auto-generated Release Notes in GitHub releases are structured.

changelog:
exclude:
labels:
- no-changelog
authors:
- dependabot[bot]
categories:
- title: Bugfixes
labels:
- bug
- title: New Features & Improvements
labels:
- "*"
- title: Documentation
labels:
- documentation
23 changes: 23 additions & 0 deletions .github/workflows/bump-version.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
name: "Bump version (manually)"

on:
# can be called manually from GH webpage
workflow_dispatch:
inputs:
target_branch:
default: 'main'
description: "Branch on which the version bump is to be done."
required: false


jobs:
Bump-Version:
name: 'Update snapshot version'
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: ./.github/actions/bump-version
name: Bump version
with:
target_branch: ${{ inputs.target_branch }}
Loading

0 comments on commit 5ec012d

Please sign in to comment.