Document process for creating and configuration a new MetaMask polyrepo or monorepo with automated publishing workflow

[mcmire]

More and more these days it is common for other teams to reach out with help in setting up a new repo. Usually they do not know about the module template and have created their own repo, or they created a repo under the Consensys org and are migrating it to the MetaMask org. We usually have to spend about an hour relaying all of the steps needed and troubleshooting all of the issues. It would be good if we didn't have to do this and teams had a guide they could follow to set this up themselves.

[mcmire]

What we should include:

• Creating a new repo from scratch using the module or monorepo templates
• Using the guide in Notion to configure the repo
  • Giving npm-publishers admin access
  • Adding an npm-publish environment
  • Disabling "Allow merge commits" and enabling "Allow squash merging"
• Adding the GitHub workflows to the repo
  • Reporting new releases to Slack
  • Enabling documentation
• Creating your first release
  • Use action-create-release-pr or create-release-branch
  • Choosing an initial version (1.0.0 or 0.1.0?)
  • Bumping versions (make sure to bump root package in a monorepo)
  • Initializing the changelog for the first release
  • Validating the workflows
  • Common issues and how to resolve them
    • SLACK_WEBHOOK_URL not found
    • How to roll back releases
• Aside: How releases work for polyrepos and monorepos