Skip to content

Commit

Permalink
Move NPM package support from main to v1 (#237)
Browse files Browse the repository at this point in the history
## Description

There is little JS code remaining in the `main` branch.
This PR makes it clear that there is no NPM package available for this
code (at least yet) and that maintenance work on the current package has
moved to the [`v1`
branch](#235 (comment)).
  • Loading branch information
fedgiac authored Dec 5, 2024
1 parent c15d99a commit 0bdf44c
Show file tree
Hide file tree
Showing 4 changed files with 3 additions and 82 deletions.
19 changes: 0 additions & 19 deletions .github/workflows/publish.yml

This file was deleted.

14 changes: 1 addition & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
> [!IMPORTANT]
> This repository is in the process of being migrated to the [Foundry](https://getfoundry.sh) Ethereum application development environment. Developers wishing to integrate and/or develop on the CoW Protocol smart contracts with hardhat should refer to tag [`v1.6.0`](https://github.com/cowprotocol/contracts/releases/tag/v1.6.0) [Browse files](https://github.com/cowprotocol/contracts/tree/1d673839a7402bdb2949175ebb61e8b5c4f39ecb).
> This repository is in the process of being migrated to the [Foundry](https://getfoundry.sh) Ethereum application development environment. Developers wishing to integrate and/or develop on the CoW Protocol smart contracts with hardhat should refer to branch [`v1`](https://github.com/cowprotocol/contracts/tree/v1).
# CoW Protocol

Expand Down Expand Up @@ -157,15 +157,3 @@ To actually execute the transaction:
```sh
forge script script/TransferOwnership.s.sol:TransferOwnership --rpc-url "$ETH_RPC_URL" --private-key 0x0000000000000000000000000000000000000000000000000000000000000001 --broadcast --slow
```

## 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.
3 changes: 2 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
{
"name": "@cowprotocol/contracts",
"version": "1.7.0",
"version": "2.0.0-alpha",
"license": "LGPL-3.0-or-later",
"private": true,
"repository": {
"type": "git",
"url": "https://github.com/cowprotocol/contracts.git"
Expand Down
49 changes: 0 additions & 49 deletions src/workflows/publish.sh

This file was deleted.

0 comments on commit 0bdf44c

Please sign in to comment.