Skip to content

Commit

Permalink
Merge branch 'develop' of github.com:cypress-io/cypress into fix/stri…
Browse files Browse the repository at this point in the history
…pped-integrity-dynamic
  • Loading branch information
AtofStryker committed Sep 20, 2022
2 parents bf186e5 + 6984a1a commit d7a3839
Show file tree
Hide file tree
Showing 46 changed files with 85 additions and 226 deletions.
3 changes: 1 addition & 2 deletions .circleci/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,6 @@ linuxWorkflowExcludeFilters: &linux-x64-workflow-exclude-filters
unless:
or:
- false
# - equal: [ 'tgriesser/chore/fix-windows-build', << pipeline.git.branch >> ]

# windows is slow and expensive in CI, so it normally only runs on main branches
# add your branch to this list to run the full Windows build on your PR
Expand Down Expand Up @@ -1031,7 +1030,7 @@ commands:
# by default, electron-builder will NOT sign app built in a pull request
# even our internal one (!)
# Usually this is not a problem, since we only build and test binary
# built on "develop" and "master" branches
# built on the "develop" branch
# but if you need to really build and sign a binary in a PR
# set variable CSC_FOR_PULL_REQUEST=true
command: |
Expand Down
79 changes: 0 additions & 79 deletions .github/workflows/merge-master-into-develop.yml

This file was deleted.

5 changes: 2 additions & 3 deletions .github/workflows/snyk_sca_scan.yaml
Original file line number Diff line number Diff line change
@@ -1,14 +1,13 @@
name: Snyk Software Composition Analysis Scan
# This git workflow leverages Snyk actions to perform a Software Composition
# Analysis scan on our Opensource libraries upon Pull Requests to Master &
# Develop branches. We use this as a control to prevent vulnerable packages
# Analysis scan on our Opensource libraries upon Pull Requests to the
# "develop" branch. We use this as a control to prevent vulnerable packages
# from being introduced into the codebase.
on:
pull_request_target:
types:
- opened
branches:
- master
- develop
jobs:
Snyk_SCA_Scan:
Expand Down
5 changes: 2 additions & 3 deletions .github/workflows/snyk_static_analysis_scan.yaml
Original file line number Diff line number Diff line change
@@ -1,14 +1,13 @@
name: Snyk Static Analysis Scan
# This git workflow leverages Snyk actions to perform a Static Application
# Testing scan (SAST) on our first-party code upon Pull Requests to Master &
# Develop branches. We use this as a control to prevent vulnerabilities
# Testing scan (SAST) on our first-party code upon Pull Requests to the
# "develop" branch. We use this as a control to prevent vulnerabilities
# from being introduced into the codebase.
on:
pull_request_target:
types:
- opened
branches:
- master
- develop
jobs:
Snyk_SAST_Scan :
Expand Down
2 changes: 1 addition & 1 deletion .releaserc.base.js
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,6 @@ module.exports = {
],
extends: 'semantic-release-monorepo',
branches: [
'master',
{ name: 'develop', channel: 'latest' },
],
}
4 changes: 0 additions & 4 deletions .releaserc.js
Original file line number Diff line number Diff line change
@@ -1,7 +1,3 @@
module.exports = {
...require('./.releaserc.base'),
branches: [
'master',
{ name: 'chore/webpack-5', channel: 'channel-next' },
],
}
35 changes: 11 additions & 24 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@ Thanks for taking the time to contribute! :smile:

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

- 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.
- 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).
- 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.
- 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).
- 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).
- Give a talk about Cypress. [Contact us](mailto:[email protected]) ahead of time and we'll send you some swag. :shirt:

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

### Branches

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

- `master` is the code already published, both for the main Cypress app and independent npm packages.
- `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.
- `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.

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.
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.

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.

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`.

All updates to `master` are automatically merged into `develop`, so `develop` always has the latest version of every package.

#### Workflow Diagrams

<!-- To edit these diagrams, visit [`./assets/DIAGRAMS`](./assets/DIAGRAMS.md) -->
<img src="./assets/branching-diagram.png" />
<img src="./assets/sample-workflow.png" />

### Independent Packages CI Workflow

Independent packages are automatically released when code is merged into `master` and the entire build passes.
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.

### Pull Requests

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

## Deployment
## Releases

[Standalone npm packages](./npm) are deployed immediately when a PR is merged into `develop` and the entire build passes.

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).
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).

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

## Known problems

Expand Down
3 changes: 1 addition & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,13 +64,12 @@ yarn add cypress --dev
## Contributing

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

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

## License

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

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

Expand Down
16 changes: 0 additions & 16 deletions assets/DIAGRAMS.md

This file was deleted.

Binary file removed assets/branching-diagram.png
Binary file not shown.
Binary file removed assets/sample-workflow.png
Binary file not shown.
Loading

0 comments on commit d7a3839

Please sign in to comment.