Skip to content

Commit

Permalink
add release instructions (#67)
Browse files Browse the repository at this point in the history
* add release instructions

* update toc
  • Loading branch information
shrimalmadhur committed Mar 4, 2024
1 parent 23809a3 commit f7e0cc1
Showing 1 changed file with 19 additions and 1 deletion.
20 changes: 19 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ EigenLayer CLI is used to manage core operator functionalities like local key ma
* [Install `eigenlayer` CLI using Go](#install-eigenlayer-cli-using-go)
* [Install `eigenlayer` CLI from source](#install-eigenlayer-cli-from-source)
* [Documentation](#documentation)
* [Release Process](#release-process)
<!-- TOC -->

## Supported Operating Systems
Expand Down Expand Up @@ -115,4 +116,21 @@ Links to specific sections are provided below.
* [Frequently Asked Questions](https://docs.eigenlayer.xyz/operator-guides/faq)
* [Troubleshooting](https://docs.eigenlayer.xyz/operator-guides/troubleshooting)

If you see any issues in documentation please create an issue or PR [here](https://github.com/Layr-Labs/eigenlayer-docs)
If you see any issues in documentation please create an issue or PR [here](https://github.com/Layr-Labs/eigenlayer-docs)

## Release Process
To release a new version of the CLI, follow the steps below:
> Note: You need to have write permission to this repo to release new version
1. Make sure the release version is updated [here](https://github.com/Layr-Labs/eigenlayer-cli/blob/master/cmd/eigenlayer/main.go#L26)
2. In your local clone, create a new release tag using the following command:```bash
```bash
git tag v<version> -m "Release v<version>"
```
3. Push the tag to the repository using the following command:
```bash
git push origin v<version>
```

4. This will automatically start the release process in the [GitHub Actions](https://github.com/Layr-Labs/eigenlayer-cli/actions/workflows/release.yml) and will create a draft release to the [GitHub Releases](https://github.com/Layr-Labs/eigenlayer-cli/releases) with all the required binaries and assets
5. Check the release notes and add any notable changes and publish the release

0 comments on commit f7e0cc1

Please sign in to comment.