<p>A new release can happen at any time from the <code>main</code> branch of the <ahref="https://github.com/McShelby/hugo-theme-relearn"target="_blank">GitHub project</a> without further accknowledgment. This makes it necessary that, every pushed set of changesets into the <code>main</code> branch <strong>must</strong> be self-contained and correct, resulting in a releasable version.</p>
<p>Stay simple for the user by focusing on the mantra “convention over configuration”.</p>
<p>At installation the site should work reasonable without (m)any configuration.</p>
<p>Stay close to the Hugo way.</p>
<p>Don’t use npm or any preprocessing, our contributors may not be front-end developers.</p>
<p>Document new features in the exampleSite. This also contains entries to the <ahref="../basics/migration/">What’s new</a> page.</p>
<p>Don’t break existing features if you don’t have to.</p>
<p>Remove reported issue from the browser’s console.</p>
<p>Check for unnecessary whitespace and correct indention of your resulting HTML.</p>
<p>Be compatible to IE11, at least for main functionality, this means:</p>
<ul>
<li>test in IE11</li>
<li>check caniuse.com</li>
<li>don’t use JavaScript arrow functions</li>
<li>don’t use JavaScript template literals</li>
<li>don’t use other fancy JavaScript ES5/6 stuff</li>
<p>Write commit messages in the <ahref="https://www.conventionalcommits.org/en/v1.0.0/"target="_blank">conventional commit</a> format.</p>
<p>Following is an impomplete list of some of the used conventional commit types. Be creative.</p>
<table>
<thead>
<tr>
<th>Common</th>
<th>Feature</th>
<th>Structure</th>
<th>Shortcodes</th>
</tr>
</thead>
<tbody>
<tr>
<td>build</td>
<td>a11y</td>
<td>favicon</td>
<td>attachments</td>
</tr>
<tr>
<td>browser</td>
<td>archetypes</td>
<td>search</td>
<td>badge</td>
</tr>
<tr>
<td>chore</td>
<td>alias</td>
<td>menu</td>
<td>button</td>
</tr>
<tr>
<td>docs</td>
<td>generator</td>
<td>history</td>
<td>children</td>
</tr>
<tr>
<td>shortcodes</td>
<td>i18n</td>
<td>scrollbar</td>
<td>expand</td>
</tr>
<tr>
<td>theme</td>
<td>mobile</td>
<td>nav</td>
<td>icon</td>
</tr>
<tr>
<td></td>
<td>print</td>
<td>toc</td>
<td>include</td>
</tr>
<tr>
<td></td>
<td>rss</td>
<td>clipboard</td>
<td>math</td>
</tr>
<tr>
<td></td>
<td>variant</td>
<td>syntaxhighlight</td>
<td>mermaid</td>
</tr>
<tr>
<td></td>
<td></td>
<td>boxes</td>
<td>notice</td>
</tr>
<tr>
<td></td>
<td></td>
<td></td>
<td>piratify</td>
</tr>
<tr>
<td></td>
<td></td>
<td></td>
<td>siteparam</td>
</tr>
<tr>
<td></td>
<td></td>
<td></td>
<td>swagger</td>
</tr>
<tr>
<td></td>
<td></td>
<td></td>
<td>tabs</td>
</tr>
</tbody>
</table>
<footerclass="footline">
</footer>
</article>
<articleclass="default">
<h1id="issue-and-release-management">Issue and Release Management</h1>
<h2id="semver">Semver</h2>
<p>This project tries to follow the <ahref="https://semver.org/"target="_blank">semver policy</a> - although not followed 100% in the past.</p>
<p>Usually an entry of <spanclass="badge cstyle warning badge-with-title"><spanclass="badge-title"><iclass="fa-fw fas fa-exclamation-triangle"></i></span><spanclass="badge-content">Breaking</span></span> on the <ahref="../basics/migration/">What’s new</a> page causes a new major release number.</p>
<p>All other entries on the <ahref="../basics/migration/">What’s new</a> page will increase the minor release number.</p>
<p>Releases resulting in a new major or minor number are called main release.</p>
<p>Releases containing bugixes only, are only increasing the patch release number. Those releases don’t result in announcements on the <ahref="../basics/migration/">What’s new</a> page.</p>
<p>Entries on the <ahref="../basics/migration/">What’s new</a> page are checked and enforced during the <code>version-release</code> GitHub Action.</p>
<h2id="managing-issues">Managing Issues</h2>
<p>Issues are categorized and managed by assigning <ahref="#labels">labels</a> to it.</p>
<p>Once working on an issue, assign it to a fitting maintainer.</p>
<p>When done, close the ticket. Once an issue is closed, it needs to be assigned to next release milestone.</p>
<p>If the issue would cause a new main release due to <ahref="#semver">semver semantics</a> it needs one of the according labels and the matching badge on the <ahref="../basics/migration/">What’s new</a> page.</p>
<p>You can assign one further label out of the following list to signal readers that development on an open issue is currently halted for different reasons.</p>
<td>This is a topic related to Mermaid itself but not the theme</td>
</tr>
</tbody>
</table>
<h2id="making-releases">Making Releases</h2>
<p>A release is based on a milestone named like the release itself - just the version number, eg: <code>1.2.3</code>. It’s in the maintainers responsiblity to check <ahref="#semver">semver semantics</a> of the milestone’s name prior to release and change it if necessary.</p>
<p>Making releases is automated by the <code>version-release</code> GitHub Action. It requires the version number of the milestone that should be released. The release will be created from the <code>main</code> branch of the repository.</p>
<p>During execution of the action a few things are checked. If a check fails the action fails, resulting in no new release. You can correct the errors afterwards and rerun the action.</p>
<p>The following checks will be enforced</p>
<ul>
<li>the milestone exists</li>
<li>there is at least one closed issue assigned to the milestone</li>
<li>all assigned issues for this milestone are closed</li>
<li>the milestone is not previously released</li>
<li>if it’s a main release, there must be a new <code><major>.<minor></code> at the beginning of the <ahref="../basics/migration/">What’s new</a> page</li>
<li>if it’s a patch release, there must be the <code><major>.<minor></code> from the previous release at the beginning of the <ahref="../basics/migration/">What’s new</a> page</li>
</ul>
<p>After a successful run of the action</p>
<ul>
<li>the <ahref="https://mcshelby.github.io/hugo-theme-relearn/basics/history/index.html"target="_blank">History</a> page is updated</li>
<li>the <ahref="https://mcshelby.github.io/hugo-theme-relearn/basics/migration/index.html"target="_blank">What’s new</a> page is updated</li>
<li>the version number for the <code><meta generator></code> is updated</li>
<li>the updated files are commited</li>
<li>the milestone is closed</li>
<li>the repository is tagged with the version number</li>
<li>a new entry in the <ahref="https://github.com/McShelby/hugo-theme-relearn/releases"target="_blank">GitHub release list</a> with the according changelog will be created</li>
<li>the <ahref="https://mcshelby.github.io/hugo-theme-relearn/index.html"target="_blank">official documentation</a> is built and deployed</li>
<li>the version number for the <code><meta generator></code> is updated to a temporary and commited (this helps to determine if users are running directly on the main branch or are using releases)</li>
<li>a new milestone for the next patch release is created (this can later be renamed to a main release if necessary)</li>
<p>Show the <ahref="#demo-screenshot">Demo Screenshot</a> page on different devices and different themes. Composition of the different device screenshots into a template.</p>
<li>GitHub social media preview: <ahref="https://github.com/McShelby/hugo-theme-relearn/settings"target="_blank">https://github.com/McShelby/hugo-theme-relearn/settings</a><em>1280 x 640</em></li>
<li>From original template size resize to <em>2700 x 1800</em> centered, scale to <em>900 x 600</em> and save as <code>images/tn.png</code></li>
<li>From original template size resize to <em>3000 x 1500</em> offset y: <em>-330</em>, scale to <em>1280 x 640</em> and save as <code>images/hero.png</code></li>
