Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Correct circleci workflow #2365

Merged
merged 2 commits into from Feb 17, 2022
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 1 addition & 3 deletions docs/recipes/ci-configurations/circleci-workflows.md
Expand Up @@ -22,14 +22,12 @@ Finally, we call our release job with a `requires` parameter so that `release` w
```yaml
version: 2.1
orbs:
node: circleci/node@4.5
node: circleci/node@5.0.0
jobs:
release:
executor: node/default
steps:
- checkout
- node/install
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the reason we include this step is to encourage using the latest lts version of node when releasing, even if that is not the version used to verify the project. does removing this step still accomplish that goal? if not would including a comment make that goal more clear here?

Copy link
Contributor Author

@cades cades Feb 15, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for replying!

The reason why that step can be removed is, circleci/node's default executor already uses lts node docker image.

(There is a configurable tag, which defaults to 'lts')

Reference: https://circleci.com/developer/orbs/orb/circleci/node#executors-default

lts: true
- node/install-packages # Install and automatically cache packages
# Run optional required steps before releasing
# - run: npm run build-script
Expand Down