docs(circleci): Update CircleCI recipes config #2018
Conversation
Updates the included CircleCI config file example. * Now uses 2.1 style config * Uses Node Orb * Use pre-defined node/test job * Uses Matrix jobs to test multiple node versions. * Updated Node versions * Using new CircleCI docker images (from node executor) * Updated language/terminology in description
|
If desired I could instead make a PR that does not use Orbs. The outcome would look much more similar to the existing config but only with updated images and such. The suggestion in this PR is more optimized though perhaps maybe a bit opaque for new users. |
| steps: | ||
| - checkout | ||
| - run: npm install | ||
| - node/install-packages # Install and automatically cache packages | ||
| # Run optional required steps before releasing | ||
| # - run: npm run build-script | ||
| - run: npx semantic-release |
There was a problem hiding this comment.
sorry that i missed asking this before the merge, but does this step still belong here after defining the separate release job? it seems like this would run unconditionally w/o considering the required test job, but i could be misunderstanding something
There was a problem hiding this comment.
Hey @travi,
This is assuming the user needs to run npm run build or something similar prior to running the semantic-release CLI. In that case, this is a more efficient way of installing packages.
Further down in the workflow you'll see this job requires the node/test job(s) to have completed first.
- release:
requires:
- node/test
Let me know if that clears it up, I could be misunderstanding something too
There was a problem hiding this comment.
ok, i think the detail that i was overlooking was the release name on line 24. without noticing that, i wasnt sure how the requirement was tied back to those steps. this is just my lack of familiarity with the CircleCI specifics, but it makes sense now. thanks for clarifying!
|
🎉 This PR is included in version 17.4.5 🎉 The release is available on: Your semantic-release bot 📦🚀 |
|
🎉 This PR is included in version 18.0.0-beta.1 🎉 The release is available on: Your semantic-release bot 📦🚀 |
Updates the included CircleCI config file example.