ChromeDevTools / ChromeDevTools/devtools-protocol

Reconsider versioning scheme

Open
#298 0 comments 4 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
1.6k
Forks
279
PR merge metrics
No merged PRs in 30d

Description

Currently, devtools-protocol is being versioned as 0.0.<revision>, e.g. 0.0.1134390. However, we’re increasingly moving to using Chrome version numbers as the source of truth rather than branch positions / revision numbers.

Can we reconsider versioning devtools-protocol as 1.0.0-<chrome-version>, e.g. 1.0.0-112.0.5615.137? This is valid per semver; it’s interpreted as a pre-release version.

> semver.valid('1.0.0-112.0.5615.137')
'1.0.0-112.0.5615.137'

Motivation: We currently have some extra code to track version numbers alongside revision IDs in both Puppeteer and the Chrome for Testing availability dashboard, for the sole purpose of figuring out which devtools-protocol version to bundle. It would be nice if we could get rid of that.

In addition to this technical reason, I’d argue that Chrome version numbers are more intuitive and recognizable than the arbitrary-looking revision IDs.

cc @OrKoN

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

No files or tests are named. Start by reviewing how devtools-protocol currently derives and publishes 0.0. versions, then compare the proposed 1.0.0- format with SemVer. Done means the versioning approach is agreed and the related Puppeteer and Chrome for Testing version-tracking work can be removed or updated.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
release
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.