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

devops: make README.md to always reflect tip-of-tree #1911

Conversation

aslushnikov
Copy link
Collaborator

As of today, we have tooling in place that makes sure that our
main README.md roughly represents the state of the last release:

  • browser versions and browser badges are those that we released last
  • links to our API point to the last-released API version

This tooling, however, relies on the fact that every release is a sequence
of two consecutive commits:

  • one commit that sets package.json version to a released version
  • the following that "bumps" version to -post.

This release process is very unfortunate, because:

  • it made releasing from branch impossible
  • it required "freezing" commits to the master branch

This patch removes all the tooling and transitions README.md to always
represent tip-of-tree state. We will fully rely on
https://playwright.dev to show versioned docs.

As of today, we have tooling in place that makes sure that our
main README.md **roughly** represents the state of the last release:
- browser versions and browser badges are those that we released last
- links to our API point to the last-released API version

This tooling, however, relies on the fact that every release is a sequence
of two consecutive commits:
- one commit that sets `package.json` version to a released version
- the following that "bumps" version to `-post`.

This release process is very unfortunate, because:
- it made releasing from branch impossible
- it required "freezing" commits to the master branch

This patch removes all the tooling and transitions `README.md` to always
represent tip-of-tree state. We will fully rely on
`https://playwright.dev` to show versioned docs.
@aslushnikov aslushnikov merged commit 89007c8 into microsoft:master Apr 22, 2020
@aslushnikov aslushnikov deleted the make-readme-always-reflect-tip-of-tree branch April 22, 2020 05:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants