forked from forge/forge
Update README
Signed-off-by: Lenka Segura <lsegura@redhat.com>
This commit is contained in:
parent
ce6bc9fa7e
commit
3ec0825bfc
1 changed files with 5 additions and 12 deletions
17
README.md
17
README.md
|
|
@ -50,13 +50,13 @@ update the git tag [in the image.](https://codeberg.org/fedora/oci-image-definit
|
|||
|
||||
### Image Build Triggering
|
||||
The [`trigger_konflux_build` workflow](`.forgejo/workflows/trigger_konflux_build.yml`) is automatically executed on every push to:
|
||||
- `main`
|
||||
- `v*/forgejo` branches
|
||||
- `staging`
|
||||
- `production` branches
|
||||
|
||||
This workflow creates a "Commit bump" commit in the [fedora/oci_image_definitions](https://codeberg.org/fedora/oci-image-definitions) repository, which is mirrored to [github.com/fedora-infra/forgejo-oci-images](https://github.com/fedora-infra/forgejo-oci-images/). This triggers the Konflux build pipeline for new image generation.
|
||||
|
||||
### Pull Request Synchronization
|
||||
The [`gh_pr_sync` workflow](`.forgejo/workflows/gh_pr_sync.yml`) runs daily to synchronize patches from Konflux back to the Codeberg mirror.
|
||||
### Konflux Pull Request Synchronization
|
||||
The [`gh_pr_sync` workflow](`.github/workflows/gh_pr_sync.yml`) runs at every fedora-konflux pull request opened at the github repo. The action open a pull request on the codeberg side for review and synchronize both repositories.
|
||||
|
||||
## Development guidelines
|
||||
|
||||
|
|
@ -65,14 +65,7 @@ The [`gh_pr_sync` workflow](`.forgejo/workflows/gh_pr_sync.yml`) runs daily to s
|
|||
1. Optimize commit history by squashing commits to the minimum necessary
|
||||
2. Follow the principle of one commit per feature/PR where possible
|
||||
3. Use `rebase and fast-forward` merging strategy to avoid unnecessary merge commits
|
||||
4. Tag the last commit with \<forgejo version\>-\<number of fedora-specific commits\>.
|
||||
|
||||
Example:
|
||||
```
|
||||
git tag v12.0.0-13
|
||||
git push <remote> <tagname>
|
||||
```
|
||||
5. Make sure your commit passes the [CI checks](https://ci.codeberg.org/repos/14821) (at least to a level of the current last commit in the main branch). Bear in mind that CI runs on pull-requests need your approval.
|
||||
4. Make sure your commit passes the [CI checks](https://ci.codeberg.org/repos/14821) (at least to a level of the current last commit in the main branch). Bear in mind that CI runs on pull-requests need your approval.
|
||||
|
||||
These practices ensure a clean, maintainable codebase and simplify the integration of Fedora-specific modifications.
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue