Skip to content

refactor: sort and comment action.yml options#1434

Merged
jennifer-shehane merged 1 commit into
cypress-io:masterfrom
MikeMcC399:refactor/re-order-options
Apr 24, 2025
Merged

refactor: sort and comment action.yml options#1434
jennifer-shehane merged 1 commit into
cypress-io:masterfrom
MikeMcC399:refactor/re-order-options

Conversation

@MikeMcC399
Copy link
Copy Markdown
Collaborator

Situation

The action options, defined in action.yml, are listed in an apparent arbitrary order. This is a barrier to maintenance, referral and documentation.

Change

List the action options in action.yml in alphabetical order, separated into options used in the action and those passed to the Cypress Module API.

Cross-reference in comments to the following sets of options:

@MikeMcC399 MikeMcC399 added the documentation Improvements or additions to documentation label Apr 24, 2025
@MikeMcC399 MikeMcC399 self-assigned this Apr 24, 2025
@cypress-app-bot
Copy link
Copy Markdown
Collaborator

@MikeMcC399

This comment was marked as outdated.

@MikeMcC399 MikeMcC399 marked this pull request as ready for review April 24, 2025 12:51
@jennifer-shehane jennifer-shehane merged commit 5b741b0 into cypress-io:master Apr 24, 2025
76 checks passed
@MikeMcC399 MikeMcC399 deleted the refactor/re-order-options branch April 24, 2025 14:20
@github-actions
Copy link
Copy Markdown

🎉 This PR is included in version 6.8.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

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

Labels

documentation Improvements or additions to documentation released

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants