chore: Add coverage badge on all packages pages

across-protocol · Oct 21, 2022 · 0d43190 · 0d43190
1 parent 9b90c73
commit 0d43190
Show file tree

Hide file tree

Showing 12 changed files with 27 additions and 10 deletions.
diff --git a/packages/actor-tests/README.md b/packages/actor-tests/README.md
@@ -1,5 +1,7 @@
 # Actor Tests
 
+[![codecov](https://codecov.io/gh/ethereum-optimism/optimism/branch/develop/graph/badge.svg?token=0VTG7PG7YR&flag=actor-tests-tests)](https://codecov.io/gh/ethereum-optimism/optimism)
+
 This README describes how to use the actor testing library to write new tests. If you're just looking for how to run test cases, check out the README [in the root of the repo](../README.md).
 
 ## Introduction
@@ -122,15 +124,15 @@ It's useful to use `expect`/`assert` to make sure that actors are executing prop
 
 ### Test Runner
 
-The test runner is responsible for executing actor tests and managing their lifecycle. It can run in one of two modes: 
+The test runner is responsible for executing actor tests and managing their lifecycle. It can run in one of two modes:
 
 1. Fixed run mode, which will execute the `run` method a fixed number of times.
 2. Timed mode, which will will execute the `run` method as many times as possible until a period of time has elapsed.
 
 Test lifecycle is as follows:
 
 1. The runner collects all the actors it needs to run.
-	
+
 	> Actors automatically register themselves with the default instance of the runner upon being `require()`d.
 2. The runner executes each actor's `setupActor` method.
 3. The runner spawns `n` workers.

diff --git a/packages/common-ts/README.md b/packages/common-ts/README.md
@@ -1,5 +1,7 @@
 # @eth-optimism/common-ts
 
+[![codecov](https://codecov.io/gh/ethereum-optimism/optimism/branch/develop/graph/badge.svg?token=0VTG7PG7YR&flag=common-ts-tests)](https://codecov.io/gh/ethereum-optimism/optimism)
+
 ## What is this?
 
 `@eth-optimism/common-ts` contains useful tools for logging, metrics, and other Node stuff.

diff --git a/packages/contracts-governance/README.md b/packages/contracts-governance/README.md
@@ -4,6 +4,8 @@
   <h1> Optimism Governance Contracts</h1>
 </div>
 
+[![codecov](https://codecov.io/gh/ethereum-optimism/optimism/branch/develop/graph/badge.svg?token=0VTG7PG7YR&flag=contracts-governance-tests)](https://codecov.io/gh/ethereum-optimism/optimism)
+
 ## TL;DR
 
 The token and governance smart contracts for the Optimism DAO. Built using [OpenZeppelin libraries](https://docs.openzeppelin.com/contracts/4.x/) with some customisations. The token is an [ERC20](https://docs.openzeppelin.com/contracts/4.x/api/token/erc20) that is [permissible](https://docs.openzeppelin.com/contracts/4.x/api/token/erc20#ERC20Permit) and allows for [delegate voting](https://docs.openzeppelin.com/contracts/4.x/api/token/erc20#ERC20Votes). The token is also [burnable](https://docs.openzeppelin.com/contracts/4.x/api/token/erc20#ERC20Burnable). See more in the [Specification section](#specification).
@@ -106,4 +108,4 @@ The contract is also upgradable to allow changes in the inflation schedule.
 
 ### Governance (DAO) Contracts
 
-(WIP)
+(WIP)
diff --git a/packages/contracts-periphery/README.md b/packages/contracts-periphery/README.md
@@ -1 +1,3 @@
 # Optimism Peripheral Smart Contracts
+
+[![codecov](https://codecov.io/gh/ethereum-optimism/optimism/branch/develop/graph/badge.svg?token=0VTG7PG7YR&flag=contracts-periphery-tests)](https://codecov.io/gh/ethereum-optimism/optimism)
diff --git a/packages/contracts/README.md b/packages/contracts/README.md
@@ -1,7 +1,7 @@
-[![codecov](https://codecov.io/gh/ethereum-optimism/optimism/branch/master/graph/badge.svg?token=0VTG7PG7YR&flag=contracts)](https://codecov.io/gh/ethereum-optimism/optimism)
-
 # Optimism Smart Contracts
 
+[![codecov](https://codecov.io/gh/ethereum-optimism/optimism/branch/master/graph/badge.svg?token=0VTG7PG7YR&flag=contracts-tests)](https://codecov.io/gh/ethereum-optimism/optimism)
+
 `@eth-optimism/contracts` contains the various Solidity smart contracts used within the Optimism system.
 Some of these contracts are [meant to be deployed to Ethereum ("Layer 1")](https://github.com/ethereum-optimism/optimism/tree/develop/packages/contracts/contracts/L1), while others are [meant to be deployed to Optimism ("Layer 2")](https://github.com/ethereum-optimism/optimism/tree/develop/packages/contracts/contracts/L2).
 Within each contract file you'll find the network upon which the contract is meant to be deloyed, listed as either `EVM` (for Ethereum) or `OVM` (for Optimism).

diff --git a/packages/core-utils/README.md b/packages/core-utils/README.md
@@ -1,7 +1,7 @@
-[![codecov](https://codecov.io/gh/ethereum-optimism/optimism/branch/master/graph/badge.svg?token=0VTG7PG7YR&flag=core-utils)](https://codecov.io/gh/ethereum-optimism/optimism)
-
 # @eth-optimism/core-utils
 
+[![codecov](https://codecov.io/gh/ethereum-optimism/optimism/branch/develop/graph/badge.svg?token=0VTG7PG7YR&flag=core-utils-tests)](https://codecov.io/gh/ethereum-optimism/optimism)
+
 ## What is this?
 
 `@eth-optimism/core-utils` contains the Optimistic Virtual Machine core utilities.

diff --git a/packages/data-transport-layer/README.md b/packages/data-transport-layer/README.md
@@ -1,7 +1,7 @@
-[![codecov](https://codecov.io/gh/ethereum-optimism/optimism/branch/master/graph/badge.svg?token=0VTG7PG7YR&flag=data-transport-layer)](https://codecov.io/gh/ethereum-optimism/optimism)
-
 # @eth-optimism/data-transport-layer
 
+[![codecov](https://codecov.io/gh/ethereum-optimism/optimism/branch/develop/graph/badge.svg?token=0VTG7PG7YR&flag=dtl-tests)](https://codecov.io/gh/ethereum-optimism/optimism)
+
 ## What is this?
 
 The Optimism Data Transport Layer is a long-running software service (written in TypeScript) designed to reliably index Optimism transaction data from Layer 1 (Ethereum). Specifically, this service indexes:

diff --git a/packages/drippie-mon/README.md b/packages/drippie-mon/README.md
@@ -1,5 +1,7 @@
 # @eth-optimism/drippie-mon
 
+[![codecov](https://codecov.io/gh/ethereum-optimism/optimism/branch/develop/graph/badge.svg?token=0VTG7PG7YR&flag=drippie-mon-tests)](https://codecov.io/gh/ethereum-optimism/optimism)
+
 `drippie-mon` is a simple service for monitoring Drippie contracts.
 
 ## Installation

diff --git a/packages/fault-detector/README.md b/packages/fault-detector/README.md
@@ -1,5 +1,7 @@
 # @eth-optimism/fault-detector
 
+[![codecov](https://codecov.io/gh/ethereum-optimism/optimism/branch/develop/graph/badge.svg?token=0VTG7PG7YR&flag=fault-detector-tests)](https://codecov.io/gh/ethereum-optimism/optimism)
+
 The `fault-detector` is a simple service for detecting discrepancies between your local view of the Optimism network and the L2 output proposals published to Ethereum.
 
 ## Installation

diff --git a/packages/message-relayer/README.md b/packages/message-relayer/README.md
@@ -1,5 +1,7 @@
 # @eth-optimism/message-relayer
 
+[![codecov](https://codecov.io/gh/ethereum-optimism/optimism/branch/develop/graph/badge.svg?token=0VTG7PG7YR&flag=message-relayer-tests)](https://codecov.io/gh/ethereum-optimism/optimism)
+
 `message-relayer` is a service that automatically finalizes ("relays") messages sent from Optimism to Ethereum.
 This package is meant to be used during local development and should NOT be used on a production network.
 

diff --git a/packages/replica-healthcheck/README.md b/packages/replica-healthcheck/README.md
@@ -1,5 +1,7 @@
 # @eth-optimism/replica-healthcheck
 
+[![codecov](https://codecov.io/gh/ethereum-optimism/optimism/branch/develop/graph/badge.svg?token=0VTG7PG7YR&flag=replica-healthcheck-tests)](https://codecov.io/gh/ethereum-optimism/optimism)
+
 ## What is this?
 
 `replica-healthcheck` is an express server to be run alongside a replica instance, to ensure that the replica is healthy. Currently, it exposes metrics on syncing stats and exits when the replica has a mismatched state root against the sequencer.

diff --git a/packages/sdk/README.md b/packages/sdk/README.md
@@ -1,7 +1,8 @@
-[![codecov](https://codecov.io/gh/ethereum-optimism/optimism/branch/master/graph/badge.svg?token=0VTG7PG7YR&flag=sdk)](https://codecov.io/gh/ethereum-optimism/optimism)
 
 # @eth-optimism/sdk
 
+[![codecov](https://codecov.io/gh/ethereum-optimism/optimism/branch/master/graph/badge.svg?token=0VTG7PG7YR&flag=sdk-tests)](https://codecov.io/gh/ethereum-optimism/optimism)
+
 The `@eth-optimism/sdk` package provides a set of tools for interacting with Optimism.
 
 ## Installation
Original file line number	Diff line number	Diff line change
		@@ -1 +1,3 @@
		# Optimism Peripheral Smart Contracts

		[![codecov](https://codecov.io/gh/ethereum-optimism/optimism/branch/develop/graph/badge.svg?token=0VTG7PG7YR&flag=contracts-periphery-tests)](https://codecov.io/gh/ethereum-optimism/optimism)