Skip to content

Commit 0496787

Browse files
committed
another readme pass
1 parent 41d9d9c commit 0496787

File tree

1 file changed

+23
-2
lines changed

1 file changed

+23
-2
lines changed

README.md

Lines changed: 23 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,10 +40,11 @@ activate RemoteRepo
4040
User-->RemoteRepo: fork and clone repository
4141
activate LocalRepo
4242
User->>LocalRepo: update CI destination
43+
LocalRepo->>RemoteRepo: push CI changes to remote
44+
activate RemoteRepo
4345
User->>LocalRepo: update 'catalog' target
46+
LocalRepo->>RemoteRepo: push changes to remote
4447
deactivate LocalRepo
45-
activate RemoteRepo
46-
User->>RemoteRepo: push changes to remote
4748
deactivate User
4849
RemoteRepo--xGHAction: <<push trigger>
4950
deactivate RemoteRepo
@@ -54,8 +55,28 @@ activate CatalogRepo
5455
GHAction->>CatalogRepo: Open PR in catalog destination
5556
deactivate GHAction
5657
deactivate CatalogRepo
58+
5759
```
5860

61+
1. Fork and Clone Remote Repository
62+
IMPORTANT! Skip this step, and any changes will be ignored.
63+
64+
2. Update CI Destination
65+
Customize ci.yaml in .github/workflows/ci.yaml to your needs, setting the destination_repo to the URI of your catalog repository.
66+
67+
3. Push Changes to Remote
68+
Push the CI changes to the remote branch so they will be ready/able to trigger when you later push catalog contributions
69+
70+
4. Update 'catalog' target
71+
Locally, update the catalog target in the Makefile to generate your FBC. Example targets are provided in the Makefile (with supporting artifacts) to support to the following scenarios:
72+
1. basic veneer generates FBC
73+
2. semver veneer generates FBC
74+
3. compound veneer generates and post-processes FBC
75+
5. Push Changes to Remote
76+
Once happy with the state of the `catalog` make target and the resulting FBC, push the changes to the remote repository. This will trigger the remote actions to generate a pull request against the destination catalog repository as specified in #2.
77+
78+
79+
5980
<!--
6081
## Demo
6182
Recorded demo of modifying a `basic veneer` file "basic-veneer.yaml", generating an FBC from it, and pushing that FBC as a PR to a catalog repository.

0 commit comments

Comments
 (0)