chore: rename master branch to main (#581)

.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/ydh-community-contacts-api/blob/master/CONTRIBUTING.md
+Contributors guide: https://github.com/Fdawgs/ydh-community-contacts-api/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/ydh-community-contacts-api/blob/master/CONTRIBUTING.md#documentation-style)
+- [ ] Documentation has been updated and adheres to the style described in [CONTRIBUTING.md](https://github.com/Fdawgs/ydh-community-contacts-api/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 on and PRs that match the master repo
+ # Only run on main repo on and PRs that match the main repo
  if: >
  github.repository == 'Fdawgs/ydh-community-contacts-api' &&
  (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:
 
@@ -45,7 +45,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

@@ -5,8 +5,8 @@
 # Yeovil District Hospital NHS Foundation Trust - Community Contacts RESTful CRUD API
 
 [![GitHub Release](https://img.shields.io/github/release/Fdawgs/ydh-community-contacts-api.svg)](https://github.com/Fdawgs/ydh-community-contacts-api/releases/latest/)
-![Build Status](https://github.com/Fdawgs/ydh-community-contacts-api/workflows/CI/badge.svg?branch=master)
-[![Coverage Status](https://coveralls.io/repos/github/Fdawgs/ydh-community-contacts-api/badge.svg?branch=master)](https://coveralls.io/github/Fdawgs/ydh-community-contacts-api?branch=master)
+![Build Status](https://github.com/Fdawgs/ydh-community-contacts-api/workflows/CI/badge.svg?branch=main)
+[![Coverage Status](https://coveralls.io/repos/github/Fdawgs/ydh-community-contacts-api/badge.svg?branch=main)](https://coveralls.io/github/Fdawgs/ydh-community-contacts-api?branch=main)
 [![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat)](https://github.com/prettier/prettier)
 
 > Yeovil District Hospital NHSFT's RESTful CRUD API for community team contact details
@@ -115,7 +115,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 Community Contacts API documentation page" src="https://raw.githubusercontent.com/Fdawgs/ydh-community-contacts-api/master/docs/images/api_documentation_screenshot.png" width="720">
+<img alttext="Screenshot of Community Contacts API documentation page" src="https://raw.githubusercontent.com/Fdawgs/ydh-community-contacts-api/main/docs/images/api_documentation_screenshot.png" width="720">
 
 ### Generating bearer tokens for access
 

docker-compose.yml

@@ -36,7 +36,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 <[email protected]>
  org.opencontainers.image.licenses: MIT
  org.opencontainers.image.url: https://github.com/Fdawgs/ydh-community-contacts-api

src/config/index.js

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