Skip to content

Missing history for re-purposing of env Module API parameter #6891

Description

@MikeMcC399

Description

Situation

The Module API is documented on https://docs.cypress.io/app/references/module-api

https://github.com/cypress-io/cypress-documentation/blob/main/docs/app/run-tests/module-api.mdx#options lists

Option Type Description
env object Specify secret environment variables
expose object Specify public exposed variables

with History including

Version Changes
15.10.0 Added expose configuration option.

The change to restricting env for use with only secret environment variables is not documented in the history section.

Background

Specify environment variables

to

Specify secret environment variables

Request

Please document and clarify the re-purposing of env between Cypress 15.10.0 and Cypress 16.

Presumably the change with Cypress 15.10.0 was the documentation-only deprecation of its use for non-secret environment variables.

Removal would have come with Cypress 16.0.0.

I'm just going by deduction here, so I would appreciate confirmation and documentation for reference from the cypress-io/github-action repo.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions