Skip to content

Ensure list of packages and dependency graph in README is kept up to date #6694

@mcmire

Description

@mcmire

Currently, engineers must remember to run yarn update-readme-content whenever creating a new package or updating a package's internal dependencies. It would be great if they did not have to do this.

Acceptance Criteria

  • yarn update-readme-content takes a required --check option which exits with code 1 and a message recommending that --fix be used if the README is out of date
  • yarn update-readme-content takes a required --fix option that autofixes the README
  • yarn lint runs yarn update-readme-content
  • yarn lint:fix runs yarn update-readme-content --fix

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions