README.md

OpenAPI des Projektassistenten

Organisation

• release/* sind Release-Branches
• Code kann auf Release-Branches nur mittels PR gemerged werden.
• Jeder Merge auf release/* generiet automatisch einen neuen Release-Entwurf im GitHub.
• Sobald der Release-Entwurf veröffentlich wird, dann werden die Artefakte für Maven und NPM gebaut.
• Die Version wird manuell in der src/openapi.yml gepflegt.
• Die OpenAPI wird wie gewohnt im src/-Verzeichnis designed.

Verwendung

GitHub Personal Access Tokens

Projekte die die versionierten Artefakt der Projektassistent-OpenAPI wiederverwenden möchten, müssen das mittels des GitHub Personal Access Tokens (https://github.com/settings/tokens) tun.

Für die GitHub-Workflows wurden die beiden Secrets GitHub Personal Access Tokens und Benutzername in den Organisationseinstellungen (https://github.com/organizations/DiPA-Projekt/settings/secrets/actions) hinterlegt. Die GitHub-Workflows in unsere GitHub-Organisation können diesen über den Secret-Namen GIT_HUB_PACKAGES_TOKEN und GIT_HUB_PACKAGES_USER zum Installieren von Abhängigkeiten aus unseren Organisationsrepository verwenden.

Scopes einstellen

• Maven: https://docs.github.com/en/packages/guides/configuring-apache-maven-for-use-with-github-packages
• NPM: https://docs.github.com/en/packages/guides/configuring-npm-for-use-with-github-packages

Referenzen

• https://github.jparrowsec.cnmunity/t/how-to-allow-unauthorised-read-access-to-github-packages-maven-repository/115517