From 009f24e9621be122ab5bff803dad93df3d1220a4 Mon Sep 17 00:00:00 2001 From: Mike McCready <66998419+MikeMcC399@users.noreply.github.com> Date: Sun, 17 Mar 2024 10:26:57 +0100 Subject: [PATCH] docs: refer to npm consistently (branding) --- .buildkite/pipeline.yml | 4 ++-- .github/workflows/parallel.yml | 8 ++++---- .github/workflows/single.yml | 2 +- .gitlab-ci.yml | 2 +- .semaphore/semaphore.yml | 2 +- CONTRIBUTING.md | 2 +- Dockerfile | 2 +- Jenkinsfile | 4 ++-- appveyor.yml | 4 ++-- azure-ci.yml | 6 +++--- basic/.semaphore.yml | 4 ++-- basic/azure-ci.yml | 6 +++--- basic/codeship-pro/Dockerfile | 2 +- 13 files changed, 24 insertions(+), 24 deletions(-) diff --git a/.buildkite/pipeline.yml b/.buildkite/pipeline.yml index 5fb7ad182..caf782059 100644 --- a/.buildkite/pipeline.yml +++ b/.buildkite/pipeline.yml @@ -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 diff --git a/.github/workflows/parallel.yml b/.github/workflows/parallel.yml index 57f25722a..8c3847237 100644 --- a/.github/workflows/parallel.yml +++ b/.github/workflows/parallel.yml @@ -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 @@ -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 diff --git a/.github/workflows/single.yml b/.github/workflows/single.yml index 086a29ecb..451f7a1c6 100644 --- a/.github/workflows/single.yml +++ b/.github/workflows/single.yml @@ -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 diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index 0cc04a86d..5be96e8f4 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -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 diff --git a/.semaphore/semaphore.yml b/.semaphore/semaphore.yml index 3eec03039..2972691b2 100644 --- a/.semaphore/semaphore.yml +++ b/.semaphore/semaphore.yml @@ -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 diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e86a37615..02c68b5ae 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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. diff --git a/Dockerfile b/Dockerfile index 84bb593ff..de27f16a3 100644 --- a/Dockerfile +++ b/Dockerfile @@ -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 diff --git a/Jenkinsfile b/Jenkinsfile index 4bcc6d101..558017454 100644 --- a/Jenkinsfile +++ b/Jenkinsfile @@ -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 @@ -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 diff --git a/appveyor.yml b/appveyor.yml index 44897f4de..e8582a118 100644 --- a/appveyor.yml +++ b/appveyor.yml @@ -15,7 +15,7 @@ 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 @@ -23,7 +23,7 @@ install: - 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' diff --git a/azure-ci.yml b/azure-ci.yml index 125902279..c6f08b6ff 100644 --- a/azure-ci.yml +++ b/azure-ci.yml @@ -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 @@ -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 @@ -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' diff --git a/basic/.semaphore.yml b/basic/.semaphore.yml index 4ab72d40b..1a19b04f3 100644 --- a/basic/.semaphore.yml +++ b/basic/.semaphore.yml @@ -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: @@ -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 diff --git a/basic/azure-ci.yml b/basic/azure-ci.yml index f1a63fd25..76f46b05a 100644 --- a/basic/azure-ci.yml +++ b/basic/azure-ci.yml @@ -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 @@ -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 @@ -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' diff --git a/basic/codeship-pro/Dockerfile b/basic/codeship-pro/Dockerfile index 84bb593ff..de27f16a3 100644 --- a/basic/codeship-pro/Dockerfile +++ b/basic/codeship-pro/Dockerfile @@ -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