Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Annotate DRAFT-FLOW.md with links to relevant issues/PRs #52

Merged
merged 2 commits into from
Oct 31, 2020
Merged

Annotate DRAFT-FLOW.md with links to relevant issues/PRs #52

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3754881
docs: annotate DRAFT-FLOW.md with links to relevant issues/PRs
dominykas Oct 27, 2020
46d13de
docs: annotate DRAFT-FLOW.md with links to relevant issues/PRs
dominykas Oct 27, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 19 additions & 13 deletions docs/DRAFT-FLOW.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,25 +1,31 @@
# Draft Flow

1. Define the list of dependents you want to test against in a `wiby.json`.
1. Define the list of dependents you want to test against in a `wiby.json`
- You can run `wiby test < random n | downloaded n >` to generate the list on demand.
- [ ] Basic support for `wiby.json`: [pr #45](https://github.com/pkgjs/wiby/pull/45)
- [ ] Random dependents: [issue #48](https://github.com/pkgjs/wiby/issues/48)
1. Ensure the release candidate commit/branch/tag is available on GitHub.
- `wiby` would also be able to run on a specific commit.
- [ ] Missing branch commit handling: [issue #46](https://github.com/pkgjs/wiby/issues/46)
1. Indicate that you want to start your dependent tests by running `wiby test` while on the commit/branch/tag you wish to test.
- It's also possible to specify this using `--commit=sha`.
- `wiby` will look for an existing log file for this HEAD, and error if it finds one. This will stop `wiby test` being run multiple times. You can override this check with `wiby test --overwrite`.
- You can also run `--url` to specify a single dependent to test.
`1. By default, `wiby` will look for your defined list of dependents to test against in `wiby.json`.
- You can supply a path to `wiby.json` with `--file`.
- [ ] It's also possible to specify this using `--commit=sha`: [issue #49](https://github.com/pkgjs/wiby/issues/49)
- [ ] `wiby` will look for an existing log file for this HEAD, and error if it finds one. This will stop `wiby test` being run multiple times. You can override this check with `wiby test --overwrite`: [issue #50](https://github.com/pkgjs/wiby/issues/50)
- [x] You can also run `--dependent` to specify a single dependent to test
1. By default, `wiby` will look for your defined list of dependents to test against in `wiby.json`.
- You can supply a path to `wiby.json` with `--config`.
- [ ] [pr #45](https://github.com/pkgjs/wiby/pull/45)
1. For each module in the `wiby.json`, retrieve their `package.json` and determine whether the module is likely to automatically be updated to the new version of your module once it is released.
- If the `--force` option is supplied then we will ignore this check.
- For example, if you're creating a release candidate for `v2.1.0-rc`, and the dependent module is using the range `^1.x.x`, then we should not open a test PR.
1. Patch the `package.json` of the dependent module to point to the release candidate branch for your module.
1. Run either `npm update` or `yarn upgrade`.
1. Create a commit for the `package.json` update and push to a consistently named branch on the dependent repository.
1. Open a draft PR in the dependents repository that contains the patched `package.json`.
- [ ] [issue #51](https://github.com/pkgjs/wiby/issues/51)
1. [x] Patch the `package.json` of the dependent module to point to the release candidate branch for your module.
1. ~~Run either `npm update` or `yarn upgrade`.~~ Rely on the dependent test system to install the correct version.
1. [x] Create a commit for the `package.json` update and push to a consistently named branch on the dependent repository.
1. [ ] Open a draft PR in the dependents repository that contains the patched `package.json`: [issue #53](https://github.com/pkgjs/wiby/issues/53)
1. `wiby` will create a JSON file (`wiby-v2.1.0.json`) which contains the links of dependent PRs that have been opened.
- [ ] recording the state: [issue #50](https://github.com/pkgjs/wiby/issues/50)
1. `wiby result` will loop through the run file (`wiby-v2.1.0.json`) and interact with the GitHub Checks API to determine whether the tests have passed.
- `wiby result` is a separate command as it is expected that tests will take some time to complete.
- [x] `wiby result` is a separate command as it is expected that tests will take some time to complete.

# wiby.json

Expand All @@ -30,12 +36,12 @@ Draft `wiby.json`
"dependents": [
{
"name": "express",
"repo": "git+https://....",
"repository": "git+https://....",
"triggers": ["all"],
},
{
"name": "express-session",
"repo": "git+https://....",
"repository": "git+https://....",
"triggers": ["rc"],
}
],
Expand Down