feat: Adding main as a default branch as per latest GitHub defaults.

Author: idc101

README.md

@@ -16,7 +16,7 @@ For more information head to the [project site](https://idc101.github.io/git-mkv
 - Tag the current commit with the next version number
 
 Works out of the box with trunk based development, GitFlow and GithubFlow. Alternatively all of this can be configured
-based on the branch name so release/master branches get different version numbers to develop or feature branches.
+based on the branch name so release/main branches get different version numbers to develop or feature branches.
 
 ## Installation
 

docs/branching_models.md

@@ -1,7 +1,7 @@
 # Branching Models
 
 Below are some popular git branching development models and how to configure them with git-mkver:
-- master (aka trunk) based development
+- main (aka trunk) based development
 - Git flow
 - GitHub flow
 
@@ -11,17 +11,17 @@ Regardless of the branching strategy, git-mkver uses the commit messages to dete
 
 See [Usage](usage) for more details.
 
-## master (aka trunk) based development
+## main (aka trunk) based development
 
 This mode of operation works out of the box with the default configuration.
 
 Overview:
 
-- Developers commit to master or work on feature branches
-- All releases are done from the master branch
-- Only the master branch is tagged
+- Developers commit to main or work on feature branches
+- All releases are done from the main branch
+- Only the main branch is tagged
 - Release Candidates are not used
-- Any version number not from master includes build metadata to indicate it is not an official release
+- Any version number not from main includes build metadata to indicate it is not an official release
 
 ### Build Server Setup
 

docs/config_examples.md

@@ -37,7 +37,7 @@ format for Docker tags like so:
 ```hocon
 branches: [
   {
-    pattern: "master"
+    pattern: "main"
     includeBuildMetaData: false
     tag: true
     formats: [

docs/config_reference.md

@@ -9,7 +9,7 @@ git-mkver will search for config in this order:
 - `mkver.conf` in the current working directory
 
 The application uses the HOCON format. More details on the specification can be found
-[here](https://github.com/lightbend/config/blob/master/HOCON.md).
+[here](https://github.com/lightbend/config/blob/main/HOCON.md).
 
 Environment variables can be resolved in the config using the syntax `${?ENV_VAR_NAME}`.
 
@@ -65,7 +65,7 @@ defaults {
 # branches are tried for matches in order
 branches: [
   {
-    pattern: "master"
+    pattern: "main"
     tag: true
     includeBuildMetaData: false
   }

docs/index.md

@@ -14,11 +14,11 @@
     - Many others, fully configurable
 - Tag the current commit with the next version
 - Works with all branching strategies:
-    - [master/trunk based development](https://trunkbaseddevelopment.com/)
+    - [main/trunk based development](https://trunkbaseddevelopment.com/)
     - [Git Flow](https://nvie.com/posts/a-successful-git-branching-model/) 
     - [GitHub Flow](https://guides.github.com/introduction/flow/)
 
-All of this can be configured based on the branch name so release/master
+All of this can be configured based on the branch name so release/main
 branches get different version numbers to develop or feature branches.
 
 ## Getting started

docs/installation.md

@@ -21,7 +21,7 @@ brew install idc101/gitmkver/git-mkver
 Install with [scoop](https://scoop.sh):
 
 ```cmd
-scoop install https://raw.githubusercontent.com/idc101/git-mkver/master/etc/scoop/git-mkver.json
+scoop install https://raw.githubusercontent.com/idc101/git-mkver/main/etc/scoop/git-mkver.json
 ```
 
 ## Manual

docs/test.md

@@ -2,7 +2,7 @@
 
 <script src="https://cdn.jsdelivr.net/npm/@gitgraph/js"></script>
 
-<div id="master-version-inc-container"></div>
+<div id="main-version-inc-container"></div>
 
 <!-- Use the `GitgraphJS` global variable to create your graph -->
 <script>
@@ -26,16 +26,16 @@ var withoutHash = GitgraphJS.templateExtend(GitgraphJS.TemplateName.Metro, {
 
 function f1() {
     // Get the graph container HTML element.
-    const graphContainer = document.getElementById("master-version-inc-container");
+    const graphContainer = document.getElementById("main-version-inc-container");
 
     // Instantiate the graph.
     const gitgraph = GitgraphJS.createGitgraph(graphContainer, {
       template: withoutHash,
     });
 
     // Simulate git commands with Gitgraph API.
-    const master = gitgraph.branch("master");
-    master
+    const main = gitgraph.branch("main");
+    main
       .commit("some code").tag("v4.2.5")
       .commit("feat: some more code").tag("v4.3.0")
       .commit("fix: a fix")
@@ -53,6 +53,6 @@ function f1() {
     //develop.merge(aFeature);
     //develop.commit("Prepare v1");
 
-    //master.merge(develop).tag("v1.0.0");
+    //main.merge(develop).tag("v1.0.0");
 }
 </script>

src/main/resources/reference.conf

@@ -1,5 +1,5 @@
-# The reference config is suitable for basic master based SemVer development
-# - releases are done from master
+# The reference config is suitable for basic master/main based SemVer development
+# - releases are done from main
 # - no other branches will be tagged
 mode: SemVer
 tagPrefix: v
@@ -19,6 +19,11 @@ branches: [
     tag: true
     includeBuildMetaData: false
   }
+  {
+    pattern: "main"
+    tag: true
+    includeBuildMetaData: false
+  }
 ]
 commitMessageActions: [
   {

src/main/scala/net/cardnell/mkver/AppConfig.scala

@@ -187,6 +187,7 @@ object AppConfig {
   )
   val defaultBranchConfigs: List[BranchConfig] = List(
     BranchConfig("master", Some(true), None, None, None, Some(false), None, None, None),
+    BranchConfig("main", Some(true), None, None, None, Some(false), None, None, None),
     BranchConfig("rel[/-].*", Some(true), None, None, None, Some(false), None, None, None),
     BranchConfig("release[/-].*", Some(true), None, None, None, Some(false), None, None, None),
     BranchConfig("hotfix[/-].*", Some(true), None, None, None, Some(false), None, None, None)

src/test/resources/test-config1.conf

@@ -16,7 +16,7 @@ defaults {
 }
 branches: [
   {
-    pattern: "master"
+    pattern: "main"
     versionFormat: Version
     tag: true
   }