docs updated v4.0.0

assets/highlight.css

@@ -1,16 +1,18 @@
 :root {
-    --light-hl-0: #000000;
-    --dark-hl-0: #D4D4D4;
-    --light-hl-1: #A31515;
-    --dark-hl-1: #CE9178;
-    --light-hl-2: #0451A5;
-    --dark-hl-2: #9CDCFE;
-    --light-hl-3: #800000;
+    --light-hl-0: #795E26;
+    --dark-hl-0: #DCDCAA;
+    --light-hl-1: #000000;
+    --dark-hl-1: #D4D4D4;
+    --light-hl-2: #A31515;
+    --dark-hl-2: #CE9178;
+    --light-hl-3: #0000FF;
     --dark-hl-3: #569CD6;
-    --light-hl-4: #0000FF;
-    --dark-hl-4: #CE9178;
-    --light-hl-5: #0000FF;
+    --light-hl-4: #0451A5;
+    --dark-hl-4: #9CDCFE;
+    --light-hl-5: #800000;
     --dark-hl-5: #569CD6;
+    --light-hl-6: #0000FF;
+    --dark-hl-6: #CE9178;
     --light-code-background: #FFFFFF;
     --dark-code-background: #1E1E1E;
 }
@@ -22,6 +24,7 @@
     --hl-3: var(--light-hl-3);
     --hl-4: var(--light-hl-4);
     --hl-5: var(--light-hl-5);
+    --hl-6: var(--light-hl-6);
     --code-background: var(--light-code-background);
 } }
 
@@ -32,6 +35,7 @@
     --hl-3: var(--dark-hl-3);
     --hl-4: var(--dark-hl-4);
     --hl-5: var(--dark-hl-5);
+    --hl-6: var(--dark-hl-6);
     --code-background: var(--dark-code-background);
 } }
 
@@ -42,6 +46,7 @@
     --hl-3: var(--light-hl-3);
     --hl-4: var(--light-hl-4);
     --hl-5: var(--light-hl-5);
+    --hl-6: var(--light-hl-6);
     --code-background: var(--light-code-background);
 }
 
@@ -52,6 +57,7 @@
     --hl-3: var(--dark-hl-3);
     --hl-4: var(--dark-hl-4);
     --hl-5: var(--dark-hl-5);
+    --hl-6: var(--dark-hl-6);
     --code-background: var(--dark-code-background);
 }
 
@@ -61,4 +67,5 @@
 .hl-3 { color: var(--hl-3); }
 .hl-4 { color: var(--hl-4); }
 .hl-5 { color: var(--hl-5); }
+.hl-6 { color: var(--hl-6); }
 pre, code { background: var(--code-background); }

assets/style.css

@@ -483,10 +483,9 @@ blockquote {
     .has-menu .col-menu {
         visibility: visible;
         transform: translate(0, 0);
-        display: grid;
-        align-items: center;
-        grid-template-rows: auto 1fr;
-        grid-gap: 1.5rem;
+        display: flex;
+        flex-direction: column;
+        gap: 1.5rem;
         max-height: 100vh;
         padding: 1rem 2rem;
     }
@@ -911,7 +910,7 @@ a.tsd-index-link {
     margin-right: 0.8rem;
 }
 
-@media (min-width: 1024px) {
+@media (min-width: 1025px) {
     .col-content {
         margin: 2rem auto;
     }

functions/success.html

@@ -30,7 +30,7 @@ <h5>pluginConfig: <span class="tsd-signature-type">Partial</span><span class="ts
 <h5>context: <span class="tsd-signature-type">Context</span></h5></li></ul></div>
 <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/saitho/semantic-release-backmerge/blob/c8cd9c7/src/index.ts#L53">index.ts:53</a></li></ul></aside></li></ul></section></div>
+<li>Defined in <a href="https://github.com/saitho/semantic-release-backmerge/blob/e618c08/src/index.ts#L53">index.ts:53</a></li></ul></aside></li></ul></section></div>
 <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
 <div class="tsd-navigation settings">
 <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">

functions/verifyConditions.html

@@ -31,7 +31,7 @@ <h5>pluginConfig: <span class="tsd-signature-type">Config</span></h5></li>
 <h5>context: <span class="tsd-signature-type">Context</span></h5></li></ul></div>
 <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
 <ul>
-<li>Defined in <a href="https://github.com/saitho/semantic-release-backmerge/blob/c8cd9c7/src/index.ts#L17">index.ts:17</a></li></ul></aside></li></ul></section></div>
+<li>Defined in <a href="https://github.com/saitho/semantic-release-backmerge/blob/e618c08/src/index.ts#L17">index.ts:17</a></li></ul></aside></li></ul></section></div>
 <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
 <div class="tsd-navigation settings">
 <details class="tsd-index-accordion"><summary class="tsd-accordion-summary">

index.html

@@ -44,7 +44,7 @@ <h1>@saithodev/semantic-release-backmerge</h1>
 <a href="#install" id="install" style="color: inherit; text-decoration: none;">
   <h2>Install</h2>
 </a>
-<pre><code class="language-bash"><span class="hl-0">$ </span><span class="hl-1">npm</span><span class="hl-0"> </span><span class="hl-1">install</span><span class="hl-0"> </span><span class="hl-1">@saithodev/semantic-release-backmerge</span><span class="hl-0"> </span><span class="hl-1">-D</span>
+<pre><code class="language-bash"><span class="hl-0">$</span><span class="hl-1"> </span><span class="hl-2">npm</span><span class="hl-1"> </span><span class="hl-2">install</span><span class="hl-1"> </span><span class="hl-2">@saithodev/semantic-release-backmerge</span><span class="hl-1"> </span><span class="hl-3">-D</span>
 </code></pre>
 
 <a href="#usage" id="usage" style="color: inherit; text-decoration: none;">
@@ -53,7 +53,7 @@ <h2>Usage</h2>
 <p>The plugin can be configured in the <a href="https://github.com/semantic-release/semantic-release/blob/master/docs/usage/configuration.md#configuration"><strong>semantic-release</strong> configuration file</a>:</p>
 <p><strong>Note:</strong> As this plugin will rebase your &quot;develop&quot; branch onto your &quot;master&quot; branch, you may not have any unstaged files in your workspace.
 If you do, you may set the <a href="#clearWorkspace">clearWorkspace</a> option to stash them and restore them with <a href="#restoreWorkspace">restoreWorkspace</a> if needed.</p>
-<pre><code class="language-json"><span class="hl-0">{</span><br/><span class="hl-0">  </span><span class="hl-2">&quot;plugins&quot;</span><span class="hl-0">: [</span><br/><span class="hl-0">    </span><span class="hl-1">&quot;@semantic-release/commit-analyzer&quot;</span><span class="hl-0">,</span><br/><span class="hl-0">    </span><span class="hl-1">&quot;@semantic-release/release-notes-generator&quot;</span><span class="hl-0">,</span><br/><span class="hl-0">    [</span><br/><span class="hl-0">      </span><span class="hl-1">&quot;@saithodev/semantic-release-backmerge&quot;</span><span class="hl-0">,</span><br/><span class="hl-0">      {</span><br/><span class="hl-0">        </span><span class="hl-2">&quot;backmergeBranches&quot;</span><span class="hl-0">: [</span><span class="hl-1">&quot;dev&quot;</span><span class="hl-0">],</span><br/><span class="hl-0">        </span><span class="hl-2">&quot;plugins&quot;</span><span class="hl-0">: [</span><br/><span class="hl-0">          [</span><br/><span class="hl-0">            </span><span class="hl-1">&quot;@semantic-release/exec&quot;</span><span class="hl-0">,</span><br/><span class="hl-0">            {</span><br/><span class="hl-0">              </span><span class="hl-2">&quot;successCmd&quot;</span><span class="hl-0">: </span><span class="hl-1">&quot;echo &#39;Version in master is ${nextRelease.version}&#39; &gt; test.txt &amp;&amp; git add test.txt&quot;</span><br/><span class="hl-0">            }</span><br/><span class="hl-0">          ]</span><br/><span class="hl-0">        ]</span><br/><span class="hl-0">      }</span><br/><span class="hl-0">    ]</span><br/><span class="hl-0">  ]</span><br/><span class="hl-0">}</span>
+<pre><code class="language-json"><span class="hl-1">{</span><br/><span class="hl-1">  </span><span class="hl-4">&quot;plugins&quot;</span><span class="hl-1">: [</span><br/><span class="hl-1">    </span><span class="hl-2">&quot;@semantic-release/commit-analyzer&quot;</span><span class="hl-1">,</span><br/><span class="hl-1">    </span><span class="hl-2">&quot;@semantic-release/release-notes-generator&quot;</span><span class="hl-1">,</span><br/><span class="hl-1">    [</span><br/><span class="hl-1">      </span><span class="hl-2">&quot;@saithodev/semantic-release-backmerge&quot;</span><span class="hl-1">,</span><br/><span class="hl-1">      {</span><br/><span class="hl-1">        </span><span class="hl-4">&quot;backmergeBranches&quot;</span><span class="hl-1">: [</span><span class="hl-2">&quot;dev&quot;</span><span class="hl-1">],</span><br/><span class="hl-1">        </span><span class="hl-4">&quot;plugins&quot;</span><span class="hl-1">: [</span><br/><span class="hl-1">          [</span><br/><span class="hl-1">            </span><span class="hl-2">&quot;@semantic-release/exec&quot;</span><span class="hl-1">,</span><br/><span class="hl-1">            {</span><br/><span class="hl-1">              </span><span class="hl-4">&quot;successCmd&quot;</span><span class="hl-1">: </span><span class="hl-2">&quot;echo &#39;Version in master is ${nextRelease.version}&#39; &gt; test.txt &amp;&amp; git add test.txt&quot;</span><br/><span class="hl-1">            }</span><br/><span class="hl-1">          ]</span><br/><span class="hl-1">        ]</span><br/><span class="hl-1">      }</span><br/><span class="hl-1">    ]</span><br/><span class="hl-1">  ]</span><br/><span class="hl-1">}</span>
 </code></pre>
 
 <a href="#jenkins" id="jenkins" style="color: inherit; text-decoration: none;">
@@ -77,7 +77,7 @@ <h3>Backmerging into protected branches</h3>
 <p>You can backmerge into protected branches if repository admins/owners are allowed to do that.
 Make sure to provide an admin/owner&#39;s access token or credentials (e.g. via <code>GITHUB_TOKEN</code>).</p>
 <p><strong>For GitHub Actions</strong> you also need to disable <code>persist-credentials</code> in the checkout action:</p>
-<pre><code class="language-yaml"><span class="hl-0">- </span><span class="hl-3">uses</span><span class="hl-0">: </span><span class="hl-4">actions/checkout@v2</span><br/><span class="hl-0">  </span><span class="hl-3">with</span><span class="hl-0">:</span><br/><span class="hl-0">    </span><span class="hl-3">persist-credentials</span><span class="hl-0">: </span><span class="hl-5">false</span>
+<pre><code class="language-yaml"><span class="hl-1">- </span><span class="hl-5">uses</span><span class="hl-1">: </span><span class="hl-6">actions/checkout@v2</span><br/><span class="hl-1">  </span><span class="hl-5">with</span><span class="hl-1">:</span><br/><span class="hl-1">    </span><span class="hl-5">persist-credentials</span><span class="hl-1">: </span><span class="hl-3">false</span>
 </code></pre>
 <p>The personal access token in <code>GITHUB_TOKEN</code> needs access to the <code>repo</code> scope.</p>
 
@@ -152,7 +152,7 @@ <h4><code>backmergeBranches</code></h4>
 In this example, a release from <code>master</code> branch is merged into <code>dev</code> branch. With that you can perform conditional backmerges,
 i.e. backmerges that only occur when merged from a certain branch.</p>
 <p>Here is an example where all releases will backmerge into <code>develop</code> and releases from <code>next</code> branch will be backmerged into <code>staging</code> as well.</p>
-<pre><code class="language-json"><span class="hl-0">{</span><br/><span class="hl-0">  </span><span class="hl-2">&quot;plugins&quot;</span><span class="hl-0">: [</span><br/><span class="hl-0">    </span><span class="hl-1">&quot;@semantic-release/commit-analyzer&quot;</span><span class="hl-0">,</span><br/><span class="hl-0">    </span><span class="hl-1">&quot;@semantic-release/release-notes-generator&quot;</span><span class="hl-0">,</span><br/><span class="hl-0">    [</span><br/><span class="hl-0">      </span><span class="hl-1">&quot;@saithodev/semantic-release-backmerge&quot;</span><span class="hl-0">,</span><br/><span class="hl-0">      {</span><br/><span class="hl-0">        </span><span class="hl-2">&quot;backmergeBranches&quot;</span><span class="hl-0">: [</span><span class="hl-1">&quot;develop&quot;</span><span class="hl-0">, {</span><span class="hl-2">&quot;from&quot;</span><span class="hl-0">: </span><span class="hl-1">&quot;next&quot;</span><span class="hl-0">, </span><span class="hl-2">&quot;to&quot;</span><span class="hl-0">: </span><span class="hl-1">&quot;staging&quot;</span><span class="hl-0">}]</span><br/><span class="hl-0">      }</span><br/><span class="hl-0">    ]</span><br/><span class="hl-0">  ]</span><br/><span class="hl-0">}</span>
+<pre><code class="language-json"><span class="hl-1">{</span><br/><span class="hl-1">  </span><span class="hl-4">&quot;plugins&quot;</span><span class="hl-1">: [</span><br/><span class="hl-1">    </span><span class="hl-2">&quot;@semantic-release/commit-analyzer&quot;</span><span class="hl-1">,</span><br/><span class="hl-1">    </span><span class="hl-2">&quot;@semantic-release/release-notes-generator&quot;</span><span class="hl-1">,</span><br/><span class="hl-1">    [</span><br/><span class="hl-1">      </span><span class="hl-2">&quot;@saithodev/semantic-release-backmerge&quot;</span><span class="hl-1">,</span><br/><span class="hl-1">      {</span><br/><span class="hl-1">        </span><span class="hl-4">&quot;backmergeBranches&quot;</span><span class="hl-1">: [</span><span class="hl-2">&quot;develop&quot;</span><span class="hl-1">, {</span><span class="hl-4">&quot;from&quot;</span><span class="hl-1">: </span><span class="hl-2">&quot;next&quot;</span><span class="hl-1">, </span><span class="hl-4">&quot;to&quot;</span><span class="hl-1">: </span><span class="hl-2">&quot;staging&quot;</span><span class="hl-1">}]</span><br/><span class="hl-1">      }</span><br/><span class="hl-1">    ]</span><br/><span class="hl-1">  ]</span><br/><span class="hl-1">}</span>
 </code></pre>
 <p>You may use <a href="https://lodash.com/docs#template">Lodash template</a> variables in branch name strings. The following variables are available:</p>
 <table>