forked from meinaart/cypress-plugin-snapshots
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Ed Campbell
authored and
David Fraser
committed
Apr 3, 2020
1 parent
7716463
commit 1854f7e
Showing
1 changed file
with
31 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,31 @@ | ||
# Patching the plugin | ||
|
||
## Git workflow | ||
|
||
To patch an upstream release create a corresponding `releases/vX.Y.Z` branch in the CityScience | ||
fork, apply any changes e.g. cherry-pick commits from earlier release branches and then tag this | ||
branch. For example: | ||
|
||
```bash | ||
git clone [email protected]:CityScience/cypress-plugin-snapshots.git | ||
cd cypress-plugin-snapshots | ||
git remote add upstream [email protected]:meinaart/cypress-plugin-snapshots.git | ||
git fetch --all --tags | ||
git checkout -b releases/v1.2.9 v1.2.9 | ||
# Apply fixes/patches and commit to release branch, get it reviewed etc. | ||
git tag v1.2.9-csc | ||
git push origin --tags | ||
``` | ||
|
||
The tag name should match the corresponding tag from upstream, with `-csc` appended to it. | ||
|
||
## Testing | ||
|
||
To test a modified release: | ||
|
||
```bash | ||
npm install | ||
npm install --prefix cypress | ||
npm run ci:test | ||
``` | ||
|