[Tooling] Output changelog validation check into the PR automatically by deblasis · Pull Request #596 · pokt-network/pocket

deblasis · 2023-03-20T15:44:59Z

Description

This PR improves DevX by outputting the result of a changelog validation into the PR and requesting changes:

Once the check is successful, the automatically added review comments are dismissed

The commits of this PR are also included in #577

Issue

None because developed in < 4h

Type of change

Please mark the relevant option(s):

List of changes

Updated changelog-verify.yaml to automatically review / dismiss changelog specific reviews

Testing

make develop_test
LocalNet w/ all of the steps outlined in the README

Required Checklist

I have performed a self-review of my own code
I have commented my code, particularly in hard-to-understand areas
I have added, or updated, godoc format comments on touched members (see: tip.golang.org/doc/comment)
I have tested my changes using the available tooling
I have updated the corresponding CHANGELOG

If Applicable Checklist

I have updated the corresponding README(s); local and/or global
I have added tests that prove my fix is effective or that my feature works
I have added, or updated, mermaid.js diagrams in the corresponding README(s)
I have added, or updated, documentation and mermaid.js diagrams in shared/docs/* if I updated shared/*README(s)

Signed-off-by: Alessandro De Blasis <alex@deblasis.net>

Olshansk

This is what you call automation.

REALLY REALLY 🆒

Olshansk · 2023-03-21T00:04:10Z

.github/workflows/changelog-verify.yml

+    needs: validate
+    if: always()
+    steps:
+      - name: Verify changelogs KO


"KO" 🥊: knock-out, usually used to define a bad outcome, contrary to the "OK"

Am I that old? Mmmmmmkay!

Haha, that's what I had assumed but had to make sure.

I used to box when I was a kid :)

Olshansk · 2023-03-21T00:06:32Z

.github/workflows/changelog-verify.yml

+        uses: actions/github-script@v5
+        with:
+          script: |
+            const result = `<!-- validate_review -->The changelog validation failed with the following output:


Should we use validate_review_chaenlogs as the unique identifier?

I can see us following this pattern for other times of comments as well

Side note: I'm on the waitlist for https://reviewpad.com/openai-waitlist

Cool! (I think reviews are going to get quite noisy, I am curious tho)

Re: ChatGPT... So far my experience hasn't been great, I had a couple of hiccups with this PR and I asked for help... the results made sense but just didn't work. I'll keep trying, if anything, it could be inspiration

Keep trying. It's just a new skill we have to learn.

Olshansk

Excited to take this for a match 🥊

* pokt/main: [Tooling] Output changelog validation check into the PR automatically (#596) [debug client] Limit key import concurrency to 4 (#591) [SHARED][CLI] adds message routing type field to debug messages and CLI commands (#561)

…#596) ## Description This PR improves DevX by outputting the result of a changelog validation into the PR and requesting changes: ![image](https://user-images.githubusercontent.com/29378614/226392565-f20c77c2-19c7-42f7-8305-c11592f95f09.png) Once the check is successful, the automatically added review comments are dismissed The commits of this PR are also included in #577 ## Issue None because developed in < 4h ## Type of change Please mark the relevant option(s): - [x] New feature, functionality or library - [ ] Bug fix - [ ] Code health or cleanup - [ ] Major breaking change - [ ] Documentation - [ ] Other  ## List of changes - Updated changelog-verify.yaml to automatically review / dismiss changelog specific reviews ## Testing - [ ] `make develop_test` - [ ] [LocalNet](https://github.com/pokt-network/pocket/blob/main/docs/development/README.md) w/ all of the steps outlined in the `README` ## Required Checklist - [ ] I have performed a self-review of my own code - [ ] I have commented my code, particularly in hard-to-understand areas - [ ] I have added, or updated, [`godoc` format comments](https://go.dev/blog/godoc) on touched members (see: [tip.golang.org/doc/comment](https://tip.golang.org/doc/comment)) - [ ] I have tested my changes using the available tooling - [ ] I have updated the corresponding CHANGELOG ### If Applicable Checklist - [ ] I have updated the corresponding README(s); local and/or global - [ ] I have added tests that prove my fix is effective or that my feature works - [ ] I have added, or updated, [mermaid.js](https://mermaid-js.github.io) diagrams in the corresponding README(s) - [ ] I have added, or updated, documentation and [mermaid.js](https://mermaid-js.github.io) diagrams in `shared/docs/*` if I updated `shared/*`README(s) --------- Signed-off-by: Alessandro De Blasis <alex@deblasis.net>

…pokt-network#596) ## Description This PR improves DevX by outputting the result of a changelog validation into the PR and requesting changes: ![image](https://user-images.githubusercontent.com/29378614/226392565-f20c77c2-19c7-42f7-8305-c11592f95f09.png) Once the check is successful, the automatically added review comments are dismissed The commits of this PR are also included in pokt-network#577 ## Issue None because developed in < 4h ## Type of change Please mark the relevant option(s): - [x] New feature, functionality or library - [ ] Bug fix - [ ] Code health or cleanup - [ ] Major breaking change - [ ] Documentation - [ ] Other  ## List of changes - Updated changelog-verify.yaml to automatically review / dismiss changelog specific reviews ## Testing - [ ] `make develop_test` - [ ] [LocalNet](https://github.com/pokt-network/pocket/blob/main/docs/development/README.md) w/ all of the steps outlined in the `README` ## Required Checklist - [ ] I have performed a self-review of my own code - [ ] I have commented my code, particularly in hard-to-understand areas - [ ] I have added, or updated, [`godoc` format comments](https://go.dev/blog/godoc) on touched members (see: [tip.golang.org/doc/comment](https://tip.golang.org/doc/comment)) - [ ] I have tested my changes using the available tooling - [ ] I have updated the corresponding CHANGELOG ### If Applicable Checklist - [ ] I have updated the corresponding README(s); local and/or global - [ ] I have added tests that prove my fix is effective or that my feature works - [ ] I have added, or updated, [mermaid.js](https://mermaid-js.github.io) diagrams in the corresponding README(s) - [ ] I have added, or updated, documentation and [mermaid.js](https://mermaid-js.github.io) diagrams in `shared/docs/*` if I updated `shared/*`README(s) --------- Signed-off-by: Alessandro De Blasis <alex@deblasis.net>

deblasis added 24 commits March 20, 2023 15:08

fix(tooling): bug

08ee701

Signed-off-by: Alessandro De Blasis <alex@deblasis.net>

feat(tooling): make it fail on comment

34bf003

fix(tooling): typo

04909c4

fix(tooling): dismissal

5b68c3f

fix(tooling): test

5d01a49

refactor(tooling): review job

2c7d025

fix(tooling): run review always

7f1d184

fix(tooling): result to output

ee0a44e

chore(tooling): debug

939f7f2

chore(tooling): cleanup

3fa9a3a

chore(tooling): debug

e68cea8

fix(tooling): case-sensitive

53e3232

chore(tooling): debug KO

8e2a499

chore(tooling): debug

fbf8e14

chore(tooling): fix already dismissed

2372ee5

fix(tooling): using chatgpt for bugfix 🤞

c67db05

fix(tooling): capturing stderr, echoing back to stderr

ea0d3cc

fix(tooling): typo

3cb7755

fix(tooling): using a file and tee

b1489c0

fix(tooling): cleanup

7dfe119

fix(tooling): formatting

3e397f8

fix(tooling): escaping

17c770d

fix(tooling): jq to the rescue

a9a58f8

feat(tooling): console.log in review checks

d2cbeb3

deblasis added the tooling tooling to support development, testing et al label Mar 20, 2023

deblasis added this to the M1: Pocket PoS (Proof of Stake) milestone Mar 20, 2023

deblasis self-assigned this Mar 20, 2023

deblasis marked this pull request as ready for review March 20, 2023 15:45

deblasis requested review from Olshansk and okdas March 20, 2023 15:47

Olshansk requested changes Mar 21, 2023

View reviewed changes

deblasis added 2 commits March 21, 2023 00:25

chore(tooling): validate_changelogs_review

8364d79

chore(tooling): KO -> Failed

6098d5f

deblasis requested a review from Olshansk March 21, 2023 00:28

Olshansk approved these changes Mar 21, 2023

View reviewed changes

deblasis merged commit 8a8983e into main Mar 21, 2023

deblasis mentioned this pull request Mar 21, 2023

[Utility][Persistence][Savepoints/Rollbacks] Refactor UtilityContext into UtilityUnitOfWork (Issue #563) #577

Merged

16 tasks

Olshansk deleted the feat/changelog_auto_review branch March 21, 2023 03:48

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Tooling] Output changelog validation check into the PR automatically#596

[Tooling] Output changelog validation check into the PR automatically#596
deblasis merged 26 commits intomainfrom
feat/changelog_auto_review

deblasis commented Mar 20, 2023 •

edited

Loading

Uh oh!

Olshansk left a comment

Uh oh!

Olshansk Mar 21, 2023

Uh oh!

deblasis Mar 21, 2023

Uh oh!

Olshansk Mar 21, 2023

Uh oh!

Olshansk Mar 21, 2023

Uh oh!

Olshansk Mar 21, 2023

Uh oh!

deblasis Mar 21, 2023 •

edited

Loading

Uh oh!

Olshansk Mar 21, 2023

Uh oh!

Olshansk left a comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

deblasis commented Mar 20, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Issue

Type of change

List of changes

Testing

Required Checklist

If Applicable Checklist

Uh oh!

Olshansk left a comment

Choose a reason for hiding this comment

Uh oh!

Olshansk Mar 21, 2023

Choose a reason for hiding this comment

Uh oh!

deblasis Mar 21, 2023

Choose a reason for hiding this comment

Uh oh!

Olshansk Mar 21, 2023

Choose a reason for hiding this comment

Uh oh!

Olshansk Mar 21, 2023

Choose a reason for hiding this comment

Uh oh!

Olshansk Mar 21, 2023

Choose a reason for hiding this comment

Uh oh!

deblasis Mar 21, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Olshansk Mar 21, 2023

Choose a reason for hiding this comment

Uh oh!

Olshansk left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

deblasis commented Mar 20, 2023 •

edited

Loading

deblasis Mar 21, 2023 •

edited

Loading