chore: update project to use npm (#636)

* chore: remove yarn lockfile

* chore: update project to use npm

* docs: update yarn to npm in docs

* ci: update commands from yarn to npm

* ci: add cache option to setup-node

* update lock file

---------

Co-authored-by: Josh Black <[email protected]>
Co-authored-by: Siddharth Kshetrapal <[email protected]>

Author: joshblack

.github/workflows/ci.yml

@@ -12,12 +12,13 @@ jobs:
         uses: actions/setup-node@v3
         with:
           node-version: 18
+          cache: 'npm'
 
       - name: Install dependencies
-        run: yarn
+        run: npm ci
 
       - name: Lint
-        run: yarn workspace @primer/gatsby-theme-doctocat lint
+        run: npm run lint -ws --if-present
 
       - name: Test
-        run: yarn workspace @primer/gatsby-theme-doctocat test
+        run: npm run test -ws --if-present

.github/workflows/deploy.yml

@@ -18,6 +18,6 @@ jobs:
       gh_token: ${{ secrets.GITHUB_TOKEN }}
     with:
       node_version: 18
-      install: yarn
-      build: yarn build
+      install: npm ci
+      build: npm run build
       output_dir: docs/public

.github/workflows/deploy_preview.yml

@@ -16,6 +16,6 @@ jobs:
       gh_token: ${{ secrets.GITHUB_TOKEN }}
     with:
       node_version: 18
-      install: yarn
-      build: yarn build:preview
+      install: npm ci
+      build: npm run build:preview
       output_dir: docs/public

.github/workflows/release.yml

@@ -22,17 +22,18 @@ jobs:
         uses: actions/setup-node@v3
         with:
           node-version: 18
+          cache: 'npm'
 
       - name: Install dependencies
-        run: yarn
+        run: npm ci
 
       - name: Create release pull request or publish to npm
         id: changesets
         uses: changesets/action@master
         with:
           title: Release Tracking
           # This expects you to have a script called release which does a build for your packages and calls changeset publish
-          publish: yarn release
+          publish: npm run release
         env:
           GITHUB_TOKEN: ${{ secrets.GPR_AUTH_TOKEN_SHARED }}
           NPM_TOKEN: ${{ secrets.NPM_AUTH_TOKEN_SHARED }}

.github/workflows/release_canary.yml

@@ -23,9 +23,10 @@ jobs:
         uses: actions/setup-node@v3
         with:
           node-version: 18
+          cache: 'npm'
 
       - name: Install dependencies
-        run: yarn
+        run: npm ci
 
       - name: Create .npmrc
         run: |
@@ -40,8 +41,8 @@ jobs:
           echo "$( jq '.version = "0.0.0"' package.json )" > package.json
           echo -e "---\n'@primer/gatsby-theme-doctocat': patch\n---\n\nFake entry to force publishing" > .changeset/force-snapshot-release.md
           rm -f .changeset/pre.json
-          yarn changeset version --snapshot
-          yarn changeset publish --tag canary
+          npx changeset version --snapshot
+          npx changeset publish --tag canary
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 

.github/workflows/stale.yml

@@ -9,18 +9,17 @@ jobs:
     steps:
       - uses: actions/stale@v4
         with:
-          
           # General settings
           days-before-stale: 60
           days-before-close: 7
           enable-statistics: true
           operations-per-run: 100
           remove-stale-when-updated: true
-          
+
           # PR specific settings
           delete-branch: true
-          stale-pr-message: "Hi! This pull request has been marked as stale because it has been open with no activity for 60 days. You can comment on the pull request or remove the stale label to keep it open. If you do nothing, this pull request will be closed in 7 days."
-          
+          stale-pr-message: 'Hi! This pull request has been marked as stale because it has been open with no activity for 60 days. You can comment on the pull request or remove the stale label to keep it open. If you do nothing, this pull request will be closed in 7 days.'
+
           # Issue specific settings
           days-before-issue-stale: 180
-          stale-issue-message: "Hi! This issue has been marked as stale because it has been open with no activity for 180 days. You can comment on the issue or remove the stale label to keep it open. If you do nothing, this issue will be closed in 7 days."
+          stale-issue-message: 'Hi! This issue has been marked as stale because it has been open with no activity for 180 days. You can comment on the issue or remove the stale label to keep it open. If you do nothing, this issue will be closed in 7 days.'

CONTRIBUTING.md

@@ -6,34 +6,30 @@ We appreciate your contribution and hope that this document helps you along the
 
 <Note>
 
-
 These guidelines are for contributing to the theme itself, if you are looking for help running a Doctocat site for another project locally, check out the [Local Development](/usage/local-development) docs in the Usage section.
 
 </Note>
 
-
 ## Local development
 
 Run the following commands to begin local development:
 
 <Note>
 
-
-These steps require [Node.js](https://nodejs.org) and [Yarn](https://yarnpkg.com) to be set up locally.
+These steps require [Node.js](https://nodejs.org) and [npm](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm) to be set up locally.
 
 </Note>
 
-
 ```shell
 # Clone the repository
 git clone https://github.com/primer/doctocat.git
 cd doctocat
 
 # Install the dependencies
-yarn
+npm install
 
 # Start the development server for the documentation site
-yarn workspace docs develop
+npm start
 
 # Navigate to http://localhost:8000 in your browser
 ```
@@ -44,21 +40,19 @@ yarn workspace docs develop
 .
 ├── theme/
 ├── docs/
-├── package.json
-└── now.json
+└── package.json
 ```
 
 - `theme/`: This directory contains the code for the [Gatsby Theme](https://www.gatsbyjs.org/docs/themes/what-are-gatsby-themes/) and is what gets published to npm.
 - `docs/`: This directory contains the code for the documentation site for Doctocat. The documentation site can also be used to test changes to the theme locally.
-- `package.json`: This file defines the [Yarn Workspaces](https://yarnpkg.com/lang/en/docs/workspaces/) for the project and is not meant to be published.
-- `now.json`: This file configures the deployment of the documentation site. Check out the [now.json docs](https://zeit.co/docs/v2/deployments/configuration/?query=now.json) for more information.
+- `package.json`: This file defines the [workspaces](https://docs.npmjs.com/cli/v7/using-npm/workspaces) for the project and is not meant to be published.
 
 ## Scripts
 
-The documentation site has a few [npm scripts](https://docs.npmjs.com/misc/scripts) for developing and building the site. You can run these scripts from the root directory using the [`yarn workspace`](https://yarnpkg.com/lang/en/docs/cli/workspace/) command:
+The documentation site has a few [npm scripts](https://docs.npmjs.com/misc/scripts) for developing and building the site. You can run these scripts from the root directory using the [`--workspace`](https://docs.npmjs.com/cli/v7/using-npm/workspaces#running-commands-in-the-context-of-workspaces), or `-w`, option:
 
 ```shell
-yarn workspace docs <script-name>
+npm run -w docs <script-name>
 ```
 
 ### `develop`
@@ -149,13 +143,13 @@ Follow this process if you'd like your work considered for inclusion in the proj
 - Install the dependencies:
 
   ```shell
-  yarn
+  npm i
   ```
 
 - Start Gatsby's hot-reloading development environment:
 
   ```shell
-  yarn workspace docs develop
+  npm start
   # The documentation site will now be accessible from http://localhost:8000
   ```