Skip to content

Commit 279bad8

Browse files
authored
update README with extra details (#24)
1 parent eeb6753 commit 279bad8

File tree

1 file changed

+12
-3
lines changed

1 file changed

+12
-3
lines changed

README.md

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -60,8 +60,17 @@ This section is temporary. To create a sample promotion Pull Request, until http
6060
./services promote --from [https://github.com/mnuttall/gitops-repo-testing] --to [https://github.com/mnuttall/staging] --service service-a`
6161
```
6262

63-
We need to remove the local cache between requests. See https://github.com/rhd-gitops-example/services/issues/20. Until then, add `rm -rf ~/.promotion/cache; ` before subsequent requests.
63+
At a high level the services command currently:
6464

65-
New pull requests need new branches. Add `--branch [unique branch name]` before submitting further promotion PRs. See https://github.com/rhd-gitops-example/services/issues/21.
65+
- git clones the source and target repositories into ~/.promotion/cache
66+
- creates a branch (as per the given --branch-name)
67+
- checks out the branch
68+
- copies the relevant files from the cloned source into the cloned target
69+
- pushes the cloned target
70+
- creates a PR from the new branch in the target to master in the target
6671

67-
See https://github.com/rhd-gitops-example/services/issues/19 for an issue related to problems 'promoting' config from a source repo into a gitops repo.
72+
Important Notes:
73+
74+
- We need to remove the local cache between requests. See https://github.com/rhd-gitops-example/services/issues/20. Until then, add `rm -rf ~/.promotion/cache; ` before subsequent requests.
75+
- New pull requests need new branches (i.e you cannot run the same command twice). Add `--branch [unique branch name]` before submitting further promotion PRs. See https://github.com/rhd-gitops-example/services/issues/21.
76+
- See https://github.com/rhd-gitops-example/services/issues/19 for an issue related to problems 'promoting' config from a source repo into a gitops repo.

0 commit comments

Comments
 (0)