Skip to content

Migration notice: use millionco/react-doctor@v2 in CI #781

@rayhanadev

Description

@rayhanadev

If your GitHub Actions workflow is using:

- uses: millionco/react-doctor@main

please update it to the stable v2 release channel:

- uses: millionco/react-doctor@v2

Why this changed

Older versions of our documentation recommended installing React Doctor from @main. That guidance has since been updated.

@main points at the active development branch. It can include unreleased action changes before the matching CLI changes have been published, which may cause temporary CI failures or version mismatches.

For production CI, PR checks, and team workflows, @v2 is the supported release channel.

Why use @v2

Using millionco/react-doctor@v2 gives you:

  • stable, released GitHub Action updates
  • compatibility with the published React Doctor CLI
  • fewer unexpected CI changes
  • a better security posture than tracking a moving development branch
  • automatic updates within the v2 release line

Recommended workflow

name: React Doctor

# any additional configuration ...

jobs:
  react-doctor:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: millionco/react-doctor@v2
		    # any additional configuration ...

Pinning an exact version

If you prefer fully pinned workflows, you can use a specific release instead:

- uses: millionco/react-doctor@v2.1.0

Most users should use @v2, since it stays within the stable v2 release line while still receiving compatible fixes and improvements.

Who should use @main?

Only use @main if you are intentionally testing unreleased React Doctor changes and are comfortable with CI instability.

If you copied an older setup from our docs, migrating from @main to @v2 should be the only required change.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions