Skip to content

Replace Migration guide in README with Changelog#769

Merged
jaffrepaul merged 1 commit into
cypress-io:masterfrom
MikeMcC399:update/migration-guide
Feb 3, 2023
Merged

Replace Migration guide in README with Changelog#769
jaffrepaul merged 1 commit into
cypress-io:masterfrom
MikeMcC399:update/migration-guide

Conversation

@MikeMcC399

@MikeMcC399 MikeMcC399 commented Feb 2, 2023

Copy link
Copy Markdown
Collaborator

This PR resolves issue #768 "Migration details in README are outdated"

It adds a short Changelog summary to the bottom of the README file for each released version concerning the breaking changes which caused the version number to be bumped.

This replaces the Migration guide section which was outdated and did not actually provide any guidance.

@jaffrepaul jaffrepaul added the documentation Improvements or additions to documentation label Feb 3, 2023

@jaffrepaul jaffrepaul left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

@jaffrepaul jaffrepaul merged commit ca3f666 into cypress-io:master Feb 3, 2023
@github-actions

github-actions Bot commented Feb 3, 2023

Copy link
Copy Markdown

🎉 This PR is included in version 5.0.8 🎉

The release is available on:

Your semantic-release bot 📦🚀

@MikeMcC399 MikeMcC399 deleted the update/migration-guide branch February 3, 2023 18:29
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.

2 participants