fix: switch from master to main as default branch

Author: DaRaFF

README.md

@@ -11,9 +11,9 @@ This repository provides a npx script to patch the release notes in our document
 
 ## Use Case 2 - Upcoming Release
 
-**Goal:** Add every merge to master to the upcoming release notes to simplify the preparation for the next release
+**Goal:** Add every merge to main to the upcoming release notes to simplify the preparation for the next release
 
-**How:** With every merge to `master` on the `livingdocs-server` and `livingdocs-editor`, the script gets the PR information and pushes it on top of the [upcoming release](https://docs.livingdocs.io/operations/releases/master/) in the documentation repository.
+**How:** With every merge to `main` on the `livingdocs-server` and `livingdocs-editor`, the script gets the PR information and pushes it on top of the upcoming release in the documentation repository.
 
 # Usage
 

cli.js

@@ -1,5 +1,5 @@
 #!/usr/bin/env node
-console.log('release-notes-patch -> v1.6.1 (handle when no PR has been opened)')
+console.log('release-notes-patch -> v1.6.2 (switch docu repo from master to main as default branch)')
 const argv = require('yargs')
   .demandOption(['token', 'owner', 'repo', 'sha', 'tag'])
   .help(false)

index.js

@@ -14,8 +14,8 @@ const branches = createBranchList({
   time: moment(Date.now()).format('YYYY-MM'),
   months: {before: 8, after: 4}
 })
-// add 'master' to live patch the upcoming release notes
-branches.push('master')
+// add 'main' to live patch the upcoming release notes
+branches.push('main')
 
 const targetOwner = 'livingdocsIO'
 const targetRepo = 'documentation'
@@ -39,9 +39,9 @@ module.exports = async ({token, owner, repo, sha, tag, test = false} = {}) => {
 
   let patchedReleaseNotes
   // patch release notes detail for upcoming release
-  if (release.branchName === 'master') {
+  if (release.branchName === 'main') {
     const pull = await getPullBySha({owner, repo, token, sha})
-    if (!pull) return `Release notes will not be extended, because no PR found for commit ${sha} in ${owner}/${repo}. \nThis happens when someone pushes to master without opening a PR.`
+    if (!pull) return `Release notes will not be extended, because no PR found for commit ${sha} in ${owner}/${repo}. \nThis happens when someone pushes to main without opening a PR.`
     patchedReleaseNotes = addPatchToUpcomingReleaseNote({
       repo,
       releaseNote: originReleaseNote,

lib/add-patch-to-release-note.js

@@ -8,7 +8,7 @@ module.exports = ({owner, repo, releaseNote, tag, path, message}) => {
   // do nothing when tag info already exists in release notes
   if (releaseNote.includes(tag)) {
     throw (new Error(
-      `https://github.com/${owner}/${repo}/blob/master/${path} will not be updated, because ${tag} is already documented`
+      `https://github.com/${owner}/${repo}/blob/main/${path} will not be updated, because ${tag} is already documented`
     ))
   }
 

lib/get-release-note.js

@@ -7,7 +7,7 @@ module.exports = async ({owner, repo, path, token}) => {
       repo,
       token,
       path,
-      branch: 'master'
+      branch: 'main'
     })
   } catch (error) {
     console.log(err)

lib/git/get-content.js

@@ -4,7 +4,7 @@ const axios = require('axios')
 //
 // @return
 module.exports = async ({
-  owner, repo, token, path, branch = 'master'
+  owner, repo, token, path, branch = 'main'
 }) => {
   try {
     const res = await axios({

lib/git/get-pull-by-sha.js

@@ -12,7 +12,7 @@ module.exports = async ({owner, repo, token, sha}) => {
       }
     })
 
-    // when someone pushes to master without opening a PR
+    // when someone pushes to main without opening a PR
     if(res.data.length === 0) return
 
     return {

lib/git/update-content.js

@@ -2,7 +2,7 @@ const axios = require('axios')
 
 // https://docs.github.com/en/rest/reference/repos#create-or-update-file-contents
 module.exports = async ({
-  owner, repo, token, path, message, content, sha, branch = 'master'
+  owner, repo, token, path, message, content, sha, branch = 'main'
 }) => {
   const res = await axios({
     method: 'put',