Skip to content

Commit

Permalink
Remove /docs/ as its now in HH's repo
Browse files Browse the repository at this point in the history
  • Loading branch information
alcuadrado committed Oct 9, 2023
1 parent b645a64 commit 692794a
Show file tree
Hide file tree
Showing 16 changed files with 103 additions and 1,288 deletions.
103 changes: 96 additions & 7 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,12 +15,6 @@ There are two packages:
- [**core**](./packages/core/README.md) - containing the ignition library for orchestrating deployments
- [**hardhat-plugin**](./packages/hardhat-plugin/README.md) - containing the Hardhat plugin wrapper for the core library

## Design

An overview of the [design of the deploy process is explained here](./docs/design.md).

An outline of our plans for [distributable deployments is here](./docs/distributable-deployments.md)

## Setup

Ignition is a `typescript` project managed by `npm`.
Expand Down Expand Up @@ -71,4 +65,99 @@ npm run clean

## Publish

To publish the **Ignition** packages to npm follow the [publishing instructions](./docs/publish.md).
To publish ignition:

1. git fetch, Checkout out `development`, then ensure your branch is up to date `git pull --ff-only`
2. Perform a clean install and build (will lose all uncommitted changes) git clean -fdx ., npm install, npm run build
3. Run a full check, stopping on failure: `npm run fullcheck`
4. Confirm the commits represent the features for the release
5. Create a release branch `git checkout -b release/yyyy-mm-dd`
6. Update the `CHANGELOG.md` under `./packages/core`.
7. Update the `CHANGELOG.md` under `./packages/hardhat-plugin`.
8. Update the `CHANGELOG.md` under `./packages/ui`.
9. Update the package versions based on semver: `npm version --no-git-tag-version --workspaces patch #minor #major`
10. Update the version of dependencies:

- cores version in hardhat-ui deps
- cores and uis versions in hardhat-ignition devDeps and peerDeps
- examples version of hardhat-ignition

11. Commit the version update `git commit`:

```
chore: bump version to vX.X.X
Update the packages versions and changelogs for the `X.X.X -
yyyy-mm-dd` release.
```

12. Push the release branch and open a pull request on `main`, the PR description should match the changelogs
13. On a successful check, `rebase merge` the release branch into `main`
14. Switch to main branch and pull the latest changes
15. Git tag the version, `g tag -a v0.x.x -m "v0.x.x"` and push the tag `git push --follow-tags`
16. Publish `@nomicfoundation/ignition-core`, `@nomicfoundation/ignition-ui` and `@nomicfoundation/hardhat-ignition` : `npm publish -w @nomicfoundation/ignition-core -w @nomicfoundation/ignition-ui -w @nomicfoundation/hardhat-ignition`
17. Create a release on github off of the pushed tag

## Manual testing

> To knock off the rough edges
### Tests

---

#### **Try and deploy a module that doesn't exist**

---

##### <u>_Arrange_</u>

Setup ignition in a new hardhat project based on the getting started guide.

##### <u>_Act_</u>

Run a deploy with a module that doesn't exist

##### <u>_Assert_</u>

Check that a sensible error message is displayed

---

#### **Try and run a module with a validation error**

---

##### <u>_Arrange_</u>

Setup ignition in a new hardhat project based on the getting started guide.

Tweak the module so that it has a problem that will be caught by validation (ADD_MORE_DETAILS_HERE).

##### <u>_Act_</u>

Run a deploy with a invalid module

##### <u>_Assert_</u>

Check that a sensible error message is displayed

---

#### **Deploy to Sepolia testnet**

---

##### <u>_Arrange_</u>

Ensure you have an infura/alchemy RPC endpoint set up for Sepolia as well as an ETH address with Sepolia ETH that you don't mind pasting the privkey in plaintext for. I used metamask

Setup the network settings in the `hardhat.config.js` of the example you want to test

##### <u>_Act_</u>

Run a deploy/test from the example directory you set up

##### <u>_Assert_</u>

Check that deployment was successful, or results match expected (for instance, on-hold for multisig)
21 changes: 4 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,11 @@

# Hardhat Ignition

> **WARNING**: This repository is **highly experimental**, and is under **active development**. Any code or binaries produced from this project **should not be used in any production or critical workloads**. The API is preliminary, **the API will change**.
Hardhat Ignition is **Hardhat**'s deployment solution. It is a **Hardhat** plugin that allows you to create declarative deployments that can be reproduced across different networks.

Built by the [Nomic Foundation](https://nomic.foundation/) for the Ethereum community.

Join our [Hardhat Support Discord server](https://hardhat.org/discord) to stay up to date on new releases, plugins and tutorials.
Join our [Hardhat Support Discord server](https://hardhat.org/ignition-discord) to stay up to date on new releases, plugins and tutorials.

## Installation

Expand All @@ -30,22 +28,11 @@ import "@nomicfoundation/hardhat-ignition";

## Getting Started

See our [Getting started guide](./docs/getting-started-guide.md) for a worked example of **Hardhat Ignition usage**.
See our [Getting started guide](https://hardhat.org/hardhat-ignition/getting-started) for a worked example of **Hardhat Ignition usage**.

## Documentation

- [Getting started](./docs/getting-started-guide.md)
- [Explanation](./docs/explanation.md)
- [Creating Modules for Deployments](./docs/creating-modules-for-deployment.md)
- [Deploying a Contract](./docs/creating-modules-for-deployment.md#deploying-a-contract)
- [Calling contract methods](./docs/creating-modules-for-deployment.md#calling-contract-methods)
- [Network Accounts Management](./docs/creating-modules-for-deployment.md#network-accounts-management)
- [Including modules within modules](./docs/creating-modules-for-deployment.md#including-modules-within-modules)
- [Module Parameters](./docs/creating-modules-for-deployment.md#module-parameters)
- [Using Hardhat Ignition in _Hardhat_ tests](./docs/using-ignition-in-hardhat-tests.md)
- [Running a deployment](./docs/running-a-deployment.md)
- [Visualizing your deployment with the `visualize` task](./docs/running-a-deployment.md#visualizing-your-deployment-with-the-visualize-task)
- [Executing the deployment](./docs/running-a-deployment.md#executing-the-deployment)
To learn more about Hardhat Ignition, please visit [our website](https://hardhat.org/hardhat-ignition).

### Examples

Expand All @@ -63,6 +50,6 @@ Go to [CONTRIBUTING.md](./CONTRIBUTING.md) to learn about how to set up Hardhat

## Feedback, help and news

[Hardhat Support Discord server](https://hardhat.org/discord): for questions and feedback.
[Hardhat Support Discord server](https://hardhat.org/ignition-discord): for questions and feedback.

[Follow Hardhat on Twitter.](https://twitter.com/HardhatHQ)
39 changes: 0 additions & 39 deletions docs/configuration.md

This file was deleted.

Loading

0 comments on commit 692794a

Please sign in to comment.