# Sourcegraph release tool

This tool helps generates [Sourcegraph releases](../process/releases/index.md).
It is developed in [`dev/release`](https://sourcegraph.com/github.com/sourcegraph/sourcegraph/-/tree/dev/release).
To use it, check out the `sourcegraph/sourcegraph` repository and run:

```sh
yarn release help
```

## Prerequisite

This tool requires the following dependencies in your system `PATH`

- [node](https://github.com/nvm-sh/nvm)
- [yarn](https://classic.yarnpkg.com/en/docs/install#mac-stable)
- [comby](https://comby.dev)
- [gsed](https://formulae.brew.sh/formula/gnu-sed#default) (macOS only)
- [src-cli](https://github.com/sourcegraph/src-cli)
- [sg-cli](https://docs.sourcegraph.com/dev/setup/quickstart)
- [docker](https://www.docker.com/get-started)

If also requires the following information, you will be prompted to enter them by the release tool.

- [GitHub Personal Access Token with `repo` scope](https://github.com/settings/tokens)
- [Docker Hub Access Token](https://hub.docker.com/settings/security)
- [#prod-eng-announce Webhook Url](https://start.1password.com/open/i?a=HEDEDSLHPBFGRBTKAKJWE23XX4&v=dnrhbauihkhjs5ag6vszsme45a&i=pldpna5vivapxe4phewnqd42ji&h=team-sourcegraph.1password.com)


<section class="h0Wrapper headingWrapper"><section class="h1Wrapper headingWrapper"><h1 id="sourcegraph-release-tool"><a class="anchor" aria-hidden tabindex="-1" href="#sourcegraph-release-tool"><span class="icon icon-link"></span></a>Sourcegraph release tool</h1>
<p>This tool helps generates <a href="../../process/releases/">Sourcegraph releases</a>.
It is developed in <a href="https://sourcegraph.com/github.com/sourcegraph/sourcegraph/-/tree/dev/release"><code>dev/release</code></a>.
To use it, check out the <code>sourcegraph/sourcegraph</code> repository and run:</p>
<pre><code class="hljs language-sh">yarn release <span class="hljs-built_in">help</span>
</code></pre>
<section class="h2Wrapper headingWrapper"><h2 id="prerequisite"><a class="anchor" aria-hidden tabindex="-1" href="#prerequisite"><span class="icon icon-link"></span></a>Prerequisite</h2>
<p>This tool requires the following dependencies in your system <code>PATH</code></p>
<ul>
<li><a href="https://github.com/nvm-sh/nvm">node</a></li>
<li><a href="https://classic.yarnpkg.com/en/docs/install#mac-stable">yarn</a></li>
<li><a href="https://comby.dev">comby</a></li>
<li><a href="https://formulae.brew.sh/formula/gnu-sed#default">gsed</a> (macOS only)</li>
<li><a href="https://github.com/sourcegraph/src-cli">src-cli</a></li>
<li><a href="https://docs.sourcegraph.com/dev/setup/quickstart">sg-cli</a></li>
<li><a href="https://www.docker.com/get-started">docker</a></li>
</ul>
<p>If also requires the following information, you will be prompted to enter them by the release tool.</p>
<ul>
<li><a href="https://github.com/settings/tokens">GitHub Personal Access Token with <code>repo</code> scope</a></li>
<li><a href="https://hub.docker.com/settings/security">Docker Hub Access Token</a></li>
<li><a href="https://start.1password.com/open/i?a=HEDEDSLHPBFGRBTKAKJWE23XX4&#x26;v=dnrhbauihkhjs5ag6vszsme45a&#x26;i=pldpna5vivapxe4phewnqd42ji&#x26;h=team-sourcegraph.1password.com">#prod-eng-announce Webhook Url</a></li>
</ul></section></section></section>