[GitHub Action] Automatically open a PR for `accepted` guideline issues #122

x0rw · 2025-05-31T01:11:44Z

Hey 👋.
This PR adds a workflow that automatically opens a PR for the accepted guidelines marked by 'accepted' label,
The script extracts the marked issue and parses it into a proper guideline rst file and appends this content into the appropriate chapter(eg. if the chapter is concurrency it will append the gl to src/coding-guidelines/concurreny.rst, note: the chapters title in here should be directly mapped to the names in coding-guidelines/ directory).

Tasks:

Workflow
Script takes the issue from stdin and turn it into our guidelines' .rst format
- Github Action can recieve the issue in json format through github.event.issue variable
- All issues are in this format: https://api.github.com/repos/x0rw/safety-critical-rust-coding-guidelines/issues/4
Review
Clean Up

How to test? :

Merge my branch into your forked main
Enable issues from your fork's settings.
Create an issue with the guideline template.
Add 'status: approved' label (create the label first).
Now check Actions tab to see a 'auto-pr' job running.
After a while there should be a new PR by GA.
For iterative testing, remove and reassign the 'status: approved' label(make sure it's removed and added from the issue's timeline) and GA will force push again on the same PR.

netlify · 2025-05-31T01:11:48Z

❌ Deploy Preview for scrc-coding-guidelines failed.

Name	Link
🔨 Latest commit	`c1ebb63`
🔍 Latest deploy log	https://app.netlify.com/projects/scrc-coding-guidelines/deploys/6877b4fe584c360008e12163

PLeVasseur

Hey @x0rw thanks for taking this on. I haven't reviewed it in detail yet.
Noticed that you could use an existing label tho 👍

By the way, I see the build is failing -- is that intentional / expected?
I'd like to start reviewing once the build passes.

.github/workflows/auto-pr-on-issue.yml

x0rw · 2025-06-07T17:25:37Z

Hi @PLeVasseur.
The build failed because of the FLS difference checks. I guess it was fixed in a previous PR. You can re-run it, and it should work fine.

x0rw · 2025-06-07T17:31:54Z

Also, let me know when to remove those json test issues because i picked them randomly from my repo.

PLeVasseur · 2025-07-12T13:31:51Z

Hey @x0rw -- could you rebase? @darkwisebear recently update the spec lock file.

test auto-pr template 2 test auto-pr template 3 test auto-pr template 4 test auto-pr template 5 test auto-pr template 6 test auto-pr template 7 test auto-pr template 8 test auto-pr template 9

Co-authored-by: Pete LeVasseur <[email protected]>

Fix 2 Fix 3 fix : special char i yml

PLeVasseur · 2025-07-12T14:23:27Z

Could you help me become less ignorant? 😅

What's going on here?

Is it possible to enable anyone to try to auto-rebase?

Is it this the Automatic Rebase action or something else? (that action looks kinda nice...)

x0rw · 2025-07-12T14:36:09Z

What's going on here?

Is it possible to enable anyone to try to auto-rebase?

Is it this the Automatic Rebase action or something else? (that action looks kinda nice...)

Hey @PLeVasseur 😄
My local branch name is called github-action/auto-pr, i think that's what confused you.
When i rebase i simply do
git pull upstream main --rebase && git push origin "repo name" --force-with-lease,
but actually i think adding that Automatic Rebase /rebase command would be nice in here.

x0rw · 2025-07-12T14:40:59Z

@PLeVasseur,
This is rebased, and i squashed some of those testing commits.

PLeVasseur

Hey @x0rw -- sorry for the long delay 😅 I'm back from my "workation" in Japan and jumping back into reviews.

Bottom-line: I really like the concept and how you executed it.

Summary of feedback: As you can see from some of the comments I left, there's some refactoring that needs to be done to allow for easier maintenance in the future between both generate-guideline-templates.py and auto-pr-helper.py. Hope the rationale makes sense! 🙏

.github/workflows/auto-pr-on-issue.yml

scripts/auto-pr-helper.py

.github/workflows/auto-pr-on-issue.yml

PLeVasseur · 2025-07-12T14:42:06Z

.github/workflows/auto-pr-on-issue.yml

+      - name: Run Python script to generate guideline file
+        run: |
+          echo '${{ toJson(github.event.issue) }}' | python3 scripts/auto-pr-helper.py
+


It would be super nice here to try to build the coding guidelines in a step in-between here and then either:

fail this action and report why as a comment on the issue (reading the build log and any errors generate to create the comment) or

allow the PR to be opened and leave a comment on the PR as to why the build failed

I'm kind of partial to 1, but could be swayed. Could also be done in a follow-up PR. What do you think?

Tagging some others for their thoughts too
@vapdrs, @felix91gr, @plaindocs

Did you have any thoughts on this @x0rw?

Hey @PLeVasseur, I think commenting on the PR(2) is a better approach, as it opens the door for reviewer to make changes and fix minor problems.

Seems fair to me. 👍

.github/workflows/auto-pr-on-issue.yml

scripts/auto-pr-helper.py

PLeVasseur · 2025-07-12T14:49:42Z

scripts/auto-pr-helper.py

+    """
+
+
+    # taken from generate-guideline-templates.py


I know that refactoring this may be kind of un-fun, but I strongly think for maintenance reasons we should extract any shared code needed like this and then reference a function here and any place else like that in this file.

I'm not great at Python, but I'd imagine it's somehow possible to refactor generate_guideline_template() from generate-guideline-templates.py to pull this off.

e.g. pass in a dictionary to generate_guideline_template() and if the relevant fields entries are filled extract and populate them.

Sorry, hope you understand 😅

Thanks for flagging this, i did some refactoring around both.

Thanks for understanding!

By the way -- are these lines that are generating IDs now not required to be here?

I see this work is now done in guideline_rst_template().

I modified this nvim plugin i have, to hide all the comments and empty lines, and I always forget that it's enabled, i will disable it for now to pay attention to these issues.

Ah, what I meant to ask is whether we still need these lines in guideline_template()

# generate random ids guideline_id = generate_id("gui") rationale_id = generate_id("rat") non_compliant_example_id = generate_id("non_compl_ex") compliant_example_id = generate_id("compl_ex")

Given that now this is done within generate_guideline_template().

Seemed like no, but wasn't sure.

Ahh good catch, you're right -- we really need a linter to catch these earlier.

PLeVasseur · 2025-07-12T14:53:44Z

.github/workflows/auto-pr-on-issue.yml

+          git config --global user.email "[email protected]"
+          git config --global user.name "GitHub Action"
+
+      # - name: Save issue JSON payload to file


Is this dead code needed?

scripts/auto-pr-helper.py

scripts/test_issue_sample.json

add snapshot testing and their runner renamed generate-guideline-templates.py to generate_guideline_templates.py general refactor

Co-authored-by: Pete LeVasseur <[email protected]>

This workflow only triggers when the auto-pr script or the snapshot test directory changes

x0rw · 2025-07-12T23:15:38Z

About testing the auto-pr script, I went with snapshot testing approach, i compare the generated .rst template from issue json with the expected .rst result,
I added the correspondant test workflow that only triggers when you change relevant files/dirs.
About the test_issue_01/02,json i pulled them from my own issues(not personal issues) for testing, we can change them to issues from this repo and have them snapshotted.

PLeVasseur

Thanks for taking on the refactoring @x0rw! I've suggested some bits here that I think could help. Could you take a look?

.github/workflows/auto-pr-on-issue.yml

generate_guideline_templates.py

PLeVasseur · 2025-07-13T11:39:16Z

generate_guideline_templates.py

+    def norm(value: str) -> str:
+        return value.strip().lower()
+
+    guideline_text = f""".. guideline:: {guideline_title.strip()}


Like the other comment I left, I think it could make it easier on the eyes if the whitespacing were as-if the contents of the .rst file were dropped in here.

Probably writing an example of what I mean will make this make more sense:

guideline_text = f"""\ .. guideline:: {guideline_title.strip()} :id: {guideline_id} ... :tags: {",".join(tags.strip().split())} {amplification.strip()} .. rationale:: :id: {rationale_id} ... """

I realize that this may imply that there's four spaces ahead of .. guideline:: {guideline_title.strip()} written as I did above, but I've got to imagine there's some way to accomplish this that makes it formatted as if it were the contents of the .rst and also play nicely with surrounding parts of the program.

Some quick searches turned up the textwrap library with its dedent() function which

Remove any common leading whitespace from every line in text.

This can be used to make triple-quoted strings line up with the left edge of the display, while still presenting them in the source code in indented form.

So for example, from their linked docs above:

def test(): # end first line with \ to avoid the empty line! s = '''\ hello world ''' print(repr(s)) # prints ' hello\n world\n ' print(repr(dedent(s))) # prints 'hello\n world\n'

Yeah it isn't great, I like your approach, although dedent can cause some issues with the code blocks indentations, it isn't that major.

I see you've used dedent now, so I'm curious to hear about this if it's worth sharing:

although dedent can cause some issues with the code blocks indentations, it isn't that major.

dedent basically strips common leading spaces to make code neat and tidy, the issue is that we actually add intentional indentations to the code blocks before saving them in the .rst file, if it's not set right(at the right point), it can remove those intentional indents, breaking formatting.

scripts/test_issue_sample.json

scripts/auto-pr-helper.py

.github/workflows/snapshot-ci.yml

Co-authored-by: Pete LeVasseur <[email protected]>

PLeVasseur requested changes Jun 7, 2025

View reviewed changes

.github/workflows/auto-pr-on-issue.yml Outdated Show resolved Hide resolved

x0rw requested a review from PLeVasseur June 11, 2025 22:48

Triger workflow

e21e15c

x0rw force-pushed the github-action/auto-pr branch from e02a930 to 34a4740 Compare July 12, 2025 13:59

x0rw and others added 6 commits July 12, 2025 15:02

test auto-pr template

e12c585

test auto-pr template 2 test auto-pr template 3 test auto-pr template 4 test auto-pr template 5 test auto-pr template 6 test auto-pr template 7 test auto-pr template 8 test auto-pr template 9

chores: minor stuffs

62a5b60

chores: proper pr title

16821e2

Add comments

a4574ba

Update .github/workflows/auto-pr-on-issue.yml

4c2cd93

Co-authored-by: Pete LeVasseur <[email protected]>

Fix

2d60b33

Fix 2 Fix 3 fix : special char i yml

x0rw force-pushed the github-action/auto-pr branch from 34a4740 to 2d60b33 Compare July 12, 2025 14:02

Fix non compliant ex

9a30c38

PLeVasseur requested changes Jul 12, 2025

View reviewed changes

PLeVasseur mentioned this pull request Jul 12, 2025

[Coding Guideline]: Recursive function #135

Open

x0rw and others added 3 commits July 12, 2025 23:25

refactor: address code review

a7f233e

add snapshot testing and their runner renamed generate-guideline-templates.py to generate_guideline_templates.py general refactor

Fix workflow, use uv instead

601ad76

Co-authored-by: Pete LeVasseur <[email protected]>

Add snapshot tests workflow

b5c4829

This workflow only triggers when the auto-pr script or the snapshot test directory changes

x0rw force-pushed the github-action/auto-pr branch from 36406c5 to b5c4829 Compare July 12, 2025 23:05

PLeVasseur requested changes Jul 13, 2025

View reviewed changes

x0rw and others added 3 commits July 13, 2025 16:19

Update .github/workflows/auto-pr-on-issue.yml

40c24c7

Co-authored-by: Pete LeVasseur <[email protected]>

Apply suggestion from @PLeVasseur

17c29b7

Co-authored-by: Pete LeVasseur <[email protected]>

Apply suggestion from @PLeVasseur

73e80b3

Co-authored-by: Pete LeVasseur <[email protected]>

x0rw added 7 commits July 13, 2025 18:11

address review comments

b703416

test ci snapshot error

b358787

Fix issues, refactor dedent, update worflow to use astral actions

7a91e82

Fix ci

01878e9

Inline compliant and non-compliant-exs in guideline template

21af709

Address review comments and remove unused code

467875c

ci: add co-author info from issue author in auto-generated PRs

c1ebb63

[GitHub Action] Automatically open a PR for accepted guideline issues #122

Are you sure you want to change the base?

[GitHub Action] Automatically open a PR for accepted guideline issues #122

Conversation

x0rw commented May 31, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Tasks:

How to test? :

Uh oh!

netlify bot commented May 31, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

❌ Deploy Preview for scrc-coding-guidelines failed.

Uh oh!

PLeVasseur left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

x0rw commented Jun 7, 2025

Uh oh!

x0rw commented Jun 7, 2025

Uh oh!

PLeVasseur commented Jul 12, 2025

Uh oh!

PLeVasseur commented Jul 12, 2025

Uh oh!

x0rw commented Jul 12, 2025

Uh oh!

x0rw commented Jul 12, 2025

Uh oh!

PLeVasseur left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

PLeVasseur Jul 12, 2025 • 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!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

x0rw commented Jul 12, 2025

Uh oh!

PLeVasseur left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

[GitHub Action] Automatically open a PR for `accepted` guideline issues #122

[GitHub Action] Automatically open a PR for `accepted` guideline issues #122

x0rw commented May 31, 2025 •

edited

Loading

netlify bot commented May 31, 2025 •

edited

Loading

PLeVasseur Jul 12, 2025 •

edited

Loading