Skip to content

Commit

Permalink
Update readme release/deploy instruction (#70)
Browse files Browse the repository at this point in the history
Our release/deploy process isn't documented correctly in the readme.

The automated contract deployment procedure is outdated, has never been
used and we don't want to use it in the future as it requires us to
store funds in a dedicated secret key just for the purpose of deploying.
All related text/code has been removed.

The NPM release process wasn't documented. Documentation has been added.

### Test Plan

We tested the NPM release process recently with v1.5.0. You can see the
related workflow run
[here](https://github.com/cowprotocol/contracts/actions/runs/7384026272).
  • Loading branch information
fedgiac authored Jan 2, 2024
1 parent 4f7959f commit aaffdc5
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 96 deletions.
33 changes: 0 additions & 33 deletions .github/workflows/deploy.yml

This file was deleted.

18 changes: 12 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,12 +57,6 @@ yarn bench:trace

## Deployment

Contracts deployment (including contract verification) is run automatically with GitHub Actions. The deployment process is triggered manually.
Maintainers of this repository can deploy a new version of the contract in the "Actions" tab, "Deploy CoW Protocol contracts", "Run workflow". The target branch can be selected before running.
A successful workflow results in a new PR asking to merge the deployment artifacts into the main branch.

Contracts can also be deployed and verified manually as follows.

### Deploying Contracts

Choose the network and gas price in wei for the deployment.
Expand Down Expand Up @@ -196,3 +190,15 @@ npx hardhat decode --txhash 0xc12e5bc2ef9c116932301495738d555ea1d658977dacd6c798
```

Note that you will be expected to have your `INFURA_KEY` exported to your environment variables.

## Releases

The content of this repo is published on NPM as [`@cowprotocol/contracts`](https://www.npmjs.com/package/@cowprotocol/contracts).

Maintainers this repository can manually trigger a new release. The steps are as follows:

1. Update the package version number in `./package.json` on branch `main`.

2. On GitHub, visit the "Actions" tab, "Publish package to NPM", "Run workflow" with `main` as the target branch.

Once the workflow has been executed successfully, a new NPM package version should be available as well as a new git tag named after the released version.
57 changes: 0 additions & 57 deletions src/workflows/deploy.sh

This file was deleted.

0 comments on commit aaffdc5

Please sign in to comment.