Skip to content

Commit

Permalink
Deploying to gh-pages from @ 6918cec 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
github-merge-queue[bot] committed Nov 14, 2024
1 parent 6537d30 commit 13d9834
Show file tree
Hide file tree
Showing 10 changed files with 5 additions and 16 deletions.
19 changes: 4 additions & 15 deletions internal/releasing/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -80,18 +80,7 @@
})();
</script> </sl-sidebar-state-persist> <div class="md:sl-hidden"> <div class="mobile-preferences sl-flex astro-lmo4l3xt"> <div class="sl-flex social-icons astro-lmo4l3xt"> <a href="https://github.com/grafana/tanka" rel="me" class="sl-flex astro-hmffi5bi"><span class="sr-only astro-hmffi5bi">GitHub</span><svg aria-hidden="true" class="astro-hmffi5bi astro-zttjzyo7" width="16" height="16" viewBox="0 0 24 24" fill="currentColor" style="--sl-icon-size: 1em;"><path d="M12 .3a12 12 0 0 0-3.8 23.38c.6.12.83-.26.83-.57L9 21.07c-3.34.72-4.04-1.61-4.04-1.61-.55-1.39-1.34-1.76-1.34-1.76-1.08-.74.09-.73.09-.73 1.2.09 1.83 1.24 1.83 1.24 1.08 1.83 2.81 1.3 3.5 1 .1-.78.42-1.31.76-1.61-2.67-.3-5.47-1.33-5.47-5.93 0-1.31.47-2.38 1.24-3.22-.14-.3-.54-1.52.1-3.18 0 0 1-.32 3.3 1.23a11.5 11.5 0 0 1 6 0c2.28-1.55 3.29-1.23 3.29-1.23.64 1.66.24 2.88.12 3.18a4.65 4.65 0 0 1 1.23 3.22c0 4.61-2.8 5.63-5.48 5.92.42.36.81 1.1.81 2.22l-.01 3.29c0 .31.2.69.82.57A12 12 0 0 0 12 .3Z"/></svg> </a> </div> <starlight-theme-select> <label style="--sl-select-width: 6.25em" class="astro-bvhksiew"> <span class="sr-only astro-bvhksiew">Select theme</span> <svg aria-hidden="true" class="icon label-icon astro-bvhksiew astro-zttjzyo7" width="16" height="16" viewBox="0 0 24 24" fill="currentColor" style="--sl-icon-size: 1em;"><path d="M21 14h-1V7a3 3 0 0 0-3-3H7a3 3 0 0 0-3 3v7H3a1 1 0 0 0-1 1v2a3 3 0 0 0 3 3h14a3 3 0 0 0 3-3v-2a1 1 0 0 0-1-1ZM6 7a1 1 0 0 1 1-1h10a1 1 0 0 1 1 1v7H6V7Zm14 10a1 1 0 0 1-1 1H5a1 1 0 0 1-1-1v-1h16v1Z"/></svg> <select value="auto" class="astro-bvhksiew"> <option value="dark" class="astro-bvhksiew">Dark</option><option value="light" class="astro-bvhksiew">Light</option><option value="auto" selected class="astro-bvhksiew">Auto</option> </select> <svg aria-hidden="true" class="icon caret astro-bvhksiew astro-zttjzyo7" width="16" height="16" viewBox="0 0 24 24" fill="currentColor" style="--sl-icon-size: 1em;"><path d="M17 9.17a1 1 0 0 0-1.41 0L12 12.71 8.46 9.17a1 1 0 1 0-1.41 1.42l4.24 4.24a1.002 1.002 0 0 0 1.42 0L17 10.59a1.002 1.002 0 0 0 0-1.42Z"/></svg> </label> </starlight-theme-select> <script>
StarlightThemeProvider.updatePickers();
</script> </div> </div> </div> </div> </nav> <div class="main-frame astro-nioyl4k2"> <div class="lg:sl-flex astro-7cephahq"> <aside class="right-sidebar-container astro-7cephahq"> <div class="right-sidebar astro-7cephahq"> <div class="lg:sl-hidden astro-ys3q76p3"><mobile-starlight-toc data-min-h="2" data-max-h="3" class="astro-kasrnjty"><nav aria-labelledby="starlight__on-this-page--mobile" class="astro-kasrnjty"><details id="starlight__mobile-toc" class="astro-kasrnjty"><summary id="starlight__on-this-page--mobile" class="sl-flex astro-kasrnjty"><div class="toggle sl-flex astro-kasrnjty">On this page<svg aria-hidden="true" class="caret astro-kasrnjty astro-zttjzyo7" width="16" height="16" viewBox="0 0 24 24" fill="currentColor" style="--sl-icon-size: 1rem;"><path d="m14.83 11.29-4.24-4.24a1 1 0 1 0-1.42 1.41L12.71 12l-3.54 3.54a1 1 0 0 0 0 1.41 1 1 0 0 0 .71.29 1 1 0 0 0 .71-.29l4.24-4.24a1.002 1.002 0 0 0 0-1.42Z"/></svg> </div><span class="display-current astro-kasrnjty"></span></summary><div class="dropdown astro-kasrnjty"><ul class="isMobile astro-lbtmlupc" style="--depth: 0;"> <li class="astro-lbtmlupc" style="--depth: 0;"> <a href="./internal/releasing/#_top" class="astro-lbtmlupc" style="--depth: 0;"> <span class="astro-lbtmlupc" style="--depth: 0;">Overview</span> </a> </li><li class="astro-lbtmlupc" style="--depth: 0;"> <a href="./internal/releasing/#1-create-a-release-tag" class="astro-lbtmlupc" style="--depth: 0;"> <span class="astro-lbtmlupc" style="--depth: 0;">1. Create a release tag</span> </a> </li><li class="astro-lbtmlupc" style="--depth: 0;"> <a href="./internal/releasing/#2-add-changelog-to-the-release-notes" class="astro-lbtmlupc" style="--depth: 0;"> <span class="astro-lbtmlupc" style="--depth: 0;">2. Add changelog to the release notes</span> </a> </li><li class="astro-lbtmlupc" style="--depth: 0;"> <a href="./internal/releasing/#3-publish-the-release-notes" class="astro-lbtmlupc" style="--depth: 0;"> <span class="astro-lbtmlupc" style="--depth: 0;">3. Publish the release notes</span> </a> </li> </ul> </div></details></nav></mobile-starlight-toc></div><div class="right-sidebar-panel sl-hidden lg:sl-block astro-ys3q76p3"><div class="sl-container astro-ys3q76p3"><starlight-toc data-min-h="2" data-max-h="3"><nav aria-labelledby="starlight__on-this-page"><h2 id="starlight__on-this-page">On this page</h2><ul class="astro-lbtmlupc" style="--depth: 0;"> <li class="astro-lbtmlupc" style="--depth: 0;"> <a href="./internal/releasing/#_top" class="astro-lbtmlupc" style="--depth: 0;"> <span class="astro-lbtmlupc" style="--depth: 0;">Overview</span> </a> </li><li class="astro-lbtmlupc" style="--depth: 0;"> <a href="./internal/releasing/#1-create-a-release-tag" class="astro-lbtmlupc" style="--depth: 0;"> <span class="astro-lbtmlupc" style="--depth: 0;">1. Create a release tag</span> </a> </li><li class="astro-lbtmlupc" style="--depth: 0;"> <a href="./internal/releasing/#2-add-changelog-to-the-release-notes" class="astro-lbtmlupc" style="--depth: 0;"> <span class="astro-lbtmlupc" style="--depth: 0;">2. Add changelog to the release notes</span> </a> </li><li class="astro-lbtmlupc" style="--depth: 0;"> <a href="./internal/releasing/#3-publish-the-release-notes" class="astro-lbtmlupc" style="--depth: 0;"> <span class="astro-lbtmlupc" style="--depth: 0;">3. Publish the release notes</span> </a> </li> </ul> </nav></starlight-toc></div></div> </div> </aside> <div class="main-pane astro-7cephahq"> <main data-pagefind-body lang="en" dir="ltr" class="astro-ffkocmf6"> <div class="content-panel astro-azfihoyu"> <div class="sl-container astro-azfihoyu"> <h1 id="_top" class="astro-iauezotj">Releasing a new version</h1> </div> </div> <div class="content-panel astro-azfihoyu"> <div class="sl-container astro-azfihoyu"> <div class="sl-markdown-content"> <p>Releasing a new version of Tanka requires a couple of manual and automated steps.
This guide will give you a runbook on how to do them in the right order.</p>
<h2 id="1-create-a-release-tag">1. Create a release tag</h2>
<ol>
<li>Pull the latest changes from the <code dir="auto">main</code> branch to your local clone.</li>
<li>Create a new tag with the prefix <code dir="auto">v</code> (e.g. <code dir="auto">v0.28.0</code>).</li>
<li>Push that tag back to GitHub.</li>
</ol>
<p>This starts multiple GitHub workflows that will produce binaries, a Docker image, and also a new GitHub release that is <em>marked as draft</em>.</p>
<h2 id="2-add-changelog-to-the-release-notes">2. Add changelog to the release notes</h2>
<p>Once all these actions have finished, go to <a href="https://github.com/grafana/tanka/releases">https://github.com/grafana/tanka/releases</a> and you should see the new draft release.
Click the pencil icon (“edit”) at the top-right and go to the last line of the text body.
Now hit the “Generate release notes” button to add a changelog to the end of the release notes.</p>
<h2 id="3-publish-the-release-notes">3. Publish the release notes</h2>
<p>Once you’ve check that the release looks fine (e.g. no broken links, no missing version numbers in the download paths) click the “Publish release” button.</p> </div> <footer class="sl-flex astro-zm47gsy5"> <div class="meta sl-flex astro-zm47gsy5"> <a href="https://github.com/grafana/tanka/edit/main/docs/src/content/docs/internal/releasing.md" class="sl-flex astro-qsird7pd"><svg aria-hidden="true" class="astro-qsird7pd astro-zttjzyo7" width="16" height="16" viewBox="0 0 24 24" fill="currentColor" style="--sl-icon-size: 1.2em;"><path d="M22 7.24a1 1 0 0 0-.29-.71l-4.24-4.24a1 1 0 0 0-1.1-.22 1 1 0 0 0-.32.22l-2.83 2.83L2.29 16.05a1 1 0 0 0-.29.71V21a1 1 0 0 0 1 1h4.24a1 1 0 0 0 .76-.29l10.87-10.93L21.71 8c.1-.1.17-.2.22-.33a1 1 0 0 0 0-.24v-.14l.07-.05ZM6.83 20H4v-2.83l9.93-9.93 2.83 2.83L6.83 20ZM18.17 8.66l-2.83-2.83 1.42-1.41 2.82 2.82-1.41 1.42Z"/></svg> Edit page</a> </div> <div class="pagination-links astro-kq567jei" dir="ltr"> <a href="/known-issues/" rel="prev" class="astro-kq567jei"> <svg aria-hidden="true" class="astro-kq567jei astro-zttjzyo7" width="16" height="16" viewBox="0 0 24 24" fill="currentColor" style="--sl-icon-size: 1.5rem;"><path d="M17 11H9.41l3.3-3.29a1.004 1.004 0 1 0-1.42-1.42l-5 5a1 1 0 0 0-.21.33 1 1 0 0 0 0 .76 1 1 0 0 0 .21.33l5 5a1.002 1.002 0 0 0 1.639-.325 1 1 0 0 0-.219-1.095L9.41 13H17a1 1 0 0 0 0-2Z"/></svg> <span class="astro-kq567jei"> Previous <br class="astro-kq567jei"> <span class="link-title astro-kq567jei">Known issues</span> </span> </a> </div> </footer> </div> </div> </main> </div> </div> </div> </div> </body></html>
</script> </div> </div> </div> </div> </nav> <div class="main-frame astro-nioyl4k2"> <div class="lg:sl-flex astro-7cephahq"> <aside class="right-sidebar-container astro-7cephahq"> <div class="right-sidebar astro-7cephahq"> <div class="lg:sl-hidden astro-ys3q76p3"><mobile-starlight-toc data-min-h="2" data-max-h="3" class="astro-kasrnjty"><nav aria-labelledby="starlight__on-this-page--mobile" class="astro-kasrnjty"><details id="starlight__mobile-toc" class="astro-kasrnjty"><summary id="starlight__on-this-page--mobile" class="sl-flex astro-kasrnjty"><div class="toggle sl-flex astro-kasrnjty">On this page<svg aria-hidden="true" class="caret astro-kasrnjty astro-zttjzyo7" width="16" height="16" viewBox="0 0 24 24" fill="currentColor" style="--sl-icon-size: 1rem;"><path d="m14.83 11.29-4.24-4.24a1 1 0 1 0-1.42 1.41L12.71 12l-3.54 3.54a1 1 0 0 0 0 1.41 1 1 0 0 0 .71.29 1 1 0 0 0 .71-.29l4.24-4.24a1.002 1.002 0 0 0 0-1.42Z"/></svg> </div><span class="display-current astro-kasrnjty"></span></summary><div class="dropdown astro-kasrnjty"><ul class="isMobile astro-lbtmlupc" style="--depth: 0;"> <li class="astro-lbtmlupc" style="--depth: 0;"> <a href="./internal/releasing/#_top" class="astro-lbtmlupc" style="--depth: 0;"> <span class="astro-lbtmlupc" style="--depth: 0;">Overview</span> </a> </li> </ul> </div></details></nav></mobile-starlight-toc></div><div class="right-sidebar-panel sl-hidden lg:sl-block astro-ys3q76p3"><div class="sl-container astro-ys3q76p3"><starlight-toc data-min-h="2" data-max-h="3"><nav aria-labelledby="starlight__on-this-page"><h2 id="starlight__on-this-page">On this page</h2><ul class="astro-lbtmlupc" style="--depth: 0;"> <li class="astro-lbtmlupc" style="--depth: 0;"> <a href="./internal/releasing/#_top" class="astro-lbtmlupc" style="--depth: 0;"> <span class="astro-lbtmlupc" style="--depth: 0;">Overview</span> </a> </li> </ul> </nav></starlight-toc></div></div> </div> </aside> <div class="main-pane astro-7cephahq"> <main data-pagefind-body lang="en" dir="ltr" class="astro-ffkocmf6"> <div class="content-panel astro-azfihoyu"> <div class="sl-container astro-azfihoyu"> <h1 id="_top" class="astro-iauezotj">Releasing a new version</h1> </div> </div> <div class="content-panel astro-azfihoyu"> <div class="sl-container astro-azfihoyu"> <div class="sl-markdown-content"> <p>For releasing Tanka we’re using <a href="https://github.com/googleapis/release-please-action">release-please</a>.
This workflow manages a release pull-request based on the content of the <code dir="auto">main</code> branch that would update the changelog et al..
Once you want to do a release, merge that prepared pull-request.
release-please will then do all the tagging and GitHub Release creation.</p> </div> <footer class="sl-flex astro-zm47gsy5"> <div class="meta sl-flex astro-zm47gsy5"> <a href="https://github.com/grafana/tanka/edit/main/docs/src/content/docs/internal/releasing.md" class="sl-flex astro-qsird7pd"><svg aria-hidden="true" class="astro-qsird7pd astro-zttjzyo7" width="16" height="16" viewBox="0 0 24 24" fill="currentColor" style="--sl-icon-size: 1.2em;"><path d="M22 7.24a1 1 0 0 0-.29-.71l-4.24-4.24a1 1 0 0 0-1.1-.22 1 1 0 0 0-.32.22l-2.83 2.83L2.29 16.05a1 1 0 0 0-.29.71V21a1 1 0 0 0 1 1h4.24a1 1 0 0 0 .76-.29l10.87-10.93L21.71 8c.1-.1.17-.2.22-.33a1 1 0 0 0 0-.24v-.14l.07-.05ZM6.83 20H4v-2.83l9.93-9.93 2.83 2.83L6.83 20ZM18.17 8.66l-2.83-2.83 1.42-1.41 2.82 2.82-1.41 1.42Z"/></svg> Edit page</a> </div> <div class="pagination-links astro-kq567jei" dir="ltr"> <a href="/known-issues/" rel="prev" class="astro-kq567jei"> <svg aria-hidden="true" class="astro-kq567jei astro-zttjzyo7" width="16" height="16" viewBox="0 0 24 24" fill="currentColor" style="--sl-icon-size: 1.5rem;"><path d="M17 11H9.41l3.3-3.29a1.004 1.004 0 1 0-1.42-1.42l-5 5a1 1 0 0 0-.21.33 1 1 0 0 0 0 .76 1 1 0 0 0 .21.33l5 5a1.002 1.002 0 0 0 1.639-.325 1 1 0 0 0-.219-1.095L9.41 13H17a1 1 0 0 0 0-2Z"/></svg> <span class="astro-kq567jei"> Previous <br class="astro-kq567jei"> <span class="link-title astro-kq567jei">Known issues</span> </span> </a> </div> </footer> </div> </div> </main> </div> </div> </div> </div> </body></html>
Binary file removed pagefind/fragment/en_7098b8a.pf_fragment
Binary file not shown.
Binary file added pagefind/fragment/en_efadd41.pf_fragment
Binary file not shown.
Binary file removed pagefind/index/en_1491343.pf_index
Binary file not shown.
Binary file removed pagefind/index/en_cf22872.pf_index
Binary file not shown.
Binary file added pagefind/index/en_d250a38.pf_index
Binary file not shown.
Binary file added pagefind/index/en_ff60f6c.pf_index
Binary file not shown.
2 changes: 1 addition & 1 deletion pagefind/pagefind-entry.json
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"version":"1.2.0","languages":{"en":{"hash":"en_7ae3b6826b","wasm":"en","page_count":33}}}
{"version":"1.2.0","languages":{"en":{"hash":"en_c710438429","wasm":"en","page_count":33}}}
Binary file removed pagefind/pagefind.en_7ae3b6826b.pf_meta
Binary file not shown.
Binary file added pagefind/pagefind.en_c710438429.pf_meta
Binary file not shown.

0 comments on commit 13d9834

Please sign in to comment.