You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+23-2Lines changed: 23 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -40,10 +40,11 @@ activate RemoteRepo
40
40
User-->RemoteRepo: fork and clone repository
41
41
activate LocalRepo
42
42
User->>LocalRepo: update CI destination
43
+
LocalRepo->>RemoteRepo: push CI changes to remote
44
+
activate RemoteRepo
43
45
User->>LocalRepo: update 'catalog' target
46
+
LocalRepo->>RemoteRepo: push changes to remote
44
47
deactivate LocalRepo
45
-
activate RemoteRepo
46
-
User->>RemoteRepo: push changes to remote
47
48
deactivate User
48
49
RemoteRepo--xGHAction: <<push trigger>
49
50
deactivate RemoteRepo
@@ -54,8 +55,28 @@ activate CatalogRepo
54
55
GHAction->>CatalogRepo: Open PR in catalog destination
55
56
deactivate GHAction
56
57
deactivate CatalogRepo
58
+
57
59
```
58
60
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
+
59
80
<!--
60
81
## Demo
61
82
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