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: refer to npm consistently (branding) #812

Merged
merged 4 commits into from
Mar 29, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .buildkite/pipeline.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,10 @@ steps:
echo "--- Node version"
node --version

echo "--- NPM version"
echo "--- npm version"
npm --version

echo "--- Install NPM dependencies"
echo "--- Install npm dependencies"
npm install

# if necessary, reinstall "correct" version of Cypress
Expand Down
8 changes: 4 additions & 4 deletions .github/workflows/parallel.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ on: [push, workflow_dispatch]

jobs:
install:
name: Install NPM and Cypress
name: Install npm and Cypress
runs-on: ubuntu-22.04
steps:
- uses: actions/checkout@v4
Expand All @@ -28,13 +28,13 @@ jobs:
npm i -g @bahmutov/print-env@2
print-env GITHUB BUILD ACTIONS || true

# Restore the previous NPM modules and Cypress binary archives.
# Restore the previous npm modules and Cypress binary archives.
# Any updated archives will be saved automatically after the entire
# workflow successfully finishes.
# See https://github.com/actions/cache
# we use exact restore key to avoid NPM module snowballing
# we use exact restore key to avoid npm module snowballing
# https://glebbahmutov.com/blog/do-not-let-npm-cache-snowball/
- name: Cache central NPM modules
- name: Cache central npm modules
uses: actions/cache@v4
with:
path: ~/.npm
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/single.yml
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ jobs:
npm i -g @bahmutov/print-env
print-env GITHUB

# Restore the previous NPM modules and Cypress binary archives.
# Restore the previous npm modules and Cypress binary archives.
# In case there's no previous cache the packages will be downloaded
# and saved automatically after the entire workflow successfully finishes.
# See https://github.com/actions/cache
Expand Down
2 changes: 1 addition & 1 deletion .gitlab-ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ cache:
- cache/Cypress
- node_modules

# this job installs NPM dependencies and Cypress
# this job installs npm dependencies and Cypress
install:
image: cypress/base:20.11.0
stage: build
Expand Down
2 changes: 1 addition & 1 deletion .semaphore/semaphore.yml
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ blocks:
- npm ci
# verify the Cypress test binary so its check status is cached
- npm run cy:verify
# Cache NPM dependencies and Cypress binary
# Cache npm dependencies and Cypress binary
- cache store npm-$SEMAPHORE_GIT_BRANCH-$(checksum package-lock.json)-$(checksum .semaphore/semaphore.yml) ~/.npm
- cache store cypress-$SEMAPHORE_GIT_BRANCH-$(checksum package-lock.json)-$(checksum .semaphore/semaphore.yml) ~/.cache/Cypress

Expand Down
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,6 @@ This repo is required by the [example](https://github.com/cypress-io/cypress/tre

## Deployment

1. After landing commits with features or fixes, new versions of this NPM package are published automatically using `semantic-release`.
1. After landing commits with features or fixes, new versions of this npm package are published automatically using `semantic-release`.

2. Now the [example](https://github.com/cypress-io/cypress/tree/develop/packages/example) package in Cypress' main code base must be updated. [Follow these instructions](https://github.com/cypress-io/cypress/blob/develop/packages/example/README.md#updating-the-example-app) to update the `example` app.
2 changes: 1 addition & 1 deletion Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ COPY cypress ./cypress
# https://github.com/cypress-io/cypress/issues/1243
ENV CI=1

# install NPM dependencies and Cypress binary
# install npm dependencies and Cypress binary
RUN npm ci
# check if the binary was installed successfully
RUN npx cypress verify
4 changes: 2 additions & 2 deletions Jenkinsfile
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

// Setup:
// before starting Jenkins, I have created several volumes to cache
// Jenkins configuration, NPM modules and Cypress binary
// Jenkins configuration, npm modules and Cypress binary

// docker volume create jenkins-data
// docker volume create npm-cache
Expand All @@ -14,7 +14,7 @@
// - run Docker in disconnected mode
// - name running container "blue-ocean"
// - map port 8080 with Jenkins UI
// - map volumes for Jenkins data, NPM and Cypress caches
// - map volumes for Jenkins data, npm and Cypress caches
// - pass Docker socket which allows Jenkins to start worker containers
// - download and execute the latest BlueOcean Docker image

Expand Down
4 changes: 2 additions & 2 deletions appveyor.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,15 +15,15 @@ environment:
install:
- ps: Install-Product node $env:nodejs_version
# Output useful info for debugging.
# we should be using NPM v6+
# we should be using npm v6+
- node --version
- npm --version
- npm i -g @cypress/commit-message-install @bahmutov/print-env
- print-env APPVEYOR
- commit-message-install --else "npm ci"

cache:
# cache NPM packages and Cypress binary
# cache npm packages and Cypress binary
# and invalidate the cache when package.json file changes
# https://www.appveyor.com/docs/build-cache/
- '%AppData%\npm -> package.json'
Expand Down
6 changes: 3 additions & 3 deletions azure-ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ jobs:
versionSpec: '20.x'
displayName: 'Install Node.js'

# NPM modules and Cypress binary should be cached
# npm modules and Cypress binary should be cached
# otherwise the install will be too slow
# https://docs.microsoft.com/en-us/azure/devops/pipelines/caching/?view=azure-devops
# since the username / user home directory are not available via system variables
Expand All @@ -30,7 +30,7 @@ jobs:
key: npm | $(Agent.OS) | package-lock.json
path: /home/vsts/.npm
restoreKeys: npm | $(Agent.OS) | package-lock.json
displayName: Cache NPM packages
displayName: Cache npm packages
- task: CacheBeta@1
inputs:
key: cypress | $(Agent.OS) | package-lock.json
Expand All @@ -40,7 +40,7 @@ jobs:

# Install Node dependencies
- script: npm ci
displayName: 'Install NPM dependencies'
displayName: 'Install npm dependencies'

- script: npm run cy:verify
displayName: 'Cypress verify'
Expand Down
4 changes: 2 additions & 2 deletions basic/.semaphore.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ agent:
type: e1-standard-2

blocks:
# installs NPM dependencies, builds the web application and
# installs npm dependencies, builds the web application and
# runs Cypress tests on a single machine
- name: E2E tests
task:
Expand All @@ -33,7 +33,7 @@ blocks:
# verify the Cypress test binary so its check status is cached
- npm run cy:verify

# cache NPM dependencies and Cypress binary
# cache npm dependencies and Cypress binary
- cache store npm-$SEMAPHORE_GIT_BRANCH-$(checksum package-lock.json)-$(checksum basic/semaphore.yml) ~/.npm
- cache store cypress-$SEMAPHORE_GIT_BRANCH-$(checksum package-lock.json)-$(checksum basic/semaphore.yml) ~/.cache/Cypress

Expand Down
6 changes: 3 additions & 3 deletions basic/azure-ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ jobs:
versionSpec: '20.x'
displayName: 'Install Node.js'

# NPM modules and Cypress binary should be cached
# npm modules and Cypress binary should be cached
# otherwise the install will be too slow
# https://docs.microsoft.com/en-us/azure/devops/pipelines/caching/?view=azure-devops
# since the username / user home directory are not available via system variables
Expand All @@ -24,7 +24,7 @@ jobs:
key: npm | $(Agent.OS) | package-lock.json
path: /home/vsts/.npm
restoreKeys: npm | $(Agent.OS) | package-lock.json
displayName: Cache NPM packages
displayName: Cache npm packages
- task: CacheBeta@1
inputs:
key: cypress | $(Agent.OS) | package-lock.json
Expand All @@ -33,7 +33,7 @@ jobs:
displayName: Cache Cypress binary

- script: npm ci
displayName: 'Install NPM dependencies'
displayName: 'Install npm dependencies'

- script: npm run cy:verify
displayName: 'Cypress verify'
Expand Down
2 changes: 1 addition & 1 deletion basic/codeship-pro/Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ COPY cypress ./cypress
# https://github.com/cypress-io/cypress/issues/1243
ENV CI=1

# install NPM dependencies and Cypress binary
# install npm dependencies and Cypress binary
RUN npm ci
# check if the binary was installed successfully
RUN npx cypress verify
Loading