feat: scope the CI and add QoL improvements #3316

zivkovicmilos · 2024-12-10T14:47:39Z

Description

This PR modifies the monorepo workflows, and introduces QoL improvements to the overall CI.
The PR is not meant to be a cover-all fix for the CI, but a start on how we can begin improving it.

@gfanton We should start looking into how to group txtars soon 🙏

Gno2D2 · 2024-12-10T14:49:04Z

🛠 PR Checks Summary

🔴 The pull request head branch must be up-to-date with its base (more info)

Manual Checks (for Reviewers):

SKIP: Do not block the CI for this PR
Determine if infra needs to be updated before merging

✅ Automated Checks (for Contributors):

🔴 The pull request head branch must be up-to-date with its base (more info)

☑️ Contributor Actions:

Fix any issues flagged by automated checks.
Follow the Contributor Checklist to ensure your PR is ready for review.
- Add new tests, or document why they are unnecessary.
- Provide clear examples/screenshots, if necessary.
- Update documentation, if required.
- Ensure no breaking changes, or include BREAKING CHANGE notes.
- Link related issues/PRs, where applicable.

☑️ Reviewer Actions:

Complete manual checks for the PR, including the guidelines and additional checks if applicable.

📚 Resources:

Debug

Automated Checks

The pull request head branch must be up-to-date with its base (more info)

If

🟢 Condition met
└── 🟢 On every pull request

Then

🔴 Requirement not satisfied
└── 🔴 Head branch (dev/zivkovicmilos/ci-qol) is up to date with base (master): behind by 3 / ahead by 7

Manual Checks

**SKIP**: Do not block the CI for this PR

If
🟢 Condition met
└── 🟢 On every pull request
Can be checked by

Any user with comment edit permission

Determine if infra needs to be updated before merging

If

🟢 Condition met
└── 🟢 And
    ├── 🟢 The base branch matches this pattern: master
    └── 🟢 Or
        ├── 🔴 A changed file matches this pattern: Dockerfile
        ├── 🔴 A changed file matches this pattern: ^misc/deployments
        ├── 🔴 A changed file matches this pattern: ^misc/docker-
        ├── 🟢 A changed file matches this pattern: ^.github/workflows/releaser.*\.yml$ (filename: .github/workflows/releaser-master.yml)
        └── 🟢 A changed file matches this pattern: ^.github/workflows/portal-loop\.yml$ (filename: .github/workflows/portal-loop.yml)

Can be checked by

team devops

thehowl · 2024-12-10T14:52:31Z

gno.land/pkg/integration/testdata/addpkg.txtar

The testdata here should just be to test the integration system itself

I have another proposal here that was spinning around in my brain: I actually like that in gnovm, we put the "integration tests" for the vm inside of tests. What would you think of putting txtars in gno.land/tests/scripts (or txtar, testscript, ...)

thehowl · 2024-12-10T14:53:06Z

gno.land/cmd/gnoland/integration_test.go

Don't think, as a consequence of my other comment, that this should be removed

thehowl · 2024-12-10T14:53:35Z

.github/workflows/test_template.yml

Can we add an .editorconfig?

thehowl · 2024-12-10T14:54:49Z

.github/workflows/releaser.yml

though we'll probably need it again once we start publishing for mainnet.

thehowl · 2024-12-10T14:56:06Z

.github/workflows/fossa.yml

Manfred said we only care about this action for the event once every few years that legal remembers open source licenses exist and they ask us for an audit. I'm OK with this actually being enabled, but d we have an API key?

thehowl · 2024-12-10T14:59:06Z

.github/golangci.yml

  forbidigo:
    forbid:
      - p: '^regexp\.(Match|MatchString)$'
-        msg: it will re-compile the regexp for each execution; compile the regexp with regexp.Compile and store it as a singleton


iirc the error message came out better written out (in context) as I wrote it

cmd/gno/main.go:26:2: use of `regexp.MatchString` forbidden because "it will re-compile the regexp for each execution; compile the regexp with regexp.Compile and store it as a singleton" (forbidigo)

thehowl · 2024-12-10T15:01:57Z

.github/workflows/autocounterd.yml

shouldn't we test building it?

do we use it in any deployment?

thehowl · 2024-12-10T15:02:45Z

.github/workflows/examples.yml

@@ -1,9 +1,13 @@
-name: examples
+name: Gno Examples CI Suite


Keep this one short; "CI suite" is redundant.

I like "Test Examples"

thehowl · 2024-12-10T15:02:55Z

.github/workflows/docs-linter.yml


 on:
  push:
-    paths:
+    branches:
      - master


thehowl · 2024-12-10T15:03:38Z

.github/workflows/gnovm.yml

@@ -1,22 +1,27 @@
-name: gnovm
+name: GnoVM CI Suite


Also redundant, same for all others

These names matter because they show up as the names of the workflows; it's better if they're compact

codecov · 2024-12-10T15:12:10Z

Codecov Report

All modified and coverable lines are covered by tests ✅

📢 Thoughts on this report? Let us know!

ajnavarro

Left some comments. The most important ones are keeping go version in less config files as possible and keep dependabot tags as they were, because they will be easier to maintain (everything needed to create a new workflow is in only one config file, you don't need to change dependabot config)

ajnavarro · 2024-12-11T10:13:08Z

.github/codecov.yml

+  groups:
+    gno-land:
+      paths:
+        - "gno.land/**"
+      flags:
+        - gno-land
+    gnovm:
+      paths:
+        - "gnovm/**"
+      flags:
+        - gnovm
+    misc:
+      paths:
+        - "misc/**"
+      flags:
+        - misc
+    tm2:
+      paths:
+        - "tm2/**"
+      flags:
+        - tm2
+    contribs:
+      paths:
+        - "contribs/**"
+      flags:
+        - contribs


Flags are already automatically defined here: https://github.com/gnolang/gno/pull/3316/files#diff-a8d8d916d02d13f09d2a0128a4667158fdd150a4e354d0c7a9cde6a8479b3dc5R68 so no need to define them here.

ajnavarro · 2024-12-11T10:14:37Z

.github/codecov.yml

+  statuses:
+    - type: project
+      flag: gno-land
+      target: auto
+      threshold: 5
+    - type: project
+      flag: gnovm
+      target: auto
+      threshold: 2 # Stricter threshold
+    - type: project
+      flag: misc
+      target: auto
+      threshold: 10
+    - type: project
+      flag: tm2
+      target: auto
+      threshold: 5
+    - type: project
+      flag: contribs
+      target: auto
+      threshold: 5


why do we want to change thresholds depending on the flag? Is it really necessary?

ajnavarro · 2024-12-11T10:16:34Z

.github/workflows/benchmark-master-push.yml

@@ -9,6 +9,7 @@ on:
      - gno.land/**
      - gnovm/**
      - tm2/**
+      - '**/*.go'


This is making previous filters unnecessary.

ajnavarro · 2024-12-11T10:19:55Z

.github/workflows/contribs.yml

    name: Run Main
    uses: ./.github/workflows/main_template.yml
    with:
      modulepath: contribs/${{ matrix.program }}
+      go-version: "1.22.x"


moving go version outside the main template is making it scattered around more than before...

ajnavarro · 2024-12-11T10:26:03Z

.github/workflows/main_template.yml

+      go-version:
+        description: "Go version to use"
+        required: true
+        type: string


I prefer to keep all references to go version inside only one file: this one.

ajnavarro · 2024-12-11T10:29:10Z

.github/workflows/releaser.yml

zivkovicmilos added 6 commits December 9, 2024 16:02

Save progress

19b9336

Update workflows, standardize gno fmt

a48cb2c

Move gnoland txtar files

3b70e12

Improve the CI further

fba9234

Update codecov.yml

6027a08

Minor tidy of golangci.yml

782b78c

zivkovicmilos requested review from sw360cab, ajnavarro and thehowl December 10, 2024 14:47

zivkovicmilos self-assigned this Dec 10, 2024

github-actions bot added the 📦 ⛰️ gno.land Issues or PRs gno.land package related label Dec 10, 2024

Merge branch 'master' into dev/zivkovicmilos/ci-qol

32b8e22