Skip to content

Commit

Permalink
EDPC-2544 Update docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
zxBCN Valeriu_Tuguran,Constantin (IT EDP) EXTERNAL committed Sep 17, 2024
1 parent 6cddc64 commit 961cc59
Showing 1 changed file with 2 additions and 6 deletions.
8 changes: 2 additions & 6 deletions docs/modules/quickstarters/pages/release-manager.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -25,13 +25,12 @@ name: Project Phoenix
repositories:
- id: A
branch: master
- id: B
name: my-repo-B
branch: master
- id: C
----

For all repositories mentioned above (A, B, C) the library will resolve the default branch configured in each.
If a named repository wants to announce a dependency on another repo, the dependency needs to be listed in that repository's `release-manager.yml`, simply by referring to its `repo.id` as defined in `metadata.yml`:

----
Expand All @@ -47,11 +46,9 @@ name: Project Phoenix
repositories:
- id: A
branch: master
type: ods
- id: B
name: my-repo-B
branch: master
type: ods
- id: C
type: ods
Expand Down Expand Up @@ -85,7 +82,6 @@ name: Project Phoenix
repositories:
- id: B
name: my-repo-B
branch: master
----

Assuming your release manager component's origin at `https://github.com/my-org/my-pipeline.git` in this example, the Git URL for repository `B` will resolve to `https://github.com/my-org/my-repo-B.git`, based on the value in `repositories[0].name`.
Expand All @@ -104,7 +100,7 @@ Assuming your release manager component's origin at `https://github.com/my-org/m

=== Automated Resolution of Repository Branch

If no `branch` parameter is provided for a repository, `master` will be assumed.
The default branch configured for the repository will be considered.

=== Automated Parallelization of Repositories

Expand Down

0 comments on commit 961cc59

Please sign in to comment.