chore: rename master branch to main (#1244)

.github/PULL_REQUEST_TEMPLATE/pull_request_template.md

@@ -4,12 +4,12 @@ the requirements below.
 
 Bug fixes and new features should include tests.
 
-Contributors guide: https://github.com/Fdawgs/docsmith/blob/master/CONTRIBUTING.md
+Contributors guide: https://github.com/Fdawgs/docsmith/blob/main/CONTRIBUTING.md
 
 -->
 
 #### Checklist
 
 -   [ ] Run `npm test`
--   [ ] Documentation has been updated and adheres to the style described in [CONTRIBUTING.md](https://github.com/Fdawgs/docsmith/blob/master/CONTRIBUTING.md#documentation-style)
+-   [ ] Documentation has been updated and adheres to the style described in [CONTRIBUTING.md](https://github.com/Fdawgs/docsmith/blob/main/CONTRIBUTING.md#documentation-style)
 -   [ ] Commit message adheres to the [Conventional commits](https://conventionalcommits.org/en/v1.0.0/) style, following the `@commitlint/config-conventional` config

.github/workflows/cd.yml

@@ -6,7 +6,7 @@ name: CD
 on:
     push:
         branches:
-            - master
+            - main
     # Allows this workflow to be run manually from the Actions tab
     workflow_dispatch:
 

.github/workflows/ci.yml

@@ -6,13 +6,13 @@ name: CI
 on:
     push:
         branches:
-            - master
+            - main
         paths-ignore:
             - "docs/**"
             - "*.md"
     pull_request:
         branches:
-            - master
+            - main
         paths-ignore:
             - "docs/**"
             - "*.md"

.github/workflows/codeql.yml

@@ -6,10 +6,10 @@ name: CodeQL Analysis
 on:
     push:
         branches:
-            - master
+            - main
     pull_request:
         branches:
-            - master
+            - main
         paths:
             - "**/*.html"
             - "**/*.js"

.github/workflows/link-check.yml

@@ -6,13 +6,13 @@ name: Check Markdown for Broken Links
 on:
     push:
         branches:
-            - master
+            - main
         paths:
             - "**/*.md"
             - "!CHANGELOG.md"
     pull_request:
         branches:
-            - master
+            - main
         paths:
             - "**/*.md"
             - "!CHANGELOG.md"

.github/workflows/optimise-images.yml

@@ -6,7 +6,7 @@ name: Optimise Images
 on:
     push:
         branches:
-            - master
+            - main
         paths:
             - "**.jpg"
             - "**.jpeg"
@@ -28,7 +28,7 @@ jobs:
     build:
         name: Optimise Images
         runs-on: ubuntu-latest
-        # Only run on master repo and PRs that match the master repo
+        # Only run on main repo and PRs that match the main repo
         if: >
             github.repository == 'Fdawgs/docsmith' &&
             (github.event_name != 'pull_request' ||

CONTRIBUTING.md

@@ -4,8 +4,8 @@ Contributions are welcome and any help that can be offered is greatly appreciate
 Please take a moment to read the entire contributing guide.
 
 This repository uses the [Feature Branch Workflow](https://atlassian.com/git/tutorials/comparing-workflows/feature-branch-workflow),
-meaning that development should take place in `feat/` branches, with the `master` branch kept in a stable state.
-When you submit pull requests, please make sure to fork from and submit back to `master`.
+meaning that development should take place in `feat/` branches, with the `main` branch kept in a stable state.
+When you submit pull requests, please make sure to fork from and submit back to `main`.
 
 Other processes and specifications that are in use in this repository are:
 
@@ -43,7 +43,7 @@ Titles and headings should use sentence-style capitalisation, where only the fir
 
 Before submitting a pull request back to the main repository, please make sure you have completed the following steps:
 
-1. Pull request base branch is set to `master`. All pull requests should be forked from and merged back to `master`
+1. Pull request base branch is set to `main`. All pull requests should be forked from and merged back to `main`
 2. Run `npm test` to check the code adheres to the defined ESLint style and that it passes the Jest tests
 3. Run `npm run lint:prettier` to run the Prettier code formatter over the code
 4. Run `npm run lint:licenses` if adding or updating production dependencies to check they use permissive licenses

README.md

@@ -2,7 +2,7 @@
 
 [![GitHub Release](https://img.shields.io/github/release/Fdawgs/docsmith.svg)](https://github.com/Fdawgs/docsmith/releases/latest/)
 ![CI](https://github.com/Fdawgs/docsmith/workflows/CI/badge.svg)
-[![Coverage Status](https://coveralls.io/repos/github/Fdawgs/docsmith/badge.svg?branch=master)](https://coveralls.io/github/Fdawgs/docsmith?branch=master)
+[![Coverage Status](https://coveralls.io/repos/github/Fdawgs/docsmith/badge.svg?branch=main)](https://coveralls.io/github/Fdawgs/docsmith?branch=main)
 [![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat)](https://github.com/prettier/prettier)
 
 > RESTful API for converting clinical documents and files
@@ -105,7 +105,7 @@ If using a Microsoft Windows OS utilise [pm2-installer](https://github.com/jesse
 
 API documentation can be found at `/docs`:
 
-<img alttext="Screenshot of Docsmith documentation page" src="https://raw.githubusercontent.com/Fdawgs/docsmith/master/docs/images/api_documentation_screenshot.png" width="720">
+<img alttext="Screenshot of Docsmith documentation page" src="https://raw.githubusercontent.com/Fdawgs/docsmith/main/docs/images/api_documentation_screenshot.png" width="720">
 
 ## Contributing
 

docker-compose.yml

@@ -24,7 +24,7 @@ services:
             retries: 3
         labels:
             # Using OCI Image Format spec
-            # See https://github.com/opencontainers/image-spec/blob/master/annotations.md
+            # See https://github.com/opencontainers/image-spec/blob/main/annotations.md
             org.opencontainers.image.authors: Frazer Smith <frazer.dev@outlook.com>
             org.opencontainers.image.licenses: MIT
             org.opencontainers.image.url: https://github.com/Fdawgs/docsmith

src/config/index.js

@@ -240,7 +240,7 @@ async function getConfig() {
 					},
 					license: {
 						name: license,
-						url: "https://raw.githubusercontent.com/Fdawgs/docsmith/master/LICENSE",
+						url: "https://raw.githubusercontent.com/Fdawgs/docsmith/main/LICENSE",
 					},
 					version,
 					// Redoc specific extension to support loading image in docs

src/plugins/pdf-to-html/index.js

@@ -21,7 +21,7 @@ const parseString = require("../../utils/parse-string");
  * @param {object} options - Plugin config values.
  * @param {string} options.binPath - Path to Poppler binary.
  * @param {object} options.pdfToHtmlOptions - Refer to
- * https://github.com/Fdawgs/node-poppler/blob/master/API.md#Poppler+pdfToHtml
+ * https://github.com/Fdawgs/node-poppler/blob/main/API.md#Poppler+pdfToHtml
  * for options.
  * @param {string} options.pdfToHtmlOptions.encoding - Sets the encoding to use for text output.
  * @param {string} options.tempDir - Directory for temporarily storing

src/plugins/pdf-to-txt/index.js

@@ -18,7 +18,7 @@ const parseString = require("../../utils/parse-string");
  * @param {object} options - Plugin config values.
  * @param {string} options.binPath - Path to Poppler binary.
  * @param {object=} options.pdfToTxtOptions - Refer to
- * https://github.com/Fdawgs/node-poppler/blob/master/API.md#Poppler+pdfToText
+ * https://github.com/Fdawgs/node-poppler/blob/main/API.md#Poppler+pdfToText
  * for options.
  * @param {string=} options.pdfToTxtOptions.encoding - Sets the encoding to use for text output.
  * @param {string} options.tempDir - Directory for temporarily storing

src/plugins/rtf-to-html/index.js

@@ -18,7 +18,7 @@ const { randomUUID } = require("crypto");
  * @param {object} options - Plugin config values.
  * @param {string} options.binPath - Path to UnRTF binary.
  * @param {object=} options.rtfToHtmlOptions - Refer to
- * https://github.com/Fdawgs/node-unrtf/blob/master/API.md
+ * https://github.com/Fdawgs/node-unrtf/blob/main/API.md
  * for options.
  * @param {string} options.tempDir - Directory for temporarily storing
  * files during conversion.

src/plugins/rtf-to-txt/index.js

@@ -16,7 +16,7 @@ const { randomUUID } = require("crypto");
  * @param {object} options - Plugin config values.
  * @param {string} options.binPath - Path to UnRTF binary.
  * @param {object=} options.rtfToTxtOptions - Refer to
- * https://github.com/Fdawgs/node-unrtf/blob/master/API.md
+ * https://github.com/Fdawgs/node-unrtf/blob/main/API.md
  * for options.
  * @param {string} options.tempDir - Directory for temporarily storing
  * files during conversion.