mirror of
https://github.com/McShelby/hugo-theme-relearn.git
synced 2024-10-27 10:43:19 +00:00
313 lines
21 KiB
HTML
313 lines
21 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en" dir="ltr" itemscope itemtype="http://schema.org/Article">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta name="viewport" content="height=device-height, width=device-width, initial-scale=1.0, minimum-scale=1.0">
|
|
<meta name="generator" content="Hugo 0.134.2">
|
|
<meta name="generator" content="Relearn 6.3.0+tip">
|
|
<meta name="robots" content="noindex, nofollow, noarchive, noimageindex">
|
|
<meta name="description" content="What to know as a maintainer">
|
|
<meta name="author" content="Sören Weber">
|
|
<meta name="twitter:card" content="summary_large_image">
|
|
<meta name="twitter:image" content="https://mcshelby.github.io/hugo-theme-relearn/images/hero.png">
|
|
<meta name="twitter:title" content="Maintaining :: Hugo Relearn Theme">
|
|
<meta name="twitter:description" content="What to know as a maintainer">
|
|
<meta property="og:url" content="https://mcshelby.github.io/hugo-theme-relearn/dev/maintaining/index.html">
|
|
<meta property="og:site_name" content="Hugo Relearn Theme">
|
|
<meta property="og:title" content="Maintaining :: Hugo Relearn Theme">
|
|
<meta property="og:description" content="What to know as a maintainer">
|
|
<meta property="og:locale" content="en">
|
|
<meta property="og:type" content="website">
|
|
<meta property="og:image" content="https://mcshelby.github.io/hugo-theme-relearn/images/hero.png">
|
|
<meta itemprop="name" content="Maintaining :: Hugo Relearn Theme">
|
|
<meta itemprop="description" content="What to know as a maintainer">
|
|
<meta itemprop="wordCount" content="901">
|
|
<meta itemprop="image" content="https://mcshelby.github.io/hugo-theme-relearn/images/hero.png">
|
|
<title>Maintaining :: Hugo Relearn Theme</title>
|
|
<link href="https://mcshelby.github.io/hugo-theme-relearn/dev/maintaining/index.html" rel="alternate" hreflang="x-default">
|
|
<link href="https://mcshelby.github.io/hugo-theme-relearn/dev/maintaining/index.html" rel="alternate" hreflang="en">
|
|
<link href="https://mcshelby.github.io/hugo-theme-relearn/pir/dev/maintaining/index.html" rel="alternate" hreflang="art-x-pir">
|
|
<link href="/hugo-theme-relearn/images/logo.svg?1726146159" rel="icon" type="image/svg+xml">
|
|
<link href="/hugo-theme-relearn/css/fontawesome-all.min.css?1726146159" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="/hugo-theme-relearn/css/fontawesome-all.min.css?1726146159" rel="stylesheet"></noscript>
|
|
<link href="/hugo-theme-relearn/css/nucleus.css?1726146159" rel="stylesheet">
|
|
<link href="/hugo-theme-relearn/css/auto-complete.css?1726146159" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="/hugo-theme-relearn/css/auto-complete.css?1726146159" rel="stylesheet"></noscript>
|
|
<link href="/hugo-theme-relearn/css/perfect-scrollbar.min.css?1726146159" rel="stylesheet">
|
|
<link href="/hugo-theme-relearn/css/fonts.css?1726146159" rel="stylesheet" media="print" onload="this.media='all';this.onload=null;"><noscript><link href="/hugo-theme-relearn/css/fonts.css?1726146159" rel="stylesheet"></noscript>
|
|
<link href="/hugo-theme-relearn/css/theme.css?1726146159" rel="stylesheet">
|
|
<link href="/hugo-theme-relearn/css/theme-relearn-auto.css?1726146159" rel="stylesheet" id="R-variant-style">
|
|
<link href="/hugo-theme-relearn/css/chroma-relearn-auto.css?1726146159" rel="stylesheet" id="R-variant-chroma-style">
|
|
<link href="/hugo-theme-relearn/css/variant.css?1726146159" rel="stylesheet">
|
|
<link href="/hugo-theme-relearn/css/print.css?1726146159" rel="stylesheet" media="print">
|
|
<link href="/hugo-theme-relearn/css/format-print.css?1726146159" rel="stylesheet">
|
|
<script src="/hugo-theme-relearn/js/variant.js?1726146159"></script>
|
|
<script>
|
|
window.relearn = window.relearn || {};
|
|
window.relearn.relBasePath='..\/..';
|
|
window.relearn.relBaseUri='..\/..\/..';
|
|
window.relearn.absBaseUri='https:\/\/mcshelby.github.io\/hugo-theme-relearn';
|
|
window.relearn.disableAnchorCopy=false;
|
|
window.relearn.disableAnchorScrolling=false;
|
|
window.index_js_url="/hugo-theme-relearn/index.search.js?1726146159";
|
|
// variant stuff
|
|
window.variants && variants.init( [ 'relearn-auto', 'relearn-light', 'relearn-dark', 'relearn-bright', 'zen-auto', 'zen-light', 'zen-dark', 'retro-auto', 'neon', 'learn', 'blue', 'green', 'red' ] );
|
|
// translations
|
|
window.T_Copy_to_clipboard = `Copy to clipboard`;
|
|
window.T_Copied_to_clipboard = `Copied to clipboard!`;
|
|
window.T_Copy_link_to_clipboard = `Copy link to clipboard`;
|
|
window.T_Link_copied_to_clipboard = `Copied link to clipboard!`;
|
|
window.T_Reset_view = `Reset view`;
|
|
window.T_View_reset = `View reset!`;
|
|
window.T_No_results_found = `No results found for "{0}"`;
|
|
window.T_N_results_found = `{1} results found for "{0}"`;
|
|
</script>
|
|
<style>
|
|
#R-body img.bg-white {
|
|
background-color: white;
|
|
}
|
|
</style>
|
|
</head>
|
|
<body class="mobile-support print disableInlineCopyToClipboard" data-url="/hugo-theme-relearn/dev/maintaining/index.html">
|
|
<div id="R-body" class="default-animation">
|
|
<div id="R-body-overlay"></div>
|
|
<nav id="R-topbar">
|
|
<div class="topbar-wrapper">
|
|
<div class="topbar-sidebar-divider"></div>
|
|
<div class="topbar-area topbar-area-start" data-area="start">
|
|
<div class="topbar-button topbar-button-sidebar" data-content-empty="disable" data-width-s="show" data-width-m="hide" data-width-l="hide"><button class="topbar-control" onclick="toggleNav()" type="button" title="Menu (CTRL+ALT+n)"><i class="fa-fw fas fa-bars"></i></button>
|
|
</div>
|
|
</div>
|
|
<ol class="topbar-breadcrumbs breadcrumbs highlightable" itemscope itemtype="http://schema.org/BreadcrumbList"><li
|
|
itemscope itemtype="https://schema.org/ListItem" itemprop="itemListElement"><a itemprop="item" href="/hugo-theme-relearn/dev/index.html"><span itemprop="name">Development</span></a><meta itemprop="position" content="1"> > </li><li
|
|
itemscope itemtype="https://schema.org/ListItem" itemprop="itemListElement"><span itemprop="name">Maintaining</span><meta itemprop="position" content="2"></li>
|
|
</ol>
|
|
<div class="topbar-area topbar-area-end" data-area="end">
|
|
<div class="topbar-button topbar-button-prev" data-content-empty="disable" data-width-s="show" data-width-m="show" data-width-l="show"><a class="topbar-control" href="/hugo-theme-relearn/dev/contributing/index.html" title="Contributing (🡐)"><i class="fa-fw fas fa-chevron-left"></i></a>
|
|
</div>
|
|
<div class="topbar-button topbar-button-next" data-content-empty="disable" data-width-s="show" data-width-m="show" data-width-l="show"><a class="topbar-control" href="/hugo-theme-relearn/dev/screenshots/index.html" title="Screenshots (🡒)"><i class="fa-fw fas fa-chevron-right"></i></a>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</nav>
|
|
<div id="R-main-overlay"></div>
|
|
<main id="R-body-inner" class="highlightable default" tabindex="-1">
|
|
<div class="flex-block-wrapper">
|
|
<article class="default">
|
|
<header class="headline">
|
|
</header>
|
|
|
|
<h1 id="maintaining">Maintaining</h1>
|
|
|
|
<h2 id="semver">Semver</h2>
|
|
<p>This project tries to follow the <a href="https://semver.org/" rel="external" target="_self">semver policy</a> - although not followed 100% in the past.</p>
|
|
<p>Usually an entry of <span class="badge cstyle warning badge-with-title"><span class="badge-title"><i class="fa-fw fas fa-exclamation-triangle"></i></span><span class="badge-content">Breaking</span></span> on the <a href="/hugo-theme-relearn/basics/migration/index.html">What’s new</a> page causes a new major release number.</p>
|
|
<p>All other entries on the <a href="/hugo-theme-relearn/basics/migration/index.html">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 bugfixes only, are only increasing the patch release number. Those releases don’t result in announcements on the <a href="/hugo-theme-relearn/basics/migration/index.html">What’s new</a> page.</p>
|
|
<p>Entries on the <a href="/hugo-theme-relearn/basics/migration/index.html">What’s new</a> page are checked and enforced during the <code>version-release</code> GitHub Action.</p>
|
|
<h2 id="managing-issues">Managing Issues</h2>
|
|
<p>Issues are categorized and managed by assigning <a href="/hugo-theme-relearn/dev/maintaining/index.html#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>A once released ticket is not allowed to be reopened and rereleased in a different milestone. This would cause the changelog to be changed even for the milestone the issue was previously released in. Instead write a new ticket.</p>
|
|
<h2 id="managing-pull-requests">Managing Pull Requests</h2>
|
|
<p>If a PR is merged and closed it needs an accompanied issue assigned to. If there is no issue for a PR, the maintainer needs to create one.</p>
|
|
<p>You can assign multiple PRs to one issue as long as they belong together.</p>
|
|
<p>Usually set the same labels and milestone for the PR as for the accompanied issue.</p>
|
|
<h2 id="labels">Labels</h2>
|
|
<h3 id="kind">Kind</h3>
|
|
<p>An issue that results in changesets must have exactly one of the following labels. This needs to be assigned latest before release.</p>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th style="text-align: left">Label</th>
|
|
<th style="text-align: left">Description</th>
|
|
<th style="text-align: left">Changelog section</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td style="text-align: left"><span class="badge cstyle default"><span class="badge-content" style="background-color: #5498d8;">documentation</span></span></td>
|
|
<td style="text-align: left">Improvements or additions to documentation</td>
|
|
<td style="text-align: left">-</td>
|
|
</tr>
|
|
<tr>
|
|
<td style="text-align: left"><span class="badge cstyle default"><span class="badge-content" style="background-color: #99d856;">discussion</span></span></td>
|
|
<td style="text-align: left">This issue was converted to a discussion</td>
|
|
<td style="text-align: left">-</td>
|
|
</tr>
|
|
<tr>
|
|
<td style="text-align: left"><span class="badge cstyle default"><span class="badge-content" style="background-color: #d8d104;">task</span></span></td>
|
|
<td style="text-align: left">Maintenance work</td>
|
|
<td style="text-align: left">Maintenance</td>
|
|
</tr>
|
|
<tr>
|
|
<td style="text-align: left"><span class="badge cstyle default"><span class="badge-content" style="background-color: #d8ae04;">feature</span></span></td>
|
|
<td style="text-align: left">New feature or request</td>
|
|
<td style="text-align: left">Features</td>
|
|
</tr>
|
|
<tr>
|
|
<td style="text-align: left"><span class="badge cstyle default"><span class="badge-content" style="background-color: #d88704;">bug</span></span></td>
|
|
<td style="text-align: left">Something isn’t working</td>
|
|
<td style="text-align: left">Fixes</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="impact">Impact</h3>
|
|
<p>If the issue would cause a new main release due to <a href="/hugo-theme-relearn/dev/maintaining/index.html#semver">semver semantics</a> it needs one of the according labels and the matching badge on the <a href="/hugo-theme-relearn/basics/migration/index.html">What’s new</a> page.</p>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th style="text-align: left">Label</th>
|
|
<th style="text-align: left">Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td style="text-align: left"><span class="badge cstyle default"><span class="badge-content" style="background-color: #d73a4a;">change</span></span></td>
|
|
<td style="text-align: left">Introduces changes with existing installations</td>
|
|
</tr>
|
|
<tr>
|
|
<td style="text-align: left"><span class="badge cstyle default"><span class="badge-content" style="background-color: #d73a4a;">breaking</span></span></td>
|
|
<td style="text-align: left">Introduces breaking changes with existing installations</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="declination">Declination</h3>
|
|
<p>If an issue does not result in changesets but is closed anyways, it must have exactly one of the following labels.</p>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th style="text-align: left">Label</th>
|
|
<th style="text-align: left">Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td style="text-align: left"><span class="badge cstyle default"><span class="badge-content" style="background-color: #9fa2a5;">duplicate</span></span></td>
|
|
<td style="text-align: left">This issue or pull request already exists</td>
|
|
</tr>
|
|
<tr>
|
|
<td style="text-align: left"><span class="badge cstyle default"><span class="badge-content" style="background-color: #9fa2a5;">invalid</span></span></td>
|
|
<td style="text-align: left">This doesn’t seem right</td>
|
|
</tr>
|
|
<tr>
|
|
<td style="text-align: left"><span class="badge cstyle default"><span class="badge-content" style="background-color: #9fa2a5;">support</span></span></td>
|
|
<td style="text-align: left">Request for achieving a special goal</td>
|
|
</tr>
|
|
<tr>
|
|
<td style="text-align: left"><span class="badge cstyle default"><span class="badge-content" style="background-color: #9fa2a5;">unresolved</span></span></td>
|
|
<td style="text-align: left">No progress on this issue</td>
|
|
</tr>
|
|
<tr>
|
|
<td style="text-align: left"><span class="badge cstyle default"><span class="badge-content" style="background-color: #9fa2a5;">update</span></span></td>
|
|
<td style="text-align: left">A change in behavior after updat</td>
|
|
</tr>
|
|
<tr>
|
|
<td style="text-align: left"><span class="badge cstyle default"><span class="badge-content" style="background-color: #9fa2a5;">wontchange</span></span></td>
|
|
<td style="text-align: left">This will not be worked on</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="halt">Halt</h3>
|
|
<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>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th style="text-align: left">Label</th>
|
|
<th style="text-align: left">Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td style="text-align: left"><span class="badge cstyle default"><span class="badge-content" style="background-color: #998f6b;">blocked</span></span></td>
|
|
<td style="text-align: left">Depends on other issue to be fixed first</td>
|
|
</tr>
|
|
<tr>
|
|
<td style="text-align: left"><span class="badge cstyle default"><span class="badge-content" style="background-color: #998f6b;">idea</span></span></td>
|
|
<td style="text-align: left">A valuable idea that’s currently not worked on</td>
|
|
</tr>
|
|
<tr>
|
|
<td style="text-align: left"><span class="badge cstyle default"><span class="badge-content" style="background-color: #998f6b;">undecided</span></span></td>
|
|
<td style="text-align: left">No decision was made yet</td>
|
|
</tr>
|
|
<tr>
|
|
<td style="text-align: left"><span class="badge cstyle default"><span class="badge-content" style="background-color: #6426ff;">helpwanted</span></span></td>
|
|
<td style="text-align: left">Great idea, send in a PR</td>
|
|
</tr>
|
|
<tr>
|
|
<td style="text-align: left"><span class="badge cstyle default"><span class="badge-content" style="background-color: #6426ff;">needsfeedback</span></span></td>
|
|
<td style="text-align: left">Further information is needed</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="3rd-party">3rd-Party</h3>
|
|
<p>If the issue is not caused by a programming error in the themes own code, you can label the causing program or library.</p>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th style="text-align: left">Label</th>
|
|
<th style="text-align: left">Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td style="text-align: left"><span class="badge cstyle default"><span class="badge-content" style="background-color: #e550a7;">asciidoc</span></span></td>
|
|
<td style="text-align: left">This is a topic related to processing of AsciiDoc</td>
|
|
</tr>
|
|
<tr>
|
|
<td style="text-align: left"><span class="badge cstyle default"><span class="badge-content" style="background-color: #e550a7;">browser</span></span></td>
|
|
<td style="text-align: left">This is a topic related to the browser but not the theme</td>
|
|
</tr>
|
|
<tr>
|
|
<td style="text-align: left"><span class="badge cstyle default"><span class="badge-content" style="background-color: #e550a7;">device</span></span></td>
|
|
<td style="text-align: left">This is a topic related to a certain device</td>
|
|
</tr>
|
|
<tr>
|
|
<td style="text-align: left"><span class="badge cstyle default"><span class="badge-content" style="background-color: #e550a7;">hugo</span></span></td>
|
|
<td style="text-align: left">This is a topic related to Hugo itself but not the theme</td>
|
|
</tr>
|
|
<tr>
|
|
<td style="text-align: left"><span class="badge cstyle default"><span class="badge-content" style="background-color: #e550a7;">mermaid</span></span></td>
|
|
<td style="text-align: left">This is a topic related to Mermaid itself but not the theme</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h2 id="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 responsibility to check <a href="/hugo-theme-relearn/dev/maintaining/index.html#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>Treat released milestones as immutable. Don’t rerelease an already released milestone. An already released milestone may already been consumed by your users.</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>if it’s a main release, there must be a new <code><major>.<minor></code> at the beginning of the <a href="/hugo-theme-relearn/basics/migration/index.html">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 <a href="/hugo-theme-relearn/basics/migration/index.html">What’s new</a> page</li>
|
|
</ul>
|
|
<p>After a successful run of the action</p>
|
|
<ul>
|
|
<li>the <a href="https://mcshelby.github.io/hugo-theme-relearn/basics/history/index.html" rel="external" target="_self">History</a> page is updated, including release version, release date and text</li>
|
|
<li>the <a href="https://mcshelby.github.io/hugo-theme-relearn/basics/migration/index.html" rel="external" target="_self">What’s new</a> page is updated, including release version, release date and text</li>
|
|
<li>the version number for the <code><meta generator></code> is updated</li>
|
|
<li>the updated files are committed</li>
|
|
<li>the milestone is closed</li>
|
|
<li>the repository is tagged with the version number (eg. <code>1.2.3</code>), the main version number (eg. <code>1.2.x</code>) and the major version number (eg. <code>1.x</code>)</li>
|
|
<li>a new entry in the <a href="https://github.com/McShelby/hugo-theme-relearn/releases" rel="external" target="_self">GitHub release list</a> with the according changelog will be created</li>
|
|
<li>the <a href="https://mcshelby.github.io/hugo-theme-relearn/index.html" rel="external" target="_self">official documentation</a> is built and deployed</li>
|
|
<li>the version number for the <code><meta generator></code> is updated to a temporary and committed (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>
|
|
</ul>
|
|
|
|
<footer class="footline">
|
|
</footer>
|
|
</article>
|
|
|
|
</div>
|
|
</main>
|
|
</div>
|
|
<script src="/hugo-theme-relearn/js/clipboard.min.js?1726146159" defer></script>
|
|
<script src="/hugo-theme-relearn/js/perfect-scrollbar.min.js?1726146159" defer></script>
|
|
<script src="/hugo-theme-relearn/js/theme.js?1726146159" defer></script>
|
|
</body>
|
|
</html>
|