Skip to content

Commit 649eb04

Browse files
committed
docs: add details on usage
1 parent 7a4c112 commit 649eb04

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

docs/github-workflow.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,3 +16,15 @@ This is a manual step, until automation is ready:
1616
- create a new one at https://github.com/settings/tokens, required scopes: `repo:status` and `public_repo`
1717
- the account has to have push access to the test repositories - you will probably want to fork the dependents into that account (or a separate organization)
1818
- you may want to use a robot account which _does not have **any** merge access_, as Github does not allow restricting tokens to a subset of repositories
19+
20+
21+
## Usage
22+
23+
0. This assumes `.wiby.json` is already configured and that you're an owner or a contributor on the dependency repo
24+
1. Open a PR against the dependency repository
25+
2. Post a comment saying `wiby test` in the PR
26+
- This should kick off the test workflow and update the `package.json` of configured dependents
27+
- Shortly after that, a `wiby` status check will have its status set to `pending`
28+
3. Wait a reasonable amount of time for the dependents to finish their tests
29+
4. Post a comment saying `wiby result`
30+
- Shortly after that, the `wiby` status check will changes its status to report the results of the tests in the dependents (but it may stay pending if they're still running)

0 commit comments

Comments
 (0)