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.

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

misc: Update docs.cypress.io links to on.cypress.io #28623

Merged
merged 5 commits into from
Jan 5, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
7 changes: 5 additions & 2 deletions cli/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<!-- See the ../guides/writing-the-cypress-changelog.md for details on writing the changelog. -->
## 13.6.3

_Released 1/2/2024 (PENDING)_
_Released 1/16/2024 (PENDING)_

**Bugfixes:**

Expand All @@ -12,9 +12,12 @@ _Released 1/2/2024 (PENDING)_

**Dependency Updates:**

- Remove dependency on `@types/node` package. Addresses [#28473](https://github.com/cypress-io/cypress/issues/28473).
- Updated `@cypress/unique-selector` to include a performance optimization. It's possible this could improve performance of the selector playground. Addressed in [#28571](https://github.com/cypress-io/cypress/pull/28571).

- Remove dependency on `@types/node` package. Addresses [#28473](https://github.com/cypress-io/cypress/issues/28473).
**Misc:**

- Updated some documentation links to go through on.cypress.io. Addressed in [#28623](https://github.com/cypress-io/cypress/pull/28623).

## 13.6.2

Expand Down
14 changes: 7 additions & 7 deletions cli/types/cypress.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2637,7 +2637,7 @@ declare namespace Cypress {
* Time to wait (ms)
*
* @default defaultCommandTimeout
* @see https://docs.cypress.io/guides/references/configuration.html#Timeouts
* @see https://on.cypress.io/configuration#Timeouts
*/
timeout: number
}
Expand All @@ -2662,21 +2662,21 @@ declare namespace Cypress {
* Time to wait for the request (ms)
*
* @default {@link Timeoutable#timeout}
* @see https://docs.cypress.io/guides/references/configuration.html#Timeouts
* @see https://on.cypress.io/configuration#Timeouts
*/
requestTimeout: number
/**
* Time to wait for the response (ms)
*
* @default {@link Timeoutable#timeout}
* @see https://docs.cypress.io/guides/references/configuration.html#Timeouts
* @see https://on.cypress.io/configuration#Timeouts
*/
responseTimeout: number
}

/**
* Options to force an event, skipping Actionability check
* @see https://docs.cypress.io/guides/core-concepts/interacting-with-elements.html#Actionability
* @see https://on.cypress.io/interacting-with-elements#Actionability
*/
interface Forceable {
/**
Expand All @@ -2693,7 +2693,7 @@ declare namespace Cypress {

/**
* Options to affect Actionability checks
* @see https://docs.cypress.io/guides/core-concepts/interacting-with-elements.html#Actionability
* @see https://on.cypress.io/interacting-with-elements#Actionability
*/
interface ActionableOptions extends Forceable {
/**
Expand Down Expand Up @@ -2882,7 +2882,7 @@ declare namespace Cypress {
*/
baseUrl: string | null
/**
* Any values to be set as [environment variables](https://docs.cypress.io/guides/guides/environment-variables.html)
* Any values to be set as [environment variables](https://on.cypress.io/environment-variables)
* @default {}
*/
env: { [key: string]: any }
Expand All @@ -2902,7 +2902,7 @@ declare namespace Cypress {
*/
port: number | null
/**
* The [reporter](https://docs.cypress.io/guides/guides/reporters.html) used when running headlessly or in CI
* The [reporter](https://on.cypress.io/reporters) used when running headlessly or in CI
* @default "spec"
*/
reporter: string
Expand Down
2 changes: 1 addition & 1 deletion npm/webpack-dev-server/src/helpers/angularHandler.ts
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ export async function getProjectConfig (projectRoot: string): Promise<Cypress.An
defaultProject = Object.keys(angularJson.projects).find((name) => angularJson.projects[name].projectType === 'application')

if (!defaultProject) {
throw new Error('Could not find a project with projectType "application" in "angular.json". Visit https://docs.cypress.io/guides/references/configuration#Options-API to see how to pass in a custom project configuration')
throw new Error('Could not find a project with projectType "application" in "angular.json". Visit https://on.cypress.io/configuration to see how to pass in a custom project configuration')
}
}

Expand Down

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion packages/errors/src/errors.ts
Original file line number Diff line number Diff line change
Expand Up @@ -753,7 +753,7 @@ export const AllCypressErrors = {

${fmt.listItems(validEventNames)}

Learn more at https://docs.cypress.io/api/plugins/writing-a-plugin#config
Learn more at https://on.cypress.io/writing-a-plugin#config

${fmt.stackTrace(err)}
`
Expand Down
4 changes: 2 additions & 2 deletions packages/frontend-shared/src/locales/en-US.json
Original file line number Diff line number Diff line change
Expand Up @@ -395,7 +395,7 @@
"docsButton": {
"configGuide": {
"text": "Configuration guide",
"link": "https://docs.cypress.io/guides/references/configuration"
"link": "https://on.cypress.io/configuration"
},
"cloudGuide": {
"text": "Cypress Cloud guide",
Expand Down Expand Up @@ -653,7 +653,7 @@
"footer": {
"text": "You can reconfigure the {testingType} testing settings for this project if you're experiencing issues with your Cypress configuration.",
"button": "Configuration guide",
"buttonLink": "https://docs.cypress.io/guides/references/configuration"
"buttonLink": "https://on.cypress.io/configuration"
}
},
"runs": {
Expand Down
2 changes: 1 addition & 1 deletion system-tests/__snapshots__/plugins_spec.js
Original file line number Diff line number Diff line change
Expand Up @@ -368,7 +368,7 @@ The following are valid events:
- file:preprocessor
- task

Learn more at https://docs.cypress.io/api/plugins/writing-a-plugin#config
Learn more at https://on.cypress.io/writing-a-plugin#config

InvalidEventNameError: invalid event name registered: invalid:event
[stack trace lines]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ module.exports = {
setupNodeEvents (on, config) {
const plugin = require('./cypress/plugins')

// @see https://docs.cypress.io/guides/guides/screenshots-and-videos#Delete-videos-for-specs-without-failing-or-retried-tests
// @see https://on.cypress.io/screenshots-and-videos#Delete-videos-for-specs-without-failing-or-retried-tests
// for videoUploadOnPasses workaround, which was removed in Cypress v13.0.0
on(
'after:spec',
Expand Down