Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Mdas 933 refactoring eai komponenten #2

Merged
merged 14 commits into from
Nov 11, 2024
Merged
Show file tree
Hide file tree
Changes from 8 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
## Pull Request

### Description

### Reference

Issues:

### Definition of Done
*Advice: Unchecked checkboxes are not accepted by the build pipeline. Cross out any non-relevant item by using '~~'.*

- [ ] Acceptance criteria are met
- [ ] Build/Test workflow has successfully finished
- [ ] Release notes are complemented
- [ ] Documentation is complemented (operator manual, system specification)
- [ ] Frontend is locally smoke-tested
- [ ] Board is updated
- [ ] Infrastructure is adjusted

Please delete all side branches after merging.
44 changes: 44 additions & 0 deletions .github/workflows/build-common.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
name: Common compliance check and build test

on:
push:
branches-ignore:
- 'sprint'
- 'main'
paths:
- '${{ github.workspace }}/**'
- '.github/workflows/**'
pull_request:
types: [ opened, reopened ]

jobs:
compliance:
runs-on: ubuntu-latest

steps:
- name: Checkout code
uses: actions/checkout@v3

- name: Advance Security Policy as Code
uses: advanced-security/[email protected]
with:
policy: it-at-m/policy-as-code
policy-path: default.yaml
token: ${{ secrets.GITHUB_TOKEN }}
argvs: "--disable-dependabot --disable-secret-scanning --disable-code-scanning --display"

build-maven:
needs: compliance
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4

- name: Set up JDK 17
uses: actions/setup-java@v3
with:
java-version: "17"
distribution: "temurin"
cache: "maven"

- name: Build with Maven
run: mvn --update-snapshots -f ${{ github.workspace }}/pom.xml verify
15 changes: 0 additions & 15 deletions .github/workflows/dependency_review.yaml

This file was deleted.

64 changes: 64 additions & 0 deletions .github/workflows/release-build-common.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
name: Build common release

on:
workflow_dispatch:
inputs:
branch:
description: "Branch to release from ?"
required: true
default: "main"
release-version:
description: "Release version ?"
required: true
release-tag:
description: "Release tag ?"
required: true
development-version:
description: "Next Development version ?"
required: true

jobs:
release:
name: Create release
runs-on: ubuntu-latest
steps:
- name: Git checkout to main branch # Releases are published on main branch
uses: actions/checkout@v4
with:
ref: ${{ github.event.inputs.branch }}

- name: Setup git user
uses: fregante/setup-git-user@v2

- name: Set up JDK and OSSRH auth / GPG signing
uses: actions/setup-java@v3
with:
java-version: "17"
distribution: "temurin"
cache: "maven"
server-id: "central"
server-username: CENTRAL_USERNAME
server-password: CENTRAL_PASSWORD
gpg-private-key: ${{ secrets.gpg_private_key }}
gpg-passphrase: SIGN_KEY_PASS

- name: Perform maven release
run: >
mvn --batch-mode --no-transfer-progress -f ${{ github.workspace }}/pom.xml release:prepare release:perform
-DreleaseVersion=${{ github.event.inputs.release-version }}
-DdevelopmentVersion=${{ github.event.inputs.development-version }}
-Dtag=${{ github.event.inputs.release-tag }}
-Darguments="-DskipTests"
env:
SIGN_KEY_PASS: ${{ secrets.gpg_passphrase }}
CENTRAL_USERNAME: ${{ secrets.sonatype_username }}
CENTRAL_PASSWORD: ${{ secrets.sonatype_password }}

- name: Create GitHub Release
id: create_release
uses: softprops/action-gh-release@v1
with:
tag_name: ${{ github.event.inputs.release-tag }}
draft: false
prerelease: false
generate_release_notes: false
14 changes: 14 additions & 0 deletions .github/workflows/require-checklist.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
name: Require Checklist

on:
pull_request:
types: [opened, edited, synchronize]

jobs:
checklist-check:
runs-on: ubuntu-latest
if: ${{ github.actor != 'renovate[bot]' }}
steps:
- uses: mheap/require-checklist-action@v2
with:
requireChecklist: true
8 changes: 0 additions & 8 deletions Dockerfile

This file was deleted.

111 changes: 59 additions & 52 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,81 +1,88 @@
## Customize this file after creating the new REPO and remove this lines.
What to adjust:
* Add the your project or repo name direct under the logo.
* Add a short and long desciption.
* Add links for your final repo to report a bug or request a feature.
* Add list of used technologies.
* If you have, add a roadmap or remove this section.
* Fill up the section for set up and documentation.
* Start in this file only with documentation and link to the docs folder.
* Add more project shields. Use [shields.io](https://shields.io/) with style `for-the-badge`.
<div id="top"></div>

## ------- end to remove -------
<!-- add Project Logo, if existing -->
<!-- PROJECT SHIELDS -->

# repo or project name
<!-- END OF PROJECT SHIELDS -->

[![Made with love by it@M][made-with-love-shield]][itm-opensource]
<!-- feel free to add more shields, style 'for-the-badge' -> see https://shields.io/badges -->
<!-- PROJECT LOGO -->
<br />
<div align="center">
<a href="#">
<img src="/images/logo.png" alt="Logo" height="200">
martind260 marked this conversation as resolved.
Show resolved Hide resolved
</a>

*Add a description from your project here.*
<h3 align="center">MobidaM - Mobilitätsdatenplattform für München</i></h3>

<p align="center">
<i>Anwendung für das Management der Schnittstellen</i>
<br /><a href="https://https://github.com/it-at-m/mobidam-s3-eai/issues">Fehler melden</a>
·
<a href="https://https://github.com/it-at-m/mobidam-s3-eai/issues">Anforderung einstellen</a>
</p>
</div>

### Built With
<!-- ABOUT THE PROJECT -->

The documentation project is built with technologies we use in our projects:
## Über das Projekt

* *write here the list of used technologies*
Gesamtziel des Projektes MobidaM ist die Einführung einer Mobilitätsdatenplattform zur Bereitstellung, Haltung, Visualisierung und Auswertung von Mobilitätsdaten im Kontext der Mobilitätsplanung, der Wirkungsanalyse und der Angebotssteuerung. Hierbei werden die unterschiedlichsten Daten aus verschiedenen internen oder externen Datenquellen benötigt.

## Roadmap
Im Kontext des MobidaM Projekts implementiert der mobidam-eai-commons-starter eine von verschiedenen eai Projekten benötigte S3 Bucket Authorisierung.
Die S3 Credentials müssen als Umgebungsvariablen defniert sein, damit der S3ConfigProvider sie über seinen S3 Bucket Namen ermitteln kann. Siehe auch [README.md](docs%2FREADME.md).
<p align="right">(<a href="#top">nach oben</a>)</p>

*if you have a ROADMAP for your project add this here*
### Verwendete Technologien

Dieses Projekt verwendet die folgenden Technologien:

See the [open issues](#) for a full list of proposed features (and known issues).
- Spring Boot

<p align="right">(<a href="#top">nach oben</a>)</p>

## Set up
*how can i start and fly this project*
## Set up / Dokumentation
- [Mobidam S3 Dokumentation](https://github.com/it-at-m/mobidam-s3-eai/tree/main/docs)
- [Project README.md](docs%2FREADME.md)
<p align="right">(<a href="#top">nach oben</a>)</p>

## Documentation
*what insights do you have to tell*
<!-- CONTRIBUTING -->

```mermaid
graph TD;
A-->B;
A-->C;
B-->D;
C-->D;
```
## Beiträge

use [diagrams](https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/creating-diagrams).
Beiträge sind es, die die Open Source Community so wertvoll machen - zum Lernen und Erstellen sowie zur Inspiration.
Beiträge sind **sehr willkommen**:

## Contributing
Um Verbesserungsvorschläge einzureichen, öffne bitte ein _Issue_ mit dem _Tag_ "enhancement", erstelle einen _Fork_ des
Repos und
erzeuge einen _Pull Request_. Es ist natürlich auch möglich, nur ein Issue mit dem _Tag_ "enhancement" zu öffnen.

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.
Vielen Dank, dass du diesem Projekt einen _Star_ vergibst!

If you have a suggestion that would make this better, please open an issue with the tag "enhancement", fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".
Don't forget to give the project a star! Thanks again!
1. Öffne ein **Issue** mit dem Tag "enhancement"
2. Erstelle einen **Fork** des Projekts
3. Erzeuge deinen eigenen **Feature Branch** (`git checkout -b feature/AmazingFeature`)
4. **Commit** deine Änderungen (`git commit -m 'Add some AmazingFeature'`)
5. **Push** in den Feature Branch (`git push origin feature/AmazingFeature`)
6. Erstelle einen **Pull Request**

1. Open an issue with the tag "enhancement"
2. Fork the Project
3. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
4. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
5. Push to the Branch (`git push origin feature/AmazingFeature`)
6. Open a Pull Request
Mehr dazu in der Datei [CODE_OF_CONDUCT](/CODE_OF_CONDUCT.md) .

More about this in the [CODE_OF_CONDUCT](/CODE_OF_CONDUCT.md) file.
<p align="right">(<a href="#top">nach oben</a>)</p>

<!-- LICENSE -->

## License
## Lizensierung

Distributed under the MIT License. See [LICENSE](LICENSE) file for more information.
Die Distribution erfolgt unter der MIT License. Mehr dazu in der Datei [LICENSE](/LICENSE).

<p align="right">(<a href="#top">nach oben</a>)</p>

## Contact
<!-- CONTACT -->

it@M - [email protected]
## Kontakt

<!-- project shields / links -->
[made-with-love-shield]: https://img.shields.io/badge/made%20with%20%E2%9D%A4%20by-it%40M-yellow?style=for-the-badge
[itm-opensource]: https://opensource.muenchen.de/
it@m - [email protected]

<p align="right">(<a href="#top">nach oben</a>)</p>

<!-- MARKDOWN LINKS & IMAGES -->
<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->
5 changes: 5 additions & 0 deletions RELEASENOTES.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Release-Notes
## Sprint 18 (1.10.2024 - 22.10.2024)
### Hinzugefügt
- S3 Bucket Authorisierung.

Loading