From 45d219ed6a7a24416ad9500437ec296e03ac18ed Mon Sep 17 00:00:00 2001 From: lbaker Date: Thu, 14 Oct 2021 16:48:11 -0700 Subject: [PATCH] feat: Update to node 16 --- .github/workflows/fetch-quickstarts.yml | 2 +- .github/workflows/fetch-related-content.yml | 2 +- .github/workflows/release.yml | 2 +- .github/workflows/validate-pr.yml | 4 ++-- .nvmrc | 2 +- CONTRIBUTING.md | 12 ++++++------ README.md | 7 ++++--- 7 files changed, 16 insertions(+), 15 deletions(-) diff --git a/.github/workflows/fetch-quickstarts.yml b/.github/workflows/fetch-quickstarts.yml index b505a9fc1..9841c58d9 100644 --- a/.github/workflows/fetch-quickstarts.yml +++ b/.github/workflows/fetch-quickstarts.yml @@ -22,7 +22,7 @@ jobs: - name: Setup node.js uses: actions/setup-node@v1 with: - node-version: 12 + node-version: 16 - name: Cache dependencies id: yarn-cache diff --git a/.github/workflows/fetch-related-content.yml b/.github/workflows/fetch-related-content.yml index 12084697e..c2ba40456 100644 --- a/.github/workflows/fetch-related-content.yml +++ b/.github/workflows/fetch-related-content.yml @@ -21,7 +21,7 @@ jobs: - name: Setup node.js uses: actions/setup-node@v1 with: - node-version: 12 + node-version: 16 - name: Get yarn cache directory path id: yarn-cache-dir-path diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index a5aff5057..92cdf950a 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -23,7 +23,7 @@ jobs: - name: Setup Node.js uses: actions/setup-node@v1 with: - node-version: 12 + node-version: 16 - name: Get yarn cache directory path id: yarn-cache-dir-path diff --git a/.github/workflows/validate-pr.yml b/.github/workflows/validate-pr.yml index e89b3e30b..a4533252a 100644 --- a/.github/workflows/validate-pr.yml +++ b/.github/workflows/validate-pr.yml @@ -17,7 +17,7 @@ jobs: - name: Setup Node.js uses: actions/setup-node@v2 with: - node-version: 12 + node-version: 16 - name: Cache dependencies id: yarn-cache @@ -43,7 +43,7 @@ jobs: - name: Setup Node.js uses: actions/setup-node@v2 with: - node-version: 12 + node-version: 16 - name: Cache dependencies id: yarn-cache diff --git a/.nvmrc b/.nvmrc index 3cacc0b93..19c7bdba7 100644 --- a/.nvmrc +++ b/.nvmrc @@ -1 +1 @@ -12 \ No newline at end of file +16 \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9674968ab..fe13db40d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -65,7 +65,7 @@ guidelines below. ### Using multiple versions of Node If you intend to run multiple versions of Node please be aware that the New Relic -Developer Site is currently on Node v12. Therefore it's recommended you use Node Version Manager [NVM](https://github.com/nvm-sh/nvm) to manage Node versions. +Developer Site is currently on Node v16. Therefore it's recommended you use Node Version Manager [NVM](https://github.com/nvm-sh/nvm) to manage Node versions. Review [this article](https://itnext.io/nvm-the-easiest-way-to-switch-node-js-environments-on-your-machine-in-a-flash-17babb7d5f1b) which clearly explains the setup and configuration of NVM. @@ -123,7 +123,7 @@ The `develop` and `main` branches have "Branch Protection" enabled in Github. In You can review full Branch Protection details [here](https://docs.google.com/document/d/1O1SGS0i3OmPfvPhylpFe1CTMkE20889iAOF_cMFJ344/edit#heading=h.cy3jfpnyvv5z), and check out a visual representation of the workflow below: -![](src/images/Dev_site_branch_protection_workflow_(develop_main).png) +![]() ### Using Conventional Commits @@ -168,7 +168,7 @@ To submit a [Draft PR](https://github.blog/2019-02-14-introducing-draft-pull-req `PR` you wish to submit. 3. Once you are ready to have the `PR` reviewed and merge, click the Ready for review button on the `PR`. -### Deploy previews with Gatsby Cloud +### Deploy previews with Gatsby Cloud PRs that are opened from a branch in this repo (not forks) will generate preview links on Gatsby Cloud automatically. Gatsby Cloud preview links can be found as comments on your pull request once they finish building. Progress can be monitored via the `Gatsby Build Service` job under the `Checks` section. @@ -399,10 +399,10 @@ need to happen: ### Step 1: Update the release number in `gatsby-config` - We use a [local Gatsby plugin `gatsby-source-newrelic-sdk`](https://github.com/newrelic/developer-website/tree/develop/plugins/gatsby-source-newrelic-sdk) -to source our documentation into GraphQL. This plugin has some configuration that tells it what release number to use. + to source our documentation into GraphQL. This plugin has some configuration that tells it what release number to use. - [Update `gatsby-config.js`](https://github.com/newrelic/developer-website/blob/ae42737f5f1cf556f3c44d864655c9a571739e28/gatsby-config.js#L161) -with the new release number to update the bundle release version. + with the new release number to update the bundle release version. - To obtain the version release number visit the `one-core` repository on Github enterprise and look at the release version in `sdk-loader.js`. You can use the one-core site to confirm if any issues are developer site specific or occurring in the SDK. @@ -420,7 +420,7 @@ If a component looks like it should be internal only, feel free to ask #help-one - We rely on the 1st party documentation bundle to power the developer docs. While the 1st party bundle provides many of the same components/APIs, there are a few minor differences between the 1st and 3rd party SDKs. To account for this, we white list the specific components we document on the site. - If there are any new components or APIs, update the [constants -list](https://github.com/newrelic/developer-website/blob/develop/plugins/gatsby-source-newrelic-sdk/src/constants.js) with the new components. + list](https://github.com/newrelic/developer-website/blob/develop/plugins/gatsby-source-newrelic-sdk/src/constants.js) with the new components. - Pages will be then automatically generated for each of the new components. > Once we have a 3rd party bundle automatically built for us, we should no longer need this step as that will contain only 3rd party SDK documentation. That is an open request to the NR One Core Team. diff --git a/README.md b/README.md index 46fbfebea..76d81ba0a 100644 --- a/README.md +++ b/README.md @@ -18,7 +18,7 @@ Your site is now running at `http://localhost:8000`! ### Dependencies -Node v12 is used in this project as specified in [.nvmrc](https://github.com/newrelic/developer-website/blob/master/.nvmrc). +Node v16 is used in this project as specified in [.nvmrc](https://github.com/newrelic/developer-website/blob/master/.nvmrc). ## 📝 Unit tests @@ -53,7 +53,8 @@ Please search for and review the existing open issues before submitting a new issue to prevent the submission of duplicate issues. ## CI/CD + ### fetch-observability-packs -* Purpose: This workflow pulls down Observability Packs from the GraphQL API, writes them to src/data/observability-packs.json (overwriting any previous content), and commits that file to the `main` branch. -* Trigger: Schedule, 12am everyday +- Purpose: This workflow pulls down Observability Packs from the GraphQL API, writes them to src/data/observability-packs.json (overwriting any previous content), and commits that file to the `main` branch. +- Trigger: Schedule, 12am everyday