Setup CGP validation CI script (#414)

* Setup yarn and create validation script * Fix errors with current CGPs * Define github CI workflow * Use stricter date-string validation * Fix date validity checking
celo-org · Mar 17, 2024 · fe48079 · fe48079
1 parent 3359910
commit fe48079
Show file tree

Hide file tree

Showing 25 changed files with 1,512 additions and 42 deletions.
diff --git a/.editorconfig b/.editorconfig
@@ -0,0 +1,10 @@
+root = true
+
+[*]
+end_of_line = lf
+insert_final_newline = true
+
+[*.{js,json,yml}]
+charset = utf-8
+indent_style = space
+indent_size = 2
diff --git a/.gitattributes b/.gitattributes
@@ -0,0 +1,4 @@
+/.yarn/**            linguist-vendored
+/.yarn/releases/*    binary
+/.yarn/plugins/**/*  binary
+/.pnp.*              binary linguist-generated
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -0,0 +1,50 @@
+name: ci
+
+on:
+  # Triggers the workflow on push or pull request events but only for the main branch
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+jobs:
+  install:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/cache@v3
+        with:
+          path: |
+            **/node_modules
+            .yarn/cache
+          key: ${{ runner.os }}-yarn-cache-${{ hashFiles('./yarn.lock') }}
+
+      - name: yarn-install
+        # Check out the lockfile from main, reinstall, and then
+        # verify the lockfile matches what was committed.
+        run: |
+            yarn install --immutable
+            CHANGES=$(git status -s)
+            if [[ ! -z $CHANGES ]]; then
+              echo "Changes found: $CHANGES"
+              git diff
+              exit 1
+            fi
+
+  validate:
+    runs-on: ubuntu-latest
+    needs: [install]
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/cache@v3
+        with:
+          path: |
+            **/node_modules
+            .yarn/cache
+          key: ${{ runner.os }}-yarn-cache-${{ hashFiles('./yarn.lock') }}
+
+      - name: cgp-validation
+        run: yarn run validate 
diff --git a/.gitignore b/.gitignore
@@ -1,2 +1,10 @@
+# dependencies
+/node_modules
+/.pnp
+.pnp.js
+cache/
+.yarn/install-state.gz
 
+# misc
 .DS_Store
+*.pem
diff --git a/.yarn/releases/yarn-4.1.1.cjs b/.yarn/releases/yarn-4.1.1.cjs
diff --git a/.yarnrc.yml b/.yarnrc.yml
@@ -0,0 +1,5 @@
+compressionLevel: mixed
+enableGlobalCache: false
+enableScripts: false
+nodeLinker: node-modules
+yarnPath: .yarn/releases/yarn-4.1.1.cjs
diff --git a/CGPs/cgp-0045.md b/CGPs/cgp-0045.md
@@ -1,7 +1,7 @@
 ---
 cgp: 45
 title: cREAL Activation
-date-created: 13-10-2021
+date-created: 2021-10-13
 author: '@luisgj (Bitso), @martinvol (cLabs)'
 status: EXECUTED
 governance-proposal-id: 50
@@ -13,15 +13,15 @@ discussions-to: https://forum.celo.org/t/cbrl-stable-asset/1281
 
 CGP 45 - cREAL Activation
 
-This proposal is the third and final governance proposal needed launch cREAL. It was preceeded by [CGP-42](https://github.com/celo-org/governance/blob/main/CGPs/cgp-0042.md) and [CGP-46](https://github.com/celo-org/governance/blob/main/CGPs/cgp-0046.md).
+This proposal is the third and final governance proposal needed launch cREAL. It was preceded by [CGP-42](https://github.com/celo-org/governance/blob/main/CGPs/cgp-0042.md) and [CGP-46](https://github.com/celo-org/governance/blob/main/CGPs/cgp-0046.md).
 
 
 ### Status
 
 This proposal should not be executed until at least one oracle report for cREAL has been submitted on-chain. At this point, cREAL should already be deployed and initialized, but frozen and un-usable.
 
 
-Please note `cREAL` was formelly called `cBRL`.
+Please note `cREAL` was formerly called `cBRL`.
 
 ## Proposed Changes
 

diff --git a/CGPs/cgp-0057.md b/CGPs/cgp-0057.md
@@ -6,7 +6,7 @@ author: 'Martin Volpe (@martinvol, volpe@clabs.co)'
 status: EXECUTED
 discussions-to: https://forum.celo.org/t/decentralized-oracles/3610
 governance-proposal-id: 69
-date-executed: 2022-9-11
+date-executed: 2022-09-11
 ---
 ## Overview
 

diff --git a/CGPs/cgp-0060.md b/CGPs/cgp-0060.md
@@ -5,8 +5,8 @@ date-created: 2022-08-02
 author: 'Juan (@juancamp1987#4903)'
 status: DRAFT 
 discussions-to: https://forum.celo.org/t/proposal-to-introduce-colombian-peso-ccop-stable-coin/3200/15
-governance-proposal-id: TBD
-date-executed: TBD
+governance-proposal-id:
+date-executed:
 ---
 
 ## Overview

diff --git a/CGPs/cgp-0073.md b/CGPs/cgp-0073.md
@@ -1,7 +1,7 @@
 ---
 cgp: 73
 title: Establish and Fund Bug Bounty Program on Immunefi
-date-created: 2023-3-5
+date-created: 2023-03-05
 author: '@vissequ, @keccakdog'
 status: DRAFT
 discussions-to: https://forum.celo.org/t/proposal-establish-and-fund-a-bug-bounty-program-for-celo-on-immunefi/5060

diff --git a/CGPs/cgp-0117.md b/CGPs/cgp-0117.md
@@ -3,10 +3,10 @@ cgp: 117
 title: Celo Core Contracts Release 11
 date-created: 2024-02-22
 author: "Martin Volpe (@martinvol), Pavel Hornak (@pahor167)"
-status: Proposed
+status: PROPOSED
 discussions-to: https://forum.celo.org/t/core-contracts-release-11/
 governance-proposal-id: 159
-date-executed: TBD
+date-executed:
 ---
 
 ## Overview

diff --git a/CGPs/cgp-0118.md b/CGPs/cgp-0118.md
@@ -3,11 +3,10 @@ cgp: 118
 title: Minting 10m cUSD from Mento Reserve in six tranches
 date-created: 2024-02-23
 author: 'LuukDAO (@LuukDAO)'
-status: PROPOSED
 discussions-to: https://forum.celo.org/t/minting-10m-cusd-from-mento-reserve-in-six-tranches/7458/1
-status: DRAFT 
-governance-proposal-id: TBA
-date-executed: TBA
+status: DRAFT
+governance-proposal-id:
+date-executed:
 ---
 
 ## Background

diff --git a/CGPs/cgp-0119.md b/CGPs/cgp-0119.md
@@ -6,7 +6,7 @@ author: 'Upright Ventures (@upright)'
 status: DRAFT 
 discussions-to: https://forum.celo.org/t/celo-camp-2024-grant-the-minipay-launchpad-and-startup-pathway-program-final/7210/1
 governance-proposal-id: 119
-date-executed: TBA
+date-executed:
 ---
 
 ## Overview

diff --git a/CGPs/cgp-0120.md b/CGPs/cgp-0120.md
@@ -1,11 +1,12 @@
 ---
-cgp: '120'
+cgp: 120
 title: 'Celo Europe H1 2024 | Regional DAO  | CeloPG: Regional DAO'
 date-created: '2024-02-16'
 author: 'Joan de Ramón (@joan_ethichub), Luuk Weber, Niko da Costa Gomez' 
 discussions-to: 'https://forum.celo.org/t/celo-europe-h1-2024-regional-dao-final/7450'
-governance-proposal-id: 'TBA'
-date-executed: 'TBA'
+status: DRAFT
+governance-proposal-id: 
+date-executed:
 ---
 
 ## Overview

diff --git a/CGPs/cgp-0121.md b/CGPs/cgp-0121.md
@@ -1,11 +1,12 @@
 ---
-cgp: '121'
+cgp: 121
 title: 'Prezenti H1 2024 | Celo Grants  | CPG Funding Request - Grants & RPFs'
 date-created: '2024-03-05'
 author: 'Wade @0xzoz , Maya @Maya-R-B , Aaron @aaronmboyd' 
 discussions-to: 'https://forum.celo.org/t/final-prezenti-h1-2024-celo-grants'
-governance-proposal-id: 'TBA'
-date-executed: 'TBA'
+status: DRAFT
+governance-proposal-id:
+date-executed:
 ---
 
 ## Summary

diff --git a/CGPs/cgp-0122.md b/CGPs/cgp-0122.md
@@ -5,8 +5,8 @@ date-created: 2024-03-06
 author: 'Roman Croessmann (@rcroessmann)'
 status: DRAFT
 discussions-to: 'https://forum.celo.org/t/adding-usdt-and-eurt-to-the-mento-reserve/7490'
-governance-proposal-id: 'TBA'
-date-executed: 'TBA'
+governance-proposal-id:
+date-executed:
 ---
 ## Overview
 

diff --git a/CGPs/cgp-0123.md b/CGPs/cgp-0123.md
@@ -1,12 +1,12 @@
 ---
 cgp: 123
 title: MU05 - Add native USDC pools to Mento v2
-date-created: 2024-03-007
+date-created: 2024-03-07
 author: "Nelson Taveras <nelson.taveras@mentolabs.xyz>, Philip Rätsch <philip.raetsch@mentolabs.xyz>"
 status: DRAFT
 discussions-to: https://forum.celo.org/t/proposal-mento-upgrade-mu05-native-usdc-integration/7545
 governance-proposal-id: 163
-date-executed: "TBA"
+date-executed:
 ---
 
 ## Overview

diff --git a/CGPs/mainnet.json → CGPs/cgp-0123/mainnet.json b/CGPs/mainnet.json → CGPs/cgp-0123/mainnet.json
diff --git a/CGPs/cgp-0124.md b/CGPs/cgp-0124.md
@@ -5,8 +5,8 @@ date-created: 2024-03-08
 author: 'Varin Pulpol, Parnaigon Yangpaksi'
 status: DRAFT 
 discussions-to: https://forum.celo.org/t/celo-thailand-h1-2024-regional-dao-draft/7402
-governance-proposal-id: TBA
-date-executed: TBA
+governance-proposal-id:
+date-executed:
 ---
 
 # KohCelo (Celo Thailand DAO) Project for Road to Devcon 2024 | Regional DAO

diff --git a/CGPs/cgp-0125.md b/CGPs/cgp-0125.md
@@ -5,8 +5,8 @@ date-created: 2024-03-08
 author: Chitty Babu, Shaun Joseph (@shaun), Kandasamy Rahunandan, Kundan (@Qaphqa)
 status: DRAFT 
 discussions-to: https://forum.celo.org/t/proposal-for-community-development-in-india-indiadao-community-management
-governance-proposal-id: TBA
-date-executed: TBA
+governance-proposal-id:
+date-executed:
 ---
 
 

diff --git a/CGPs/cgp-0126.md b/CGPs/cgp-0126.md
@@ -1,12 +1,12 @@
 ---
-cgp: '126'
-title: 'Celo Africa H1 2024 | Regional DAO'
-date-created: '2024-02-23'
+cgp: 126
+title: Celo Africa H1 2024 | Regional DAO
+date-created: 2024-02-23
 author: Daniel Kimotho, Umar Sebyala, Chimezie Chuta, Cynthia Kamau
 status: DRAFT 
 discussions-to: https://forum.celo.org/t/celo-africa-h1-2024-regional-dao-final/7497
-governance-proposal-id: 'TBA'
-date-executed: 'TBA'
+governance-proposal-id:
+date-executed:
 ---
 
 

diff --git a/CGPs/cgp-template.md b/CGPs/cgp-template.md
@@ -1,15 +1,15 @@
 ---
-cgp: 001 - <to be assigned>
-title: Proposal 1 Title - <CGP title>
-date-created: 0000-00-00 - <date created on, in ISO 8601 (yyyy-mm-dd) format>
-author: 'Celo User(@celouser) - <a list of the authors or authors name(s) and/or username(s), or name(s) and email(s), e.g. (use with the parentheses or triangular brackets): FirstName LastName (@GitHubUsername), FirstName LastName <foo@bar.com>, FirstName (@GitHubUsername) and GitHubUsername (@GitHubUsername)>'
+cgp: 001 - <Number>
+title: Proposal 1 Title - <String>
+date-created: 0000-00-00 - <ISO 8601 (yyyy-mm-dd) format>
+author: 'Celo User (@celouser) - <String, a list of the authors name(s) and/or username(s)>'
 status: DRAFT - <DRAFT | PROPOSED | EXECUTED | EXPIRED | WITHDRAWN | REJECTED>
-discussions-to: https://forum.link <link to discussion on forum.celo.org> // Only link not in MD format - https://forum.link NOT [link](https://forum.link)
-governance-proposal-id: 001 - [if submitted]
-date-executed: 0000-00-00 -  <date created on, in ISO 8601 (yyyy-mm-dd) format>
+discussions-to: https://forum.link - <URL of discussion forum>
+governance-proposal-id: 001 - <Number if submitted, or empty>
+date-executed: 0000-00-00 - <ISO 8601 (yyyy-mm-dd) if executed, or empty>
 ---
-<!-- Please view another completed proposal for reference on filling the above section. It is important the type is correct eg Number, String -->
- 
+
+<!-- Please view other proposals for an example on filling the above section. It is important the type is correct eg Number, String -->
 
 ## Overview
 
@@ -18,10 +18,12 @@ CGP - Celo Governance Proposal
 Pick a four digit number subsequent to the latest PR raised and name your file.
 
 ### Status
+
 - DRAFT = Feedback collection
 - PROPOSED = The governance proposal was submitted to the network
 - EXECUTED = The governance proposal was executed on the network
 - EXPIRED = The governance proposal expired
+- REJECTED = The governance proposal did not receive enough support
 - WITHDRAWN = The governance proposal is withdrawn before being submitted on the network
 
 Describe the issue that motivates this CGP. It should indicate all parameters that are being changed and why doing so is important.

diff --git a/package.json b/package.json
@@ -0,0 +1,29 @@
+{
+  "name": "@celo/governance",
+  "version": "1.0.0",
+  "keywords": [
+    "Celo",
+    "Governance",
+    "CGP"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/celo-org/governance"
+  },
+  "homepage": "https://celo.org",
+  "private": true,
+  "packageManager": "yarn@4.1.1",
+  "type": "module",
+  "engines": {
+    "node": "20.x"
+  },
+  "devDependencies": {
+    "micromark": "^4.0.0",
+    "micromark-extension-gfm-table": "^2.0.0",
+    "yaml": "^2.4.1",
+    "zod": "^3.22.4"
+  },
+  "scripts": {
+    "validate": "node ./scripts/validate.js"
+  }
+}