Skip to content

[Docs Bug 🐞 report]: README uses wrong environment variable for skipping Chromium download #794

@Zacama

Description

@Zacama

Describe the bug you found in AsyncAPI Docs.

The README currently instructs users to set the environment variable PUPPETEER_SKIP_CHROMIUM_DOWNLOAD to skip downloading Chromium during installation. However, this environment variable is deprecated/incorrect in modern versions of Puppeteer (the project uses puppeteer@^24.4.0).

The correct environment variable is PUPPETEER_SKIP_DOWNLOAD. Setting PUPPETEER_SKIP_CHROMIUM_DOWNLOAD=true has no effect — Chromium is still downloaded. Only PUPPETEER_SKIP_DOWNLOAD=true properly prevents the download.

Attach any resources that can help us understand the issue.

Code of Conduct

  • I agree to follow this project's Code of Conduct

Are you willing to work on this issue?

Yes I am willing to submit a PR!


ℹ️ This repository follows the All Contributors specification per the contributing guidelines. Contributions should follow the Conventional Commits convention (e.g., docs: prefix for documentation changes).

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions