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

docs: improve "explicit version" section in readme #852

Merged
merged 1 commit into from
Mar 29, 2023

Conversation

MikeMcC399
Copy link
Collaborator

@MikeMcC399 MikeMcC399 commented Mar 27, 2023

This PR re-works the README section: Explicit version.

The text is simplified, corrected and the heading is renamed using the more neutral "Action version" instead of "Explicit version".

  • v5 is clarified as being the latest version
  • Selecting cypress-io/github-action@v5 is using a branch name, not a tag name. (There is no tag v5.)
  • In addition to referring to GitHub's tags list, the releases list and Changelog are also linked

@MikeMcC399
Copy link
Collaborator Author

The text is conveniently reviewable under https://github.com/MikeMcC399/github-action/blob/docs/version-selection/README.md#action-version.

Once this section is stable I would submit a follow-on PR to align https://docs.cypress.io/guides/continuous-integration/github-actions#Explicit-Version-Number with the repo README text.

@MikeMcC399 MikeMcC399 marked this pull request as draft March 28, 2023 22:02
@MikeMcC399

This comment was marked as resolved.

rename "Explicit version" to "Action version"
@MikeMcC399 MikeMcC399 marked this pull request as ready for review March 29, 2023 12:43
@emilyrohrbough emilyrohrbough merged commit d7cc252 into cypress-io:master Mar 29, 2023
@MikeMcC399 MikeMcC399 deleted the docs/version-selection branch March 29, 2023 14:52
@emilyrohrbough emilyrohrbough removed their assignment Mar 30, 2023
@github-actions
Copy link

github-actions bot commented May 1, 2023

🎉 This PR is included in version 5.6.2 🎉

The release is available on:

Your semantic-release bot 📦🚀

@MikeMcC399 MikeMcC399 added the documentation Improvements or additions to documentation label Jan 23, 2024
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.

None yet

3 participants