Skip to content

Commit 86b02f3

Browse files
chore: remove master branch from dev workflow
1 parent 11dc3c1 commit 86b02f3

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

46 files changed

+83
-224
lines changed

.circleci/config.yml

+1-2
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,6 @@ linuxWorkflowExcludeFilters: &linux-x64-workflow-exclude-filters
5555
unless:
5656
or:
5757
- false
58-
# - equal: [ 'tgriesser/chore/fix-windows-build', << pipeline.git.branch >> ]
5958

6059
# windows is slow and expensive in CI, so it normally only runs on main branches
6160
# add your branch to this list to run the full Windows build on your PR
@@ -1031,7 +1030,7 @@ commands:
10311030
# by default, electron-builder will NOT sign app built in a pull request
10321031
# even our internal one (!)
10331032
# Usually this is not a problem, since we only build and test binary
1034-
# built on "develop" and "master" branches
1033+
# built on "develop" branches
10351034
# but if you need to really build and sign a binary in a PR
10361035
# set variable CSC_FOR_PULL_REQUEST=true
10371036
command: |

.github/workflows/merge-master-into-develop.yml

-79
This file was deleted.

.github/workflows/snyk_sca_scan.yaml

+1-2
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,13 @@
11
name: Snyk Software Composition Analysis Scan
22
# This git workflow leverages Snyk actions to perform a Software Composition
3-
# Analysis scan on our Opensource libraries upon Pull Requests to Master &
3+
# Analysis scan on our Opensource libraries upon Pull Requests to
44
# Develop branches. We use this as a control to prevent vulnerable packages
55
# from being introduced into the codebase.
66
on:
77
pull_request_target:
88
types:
99
- opened
1010
branches:
11-
- master
1211
- develop
1312
jobs:
1413
Snyk_SCA_Scan:

.github/workflows/snyk_static_analysis_scan.yaml

+1-2
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,13 @@
11
name: Snyk Static Analysis Scan
22
# This git workflow leverages Snyk actions to perform a Static Application
3-
# Testing scan (SAST) on our first-party code upon Pull Requests to Master &
3+
# Testing scan (SAST) on our first-party code upon Pull Requests to
44
# Develop branches. We use this as a control to prevent vulnerabilities
55
# from being introduced into the codebase.
66
on:
77
pull_request_target:
88
types:
99
- opened
1010
branches:
11-
- master
1211
- develop
1312
jobs:
1413
Snyk_SAST_Scan :

.releaserc.base.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,6 @@ module.exports = {
1515
],
1616
extends: 'semantic-release-monorepo',
1717
branches: [
18-
'master',
18+
{ name: 'develop', channel: 'latest' },
1919
],
2020
}

.releaserc.js

-4
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,3 @@
11
module.exports = {
22
...require('./.releaserc.base'),
3-
branches: [
4-
'master',
5-
{ name: 'chore/webpack-5', channel: 'channel-next' },
6-
],
73
}

CONTRIBUTING.md

+11-24
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@ Thanks for taking the time to contribute! :smile:
44

55
**Once you learn how to use Cypress, you can contribute in many ways:**
66

7-
- Join the [Cypress Discord](https://on.cypress.io/discord) and answer questions. Teaching others how to use Cypress is a great way to learn more about how it works.
8-
- Blog about Cypress. We display blogs featuring Cypress on our [Examples](https://on.cypress.io/examples) page. If you'd like your blog featured, [open a PR to add it to our docs](https://github.com/cypress-io/cypress-documentation/blob/develop/CONTRIBUTING.md#adding-examples).
7+
- Join the [Cypress Discord](https://on.cypress.io/chat) and answer questions. Teaching others how to use Cypress is a great way to learn more about how it works.
8+
- Blog about Cypress. We display blogs featuring Cypress on our [Examples](https://on.cypress.io/examples) page. If you'd like your blog featured, [open a PR to add it to our docs](https://github.com/cypress-io/cypress-documentation/blob/master/CONTRIBUTING.md#adding-examples).
99
- Write some documentation or improve our existing docs. See our [guide to contributing to our docs](https://github.com/cypress-io/cypress-documentation/blob/master/CONTRIBUTING.md).
1010
- Give a talk about Cypress. [Contact us](mailto:support@cypress.io) ahead of time and we'll send you some swag. :shirt:
1111

@@ -508,28 +508,13 @@ They will outline development and test procedures. When in doubt just look at th
508508

509509
### Branches
510510

511-
The repository is setup with two main (protected) branches.
511+
The repository has one protected branch:
512512

513-
- `master` is the code already published, both for the main Cypress app and independent npm packages.
514-
- `develop` is the current latest "pre-release" code. This branch is set as the default branch, and all pull requests that update the main Cypress binary should be made against this branch.
513+
- `develop` contains the current latest "pre-release" code for the Cypress app and contains the already published code of all [standalone npm packages](./npm) Cypress maintains. This branch is set as the default branch, and all pull requests should be made against this branch.
515514

516-
In general, we want to publish our [standalone npm packages](./npm) continuously as new features are added. Therefore, any pull requests that only change independent `@cypress/` packages in the [`npm`](./npm) directory should be made directly off the `master` branch. We use [`semantic-release`](https://semantic-release.gitbook.io/semantic-release/) to automatically publish these packages to npm when a PR is merged directly into master.
515+
We want to publish our [standalone npm packages](./npm) continuously as new features are added. Therefore, after any pull request that changes independent `@cypress/` packages in the [`npm`](./npm) directory will automatically publish when a PR is merged directly into `develop` and the entire build passes. We used [`semantic-release`](https://semantic-release.gitbook.io/semantic-release/) to automate the release of these packages to npm.
517516

518-
When updating the main Cypress app, pull requests should be made against the `develop` branch. We do not continuously deploy the Cypress binary, so `develop` contains all of the new features and fixes that are staged to go out in the next update of the main Cypress app. In addition, if you make changes to an npm package that can't be published until the binary is also updated, you should make a pull request against the `develop` branch.
519-
520-
Essentially, if you only change files within the [`npm`](./npm) folder, then you should make a pull request against `master`. Otherwise, make it against `develop`.
521-
522-
All updates to `master` are automatically merged into `develop`, so `develop` always has the latest version of every package.
523-
524-
#### Workflow Diagrams
525-
526-
<!-- To edit these diagrams, visit [`./assets/DIAGRAMS`](./assets/DIAGRAMS.md) -->
527-
<img src="./assets/branching-diagram.png" />
528-
<img src="./assets/sample-workflow.png" />
529-
530-
### Independent Packages CI Workflow
531-
532-
Independent packages are automatically released when code is merged into `master` and the entire build passes.
517+
We do not continuously deploy the Cypress binary, so `develop` contains all of the new features and fixes that are staged to go out in the next update of the main Cypress app. If you make changes to an npm package that can't be published until the binary is also updated, you should make a pull request against specifying this is not be merged until the scheduled Cypress app release date.
533518

534519
### Pull Requests
535520

@@ -636,11 +621,13 @@ Below are some guidelines Cypress uses when reviewing dependency updates.
636621
- [ ] The PR been tagged with a release in ZenHub.
637622
- [ ] Appropriate labels have been added to the PR (for example: label `type: breaking change` if it is a breaking change)
638623

639-
## Deployment
624+
## Releases
625+
626+
[Standalone npm packages](./npm) are deployed immediately when a PR is merged into `develop` and the entire build passes.
640627

641-
We will try to review and merge pull requests quickly. If you want to know our build process or build your own Cypress binary, read [the "Release Process" guide](./guides/release-process.md).
628+
The Cypress app is typically released every two weeks. All PRs merged to `develop` will build a "pre-released" Cypress app which can be installed to verify or leverage your changes before the scheduled release. Read these instructions for [installing pre-release versions](https://docs.cypress.io/guides/references/advanced-installation#Install-pre-release-version).
642629

643-
Independent packages are deployed immediately upon being merged into master. You can read more [above](#independent-packages-ci-workflow).
630+
If you want to know our build process or build your own Cypress binary, read [the "Release Process" guide](./guides/release-process.md).
644631

645632
## Known problems
646633

README.md

+1-2
Original file line numberDiff line numberDiff line change
@@ -64,13 +64,12 @@ yarn add cypress --dev
6464
## Contributing
6565

6666
- [![CircleCI](https://circleci.com/gh/cypress-io/cypress/tree/develop.svg?style=svg)](https://circleci.com/gh/cypress-io/cypress/tree/develop) - `develop` branch
67-
- [![CircleCI](https://circleci.com/gh/cypress-io/cypress/tree/master.svg?style=svg)](https://circleci.com/gh/cypress-io/cypress/tree/master) - `master` branch
6867

6968
Please see our [Contributing Guideline](./CONTRIBUTING.md) which explains repo organization, linting, testing, and other steps.
7069

7170
## License
7271

73-
[![license](https://img.shields.io/badge/license-MIT-green.svg)](https://github.com/cypress-io/cypress/blob/master/LICENSE)
72+
[![license](https://img.shields.io/badge/license-MIT-green.svg)](https://github.com/cypress-io/cypress/blob/develop/LICENSE)
7473

7574
This project is licensed under the terms of the [MIT license](/LICENSE).
7675

assets/DIAGRAMS.md

-16
This file was deleted.

assets/branching-diagram.png

-43.1 KB
Binary file not shown.

assets/sample-workflow.png

-46.5 KB
Binary file not shown.

0 commit comments

Comments
 (0)