Skip to content

Commit

Permalink
docs: Document manual release of select packages to CHaP (#4878) Ever…
Browse files Browse the repository at this point in the history
…ything is in the title: A small PR adding some documentation about #4411 Source commit: 3e617b9
  • Loading branch information
Cardano Wallet Documentation Bot committed Dec 11, 2024
1 parent 3236d18 commit f374793
Show file tree
Hide file tree
Showing 4 changed files with 34 additions and 2 deletions.
16 changes: 16 additions & 0 deletions contributor/how/release-process.html
Original file line number Diff line number Diff line change
Expand Up @@ -181,6 +181,22 @@ <h1 id="release-process"><a class="header" href="#release-process">Release Proce
<li>Create new page on cardano-wallet's <a href="https://github.com/cardano-foundation/cardano-wallet/wiki/_new">wiki</a> called <code>Release vYYYY-MM-DD</code> by copying contents of the previous releas.</li>
<li>Follow the <code>Release checklist</code>. Update progress or report obstacles on the thread.</li>
</ul>
<h2 id="releasing-packages-to-chap"><a class="header" href="#releasing-packages-to-chap">Releasing packages to CHaP</a></h2>
<p><a href="https://github.com/IntersectMBO/cardano-haskell-packages">CHaP</a> or the <em>Cardano Haskell Packages</em> repository is useful to publish <em>Haskell</em> packages relevant to the Cardano ecosystem as this allows standard build tools like <code>Cabal</code> to work out-of-the-box with only some configuration to point to the repository in addition to https://hackage.haskell.org</p>
<p>To publish packages on CHaP:</p>
<ol>
<li>
<p>Clone the repository locally from https://github.com/cardano-foundation/cardano-haskell-packages/</p>
</li>
<li>
<p>Run script to create relevant commits, for example to release <code>cardano-coin-selection</code> package and its (local) dependencies:</p>
<pre><code>$ scripts/add-from-github.sh https://github.com/cardano-foundation/cardano-wallet 9eb5f59c328163ca061a20f47519686b6f118d74 lib/coin-selection lib/primitive lib/test-utils lib/delta-types lib/crypto-primitives lib/launcher lib/numeric lib/text-class
</code></pre>
</li>
<li>
<p>Open a Pull Request on upstream repository (ie. https://github.com/IntersectMBO/cardano-haskell-packages/)</p>
</li>
</ol>

</main>

Expand Down
16 changes: 16 additions & 0 deletions print.html
Original file line number Diff line number Diff line change
Expand Up @@ -6309,6 +6309,22 @@ <h2 id="qa-schedule"><a class="header" href="#qa-schedule">QA Schedule</a></h2>
<li>Create new page on cardano-wallet's <a href="https://github.com/cardano-foundation/cardano-wallet/wiki/_new">wiki</a> called <code>Release vYYYY-MM-DD</code> by copying contents of the previous releas.</li>
<li>Follow the <code>Release checklist</code>. Update progress or report obstacles on the thread.</li>
</ul>
<h2 id="releasing-packages-to-chap"><a class="header" href="#releasing-packages-to-chap">Releasing packages to CHaP</a></h2>
<p><a href="https://github.com/IntersectMBO/cardano-haskell-packages">CHaP</a> or the <em>Cardano Haskell Packages</em> repository is useful to publish <em>Haskell</em> packages relevant to the Cardano ecosystem as this allows standard build tools like <code>Cabal</code> to work out-of-the-box with only some configuration to point to the repository in addition to https://hackage.haskell.org</p>
<p>To publish packages on CHaP:</p>
<ol>
<li>
<p>Clone the repository locally from https://github.com/cardano-foundation/cardano-haskell-packages/</p>
</li>
<li>
<p>Run script to create relevant commits, for example to release <code>cardano-coin-selection</code> package and its (local) dependencies:</p>
<pre><code>$ scripts/add-from-github.sh https://github.com/cardano-foundation/cardano-wallet 9eb5f59c328163ca061a20f47519686b6f118d74 lib/coin-selection lib/primitive lib/test-utils lib/delta-types lib/crypto-primitives lib/launcher lib/numeric lib/text-class
</code></pre>
</li>
<li>
<p>Open a Pull Request on upstream repository (ie. https://github.com/IntersectMBO/cardano-haskell-packages/)</p>
</li>
</ol>
<div style="break-before: page; page-break-before: always;"></div><h1 id="release-checklist"><a class="header" href="#release-checklist">Release checklist</a></h1>
<div style="break-before: page; page-break-before: always;"></div><h1 id="code-review-guidelines"><a class="header" href="#code-review-guidelines">Code Review Guidelines</a></h1>
<h2 id="table-of-content"><a class="header" href="#table-of-content">Table of Content</a></h2>
Expand Down
2 changes: 1 addition & 1 deletion searchindex.js

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion searchindex.json

Large diffs are not rendered by default.

0 comments on commit f374793

Please sign in to comment.