Add documentation #2
Conversation
Provide some guides that explain: * What the tool is and does * The difference between polyrepos and monorepos * The difference between fixed and independent versioning strategies for monorepos * How the tool can distinguish between these three things * How the tool works for these three things
| "workspaces": ["packages/*"], | ||
| } | ||
|
|
||
| # release.config.json |
There was a problem hiding this comment.
When I first opened this PR, I had placed this option in package.json. I changed it based on a discussion I had with Ricky, but from standup this morning, it sounds like we do want to keep this inside of package.json. So I can change this back — but that said we do need to put this option under a namespace. Initially that namespace was @metamask/create-release-branch, however, we also need action-publish-release to be able to access the versioning strategy as well. So what should the namespace be? Here are some options:
@metamask@metamask/releases@metamask/release-config- something else entirely
There was a problem hiding this comment.
Those three options all sounds reasonable to me.
If you want help choosing, I would choose @metamask/release-config, but I don't really have a preference.
There was a problem hiding this comment.
Oh and if you'd prefer keeping this setting in a separate config file, that is perfectly fine with me too. Ultimately I don't think it matters much.
That is what I meant to express when we talked about this at standup last week - that I didn't want to impose the requirement that the config be external for just a single boolean, even though I have a strong personal preference for using external config for dev tooling whenever possible. At the time I hadn't been aware this was updated to use a separate file already. Just clarifying in case I gave the impression that I had a strong preference for avoiding the extra file, that was not the intention.
There was a problem hiding this comment.
Okay. It sounds like both you and Ricky have said you'd prefer a separate file than keeping it in package.json so I'll go with this for now and if we want to change it later we can :)
Provide some guides that explain:
monorepos
👉🏻 Rendered Markdown 👈🏻