Skip to content
Merged
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
14 changes: 7 additions & 7 deletions docs/devGuide/development/migratingNodeJs.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,35 +40,35 @@ Switch to use the Node.js version that you are migrating to.
- Go through the list of deprecated syntax and check if it is being used in MarkBind
- Replace any deprecated syntax
2. Check that all user-facing functionalities are working
- A quick way to do this is to go to the [Reader Facing Features in the User Guide]({{baseUrl}}/userGuide/readerFacingFeatures.html) and check that these features are still working as expected.
- A quick way to do this is to go to the <a tags="environment--combined" href="/userGuide/readerFacingFeatures.html">Reader Facing Features in the User Guide</a><a tags="environment--dg" href="https://markbind.org/userGuide/readerFacingFeatures.html">Reader Facing Features in the User Guide</a>.
3. Check that there are no issues with development setup
- Set up the development environment by running through the steps in [Setting Up]({{baseUrl}}/devdocs/devGuide/development/settingUp.html) to ensure there are no problems
- Set up the development environment by running through the steps in [Setting Up]({{baseUrl}}/devGuide/development/settingUp.html) to ensure there are no problems
4. Update GitHubActions
- Go to [MarkBind/markbind-action](https://github.com/MarkBind/markbind-action) and update the Node.js version numbers
- See [Update node version from 14 to 16 PR](https://github.com/MarkBind/markbind-action/pull/8/files) for an example
- Test there are no issues with workflows
- Testing instructions located here: [markbind-action]({{baseUrl}}/devdocs/devGuide/githubActions/markbindAction.html) and [markbind-reusable-workflows]({{baseUrl}}/devdocs/devGuide/githubActions/markbindReusableWorkflows.html)
- Testing instructions located here: [markbind-action]({{baseUrl}}/devGuide/githubActions/markbindAction.html) and [markbind-reusable-workflows]({{baseUrl}}/devGuide/githubActions/markbindReusableWorkflows.html)
<box type="info" seamless header="If a different npm version is needed">

Install correct version of npm in `action.yml` and `fork-build.yml`. Refer to [Update node version from 14 to 16 PR](https://github.com/MarkBind/markbind-action/pull/8/files) to see where npm install should be run. </box>
5. Check deployment to Netlify/other platforms
- Deployment to Netlify
- Follow steps in [Deploying to Netlify]({{baseUrl}}/userGuide/deployingTheSite.html#deploying-to-netlify) but change the `NODE_VERSION` value accordingly. Check there are no issues with deployment and deployed site is as expected.
- Follow steps in <a tags="environment--combined" href="/userGuide/deployingTheSite.html#deploying-to-netlify">Deploying to Netlify</a><a tags="environment--dg" href="https://markbind.org/userGuide/deployingTheSite.html#deploying-to-netlify">Deploying to Netlify</a> but change the `NODE_VERSION` value accordingly. Check there are no issues with deployment and deployed site is as expected.
- MarkBind has two repos [init-minimal-netlify](https://github.com/MarkBind/init-minimal-netlify) and [init-typical-netlify](https://github.com/MarkBind/init-typical-netlify) which allows deployment to Netlify by using a config file. Update the config file `netlify.toml` with the correct Node.js version and check that deployment using button in `README` works as expected.
<box type="info" seamless header="If a different npm version is needed">

To specify the npm version add an environment variable `NPM_VERSION` with the correct version number. </box>
- Deployment to Github pages
- Using the `markbind deploy command`
- Build site using correct Node.js version
- Follow steps in [Using the `markbind deploy` command]({{baseUrl}}/userGuide/deployingTheSite.html#deploying-to-github-pages) and check there are no issues with deployment or with the site.
- Follow steps in <a tags="environment--combined" href="/userGuide/deployingTheSite.html#deploying-to-github-pages">Using the `markbind deploy` command</a><a tags="environment--dg" href="https://markbind.org/userGuide/deployingTheSite.html#deploying-to-github-pages">Using the `markbind deploy` command</a> and check there are no issues with deployment or with the site.
- Using CI platforms
- Follow steps in [Using CI Platforms]({{baseUrl}}/userGuide/deployingTheSite.html#using-ci-platforms) but update the config files for the various CI Platforms to use the correct Node.js version. Try deploying and ensure there are no problems with deployment.
- Follow steps in <a tags="environment--combined" href="/userGuide/deployingTheSite.html#using-ci-platforms">Using CI Platforms</a><a tags="environment--dg" href="https://markbind.org/userGuide/deployingTheSite.html#using-ci-platforms">Using CI Platforms</a> but update the config files for the various CI Platforms to use the correct Node.js version. Try deploying and ensure there are no problems with deployment.
<box type="info" seamless header="If a different npm version is needed">
Install the correct npm version before running npm commands. </box>
6. Update documentation
- Update Node.js and npm version in documentation. See [Update to use Node 16](https://github.com/MarkBind/markbind/pull/2233/files#diff-0f8e38868f41667abec6adacbb5131fbd6999c4913fc43e3429390b744f7a1f3) as an example. <box type="tip" seamless>
Don't forget to update the version numbers in the example config files in [Deploying the Site]({{baseUrl}}/userGuide/deployingTheSite.html)!
Don't forget to update the version numbers in the example config files in <a tags="environment--combined" href="/userGuide/deployingTheSite.html">Deploying the Site</a><a tags="environment--dg" href="https://markbind.org/userGuide/deployingTheSite.html">Deploying the Site</a>!
</box>

{% from "njk/common.njk" import previous_next %}
Expand Down