Nodejs Monorepo

2022-03-26T00:00:00+00:00
Use changesets as monorepo mananger.</p> </span>
Tools🔗</a></h2>
GitHub - atlassian/changesets: 🦋 A way to manage your versioning and changelogs with a focus on monorepos</a></p>

Use Changesets as monorepo manager 🔗</a></h2>
mkdir</span> monorepo && </span>cd</span> monorepo
</span>git</span> init
</span># Add .gitignore file for nodejs <https://github.com/github/gitignore/blob/master/Node.gitignore>
</span>npm</span> init</span> --yes
</span></code></pre>
Add "private":"true"</code> to the root package.json</code></p>
npm</span> init</span> -w</span> packages/a
</span>npm</span> init</span> -w</span> packages/b
</span>npm</span> init</span> -w</span> packages/c
</span></code></pre>
Let c</code> depends a</code> and b</code>,</p>
Add</p>
"</span>dependencies</span>": {
</span>  "</span>a</span>":"</span>^1.0.0</span>",
</span>  "</span>b</span>":"</span>^1.0.0</span>"
</span>}
</span></code></pre>
to packages/c/package.json</code></p>
Install changesets🔗</a></h3>
Also see here</a></p>
npm</span> install</span> -D</span> @changesets/cli && </span>npx</span> changeset init
</span></code></pre>
This action will add a .changeset</code> folder, and a couple of files to help you out:</p>
You should change the .changeset/config.json</code> -> baseBranch</code> to yourself main branch, also change access</code> to public</code></p>
Commit current files.</p>
git</span> add .
</span>git</span> commit</span> -m </span>"</span>feat: init</span>"
</span></code></pre>
That’s done.</p>
Usage🔗</a></h3>
First publish🔗</a></h4>
First publish you should just use the follow command to publish your module</p>
npx</span> changeset publish
</span></code></pre>
Future changes🔗</a></h4>
You should see changesets philosophy</a></p>
You should first create an intent to change</code>, that said, before what ever changes you want to make, you should create a intent change</code></p>
npx</span> changeset
</span></code></pre>
…Make some changes</p>
Now, generate new version, changeset will take care your dependences,</p>

Note, by default, if a</code> upgrade from 1.0.1</code> to 1.0.2</code>, c</code> depends on a@^1.0.1</code>, then c</code> package.json</code> will not change, cause npm will auto update a@^1.0.1</code> to the last version 1.0.2</code>
if you want change to the exact version every time, you can set the config to</p>
 "</span>___experimentalUnsafeOptions_WILL_CHANGE_IN_PATCH</span>"</span>: </span>{
</span>    "</span>updateInternalDependents</span>": "</span>always</span>"
</span> }
</span></code></pre>
</blockquote>
npx</span> changeset version
</span></code></pre>
Then, you can publish it.</p>
npx</span> changeset publish
</span></code></pre>
git</span> add .
</span>git</span> commit</span> -m </span>"</span>chore: version</span>"
</span>git</span> push</span> --follow-tags
</span></code></pre>
With CI🔗</a></h2>
I’ll use Github Actions as example.</p>
The CI workflow assume that you use 开发技巧收藏</a> as your git workflow.</p>

Note, you can use @changesets/changelog-github</code></a> as your changelog format log. with this, you can generate a log like this</a> , without this, then the log will only include commit link</a> > npm i -D @changesets/changelog-github</code></p>
{
</span>  "</span>changelog</span>": [
</span>    "</span>@changesets/changelog-github</span>",
</span>    { "</span>repo</span>": "</span>theowenyoung/monorepo-example</span>" }
</span>  ]
</span>}
</span></code></pre>
</blockquote>

Create a script in root package.json</code></li>
</ol>
{
</span>  "</span>scripts</span>": {
</span>    "</span>version-packages</span>": "</span>changeset version</span>",
</span>    "</span>release</span>": "</span>changeset publish</span>"
</span>  }
</span>}
</span></code></pre>

Create github actions workflows</li>
</ol>
mkdir -p</span> .github/workflows
</span></code></pre>
touch</span> .github/workflows/release.yml
</span></code></pre>
With the following content:</p>
name</span>: </span>Release
</span>
</span>on</span>:
</span>  </span>workflow_dispatch</span>:
</span>  </span>push</span>:
</span>    </span>branches</span>:
</span>      - </span>main
</span>
</span>jobs</span>:
</span>  </span>release</span>:
</span>    </span>name</span>: </span>Release
</span>    </span>runs-on</span>: </span>ubuntu-latest
</span>    </span>steps</span>:
</span>      - </span>name</span>: </span>Checkout Repo
</span>        </span>uses</span>: </span>actions/checkout@master
</span>        </span>with</span>:
</span>          </span># This makes Actions fetch all Git history so that Changesets can generate changelogs with the correct commits
</span>          </span>fetch-depth</span>: </span>0
</span>
</span>      - </span>name</span>: </span>Setup Node.js 12.x
</span>        </span>uses</span>: </span>actions/setup-node@master
</span>        </span>with</span>:
</span>          </span>node-version</span>: </span>12.x
</span>      - </span>name</span>: </span>Setup NPM Latest
</span>        </span>run</span>: </span>npm i -g npm
</span>      - </span>name</span>: </span>Install Dependencies
</span>        </span>run</span>: </span>npm i
</span>
</span>      - </span>name</span>: </span>Create Release Pull Request or Publish to npm
</span>        </span>uses</span>: </span>changesets/action@master
</span>        </span>with</span>:
</span>          </span># this expects you to have a script called release which does a build for your packages and calls changeset publish
</span>          </span>publish</span>: </span>npm run release
</span>          </span>version</span>: </span>npm run version-packages
</span>        </span>env</span>:
</span>          </span>GITHUB_TOKEN</span>: </span>${{ secrets.GITHUB_TOKEN }}
</span>          </span>NPM_TOKEN</span>: </span>${{ secrets.NPM_TOKEN }}
</span></code></pre>

Add NPM_TOKEN</code> to your github repo secret settings</li>
</ol>
By 开发技巧收藏</a></p>
npm</span> token create
</span></code></pre>
Done.</p>
Every time you use npx changeset</code> to generate a new changeset intent, and the change is pulled to the main</code> branch, then CI will create a pull request to generate a new version, and after the pull request was merged, CI will publish npm packages, and create a new release.</p>
Owen Young's Blog - Javascript

Nodejs Monorepo

Tools🔗</a></h2> GitHub - atlassian/changesets: 🦋 A way to manage your versioning and changelogs with a focus on monorepos</a></p>

Tools🔗</a></h2>
GitHub - atlassian/changesets: 🦋 A way to manage your versioning and changelogs with a focus on monorepos</a></p>
