The npm documentation

Author: ethomson

.github/workflows/publish.yml

@@ -0,0 +1,62 @@
+name: Publish
+
+on:
+  push:
+    branches: [ main ]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    # Check out the content (source branch)
+    - name: Check out source
+      uses: actions/checkout@v2
+
+    # Check out the `dist` branch into the `public` directory.
+    - name: Check out documentation branch
+      uses: actions/checkout@v2
+      with:
+        ref: 'dist'
+        path: 'public'
+
+    - name: Use Node.js
+      uses: actions/setup-node@v1
+      with:
+        node-version: 12.x
+
+    # Update npm to v7
+    - name: Update npm v7
+      run: npm install -g npm@latest
+
+    # Build the site
+    - name: Install npm packages
+      run: npm install
+    - name: Build documentation
+      run: npm run build
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+    # Check for changes; this avoids publishing a new change to the
+    # dist branch when we made a change to (for example) a unit test.
+    # If there were changes made in the publish step above, then this
+    # will set the variable `has_changes` to `1` for subsequent steps.
+    - name: Check for changes
+      id: status
+      run: |
+        if [ -n "$(git status --porcelain)" ]; then
+          echo "::set-output name=has_changes::1"
+        fi
+      working-directory: public
+
+    # Commit the changes to the dist branch and push the changes up to
+    # GitHub.  (Replace the name and email address with your own.)
+    # This step only runs if the previous step set `has_changes` to `1`.
+    - name: Publish documentation
+      run: |
+        git add --verbose .
+        git config user.name 'CI User'
+        git config user.email 'noreply@npmjs.com'
+        git commit -m 'Update from CI'
+        git push origin dist
+      if: steps.status.outputs.has_changes == '1'
+      working-directory: public

.github/workflows/stage-pull-request.yml

@@ -0,0 +1,59 @@
+name: Stage Pull Request
+
+on:
+  pull_request_target:
+    types: [opened, synchronize, reopened, closed]
+  workflow_dispatch:
+    inputs:
+      pr_number:
+        description: 'Pull Request Number'
+        required: true
+
+env:
+  staging_repo: 'npm/docs-staging'
+
+jobs:
+  stage_pr:
+    runs-on: ubuntu-latest
+    steps:
+    - run: |
+        echo "${{ toJson(github) }}"
+    - name: Identify pull request
+      id: pull_request
+      run: |
+        NOTIFY="false"
+
+        if [ "${{ github.event_name }}" = "workflow_dispatch" ]; then
+          PR_NUMBER="${{ github.event.inputs.pr_number }}"
+        elif [ "${{ github.event_name }}" = "pull_request_target" ]; then
+          PR_NUMBER="${{ github.event.pull_request.number }}"
+
+          if [ "${{github.event.action}}" = "opened" ]; then
+            NOTIFY="true"
+          fi
+        fi
+
+        if [ "$PR_NUMBER" = "" ]; then
+          echo "::error::Unknown event type or unset pull request number"
+          exit 1
+        fi
+
+        echo "Building pull request ${PR_NUMBER}"
+
+        curl -f -X POST -u ":${{ secrets.NPM_DOCS_TOKEN }}" \
+          -H "Accept: application/vnd.github.everest-preview+json" \
+          -H "Content-Type: application/json" \
+          --data "{ \"event_type\": \"publish_pr\", \"client_payload\": { \"pr_number\":\"$PR_NUMBER\", \"notify\":\"$NOTIFY\" } }" \
+          https://api.github.com/repos/${{ env.staging_repo }}/dispatches
+
+#    - name: Identify pull request
+#      if: github.event_name == "pull_request_target"
+#      uses: actions/github-script@v3
+#      with:
+#        script: |
+#          github.issues.createComment({
+#            issue_number: context.issue.number,
+#            owner: context.repo.owner,
+#            repo: context.repo.repo,
+#            body: "👋 Thanks for opening a pull request!  We're building a staging 
+#          })

.github/workflows/update-cli.yml

@@ -0,0 +1,72 @@
+name: Update CLI
+
+on:
+  schedule:
+  - cron: "14 2 * * *"
+  workflow_dispatch:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    # Check out the content (source branch).  Use a deploy key so that
+    # when we push changes, it will trigger the documentation update
+    # workflow run that runs on: push.  (Using the GitHub token would
+    # not run the workflow to prevent infinite recursion.)
+    - name: Check out source
+      uses: actions/checkout@v2
+      with:
+        ssh-key: ${{ secrets.CLI_DEPLOY_KEY }}
+
+    # Make sure that the new content didn't break the build.  We don't
+    # want to promote anything that would breaks.
+    - name: Use Node.js
+      uses: actions/setup-node@v1
+      with:
+        node-version: 12.x
+
+    # Update npm to v7
+    - name: Update npm v7
+      run: npm install -g npm@latest
+
+    # Add the CLI documentation to the content directory.
+    - name: Install npm packages
+      run: npm install
+    - name: Fetch latest documentation
+      run: node cli/cli_fetch.js
+    - name: Import documentation
+      run: node cli/cli_import.js
+
+    # Check for changes; this avoids publishing a new change to the
+    # dist branch when we made a change to (for example) a unit test.
+    # If there were changes made in the publish step above, then this
+    # will set the variable `has_changes` to `1` for subsequent steps.
+    - name: Check for changes
+      id: status
+      run: |
+        if [ -n "$(git status --porcelain)" ]; then
+          echo "::set-output name=has_changes::1"
+        fi
+
+    # Commit the changes to the dist branch and push the changes up to
+    # GitHub.  (Replace the name and email address with your own.)
+    # This step only runs if the previous step set `has_changes` to `1`.
+    - name: Check in documentation
+      run: |
+        git add --verbose .
+        git config user.name 'CI User'
+        git config user.email 'noreply@npmjs.com'
+        git commit -m 'CLI documentation update from CI'
+      if: steps.status.outputs.has_changes == '1'
+
+    # Before we publish the changes, ensure the site builds so that we
+    # don't break the main branch.
+    - name: Build documentation
+      run: npm run build
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+    # Publish the documentation updates.
+    - name: Publish documentation
+      run: git push origin main
+      if: steps.status.outputs.has_changes == '1'

.gitignore

@@ -0,0 +1,91 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+*.lcov
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# TypeScript v1 declaration files
+typings/
+
+# TypeScript cache
+*.tsbuildinfo
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variables file
+.env
+.env.test
+
+# parcel-bundler cache (https://parceljs.org/)
+.cache
+
+# next.js build output
+.next
+
+# nuxt.js build output
+.nuxt
+
+# vuepress build output
+.vuepress/dist
+
+# Serverless directories
+.serverless/
+
+# FuseBox cache
+.fusebox/
+
+# DynamoDB Local files
+.dynamodb/
+
+# Gatsby
+public/

.gitmodules

@@ -0,0 +1,6 @@
+[submodule "cli/v6"]
+	path = cli/v6
+	url = https://github.com/npm/cli
+[submodule "cli/v7"]
+	path = cli/v7
+	url = https://github.com/npm/cli