Cypress.env deprecation / cy.env addition

[MikeMcC399]

Current behavior

• The example directory examples/env uses the Cypress.env() API call to get environment variables in tests. These are non-secret environment variables. The related workflow example-env.yml refers to this usage in comments.

• PR feat: add cy.env(), allowCypressEnv, and deprecate Cypress.env() cypress#33181 indicates that Cypress plans to deprecate Cypress.env() and introduce cy.env() in a future release.

Desired behavior

• Follow developments in Cypress and migrate usage of Cypress.env() as appropriate, and at an appropriate time, to avoid demonstrating any deprecated API usage and instead demonstrate handling environment variables according to updated recommendations.

[MikeMcC399]

Migrating away from Cypress.env() has been published

[MikeMcC399]

The convenience documentation link https://on.cypress.io/environment-variables redirects to a page on https://on.cypress.io/environment-variables that no longer exists. See cypress-io/cypress-documentation#6364.

[MikeMcC399]

Migrating the examples in this repo to use new API functions that are only available in Cypress >=15.10.0 would mean that the examples would no longer be compatible with earlier Cypress versions. Effectively the use of new API functions from Cypress >= 15.10.0 would be a breaking change in this repo.

I suggest to delay any related updates here until Cypress 16 is available.

The new API can be demonstrated in https://github.com/cypress-io/cypress-example-kitchensink, where GitHub Actions examples workflows are also available.