Skip to content

README.md, add repo types and branching model #38

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.

Sign up for GitHub

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

Open
jonenst wants to merge 3 commits into
base: main
Choose a base branch
from
Open

README.md, add repo types and branching model #38

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
856116f
README.md, add repo types and branching model
jonenst Mar 19, 2025
d960a85
Update README.md
jonenst Mar 20, 2025
ecb9e48
document permissions
jonenst Mar 21, 2025
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 README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,2 +1,22 @@
# github-ci
Generic CI workflows for powsybl repositories

There are dedicated workflows for each use cases:

* backend-app: java project built with maven and audited by sonar, published as docker images.
* backend-lib: java project built with maven and audited by sonar, published as maven artifacts.
* base-docker-image: dockerfile project, published as docker images.
* frontend-app: node project built with npm and audited by sonar, published as docker images.
* frontend-lib: node project built with npm and audited by sonar, published as npm packages.

Currently, the release/branching model differs between projects:
* backend-app, frontend-app, base-docker-image: can release at a recent commit on main. Releasing creates a branch there and patch releases can be done on these release branches.
* backend-lib: can release only the current tip of the main branch as a major or minor version. Patch releases can be done from release branches (needs admin right to create the release branch).
* backend-app: can release only the current tip of the main branch as a major or minor or patch version.

For release-frontend-lib, we require in the caller workflow
```yaml
permission:
contents: write # for creating github releases
id-token: write # for adding npm provenance
```