website icon indicating copy to clipboard operation
website copied to clipboard

✨ Enhancement: It would be great having a Github Action that creates a PR with the changes required after a Add new tool issue is created

Open benjagm opened this issue 1 year ago • 18 comments

Is your feature request related to a problem? Please describe

Everytime that an "Add a new tool" issue is created, we need to manually add the changes while this can be easily automated.

Describe the solution you'd like

I'd like to have an action that triggers after the creation of the issue and creates a PR with the required changes.

Describe alternatives you've considered

No response

Additional context

No response

Are you working on this?

No

benjagm avatar Nov 23 '24 09:11 benjagm

What do you think @aialok @DarhkVoyd ?

benjagm avatar Nov 23 '24 09:11 benjagm

Hey @benjagm! I would like to create this. Could you clarify which changes need to be done manually and are repetitive?

rishabhknowss avatar Dec 19 '24 20:12 rishabhknowss

benjagm This would be great to have. @rishabhknowss The tools data for the /tools page is available here: here. Currently, adding a new tool to the data involves creating an issue manually and waiting for someone to pick it up and create a pull request (PR). However, this process can be automated by using a GitHub Action that creates a PR with the necessary changes to add the tools. Hope this helps!

DarhkVoyd avatar Dec 20 '24 07:12 DarhkVoyd

@DarhkVoyd I am interested in working on this issue. Please assign it to me.

techmannih avatar Dec 21 '24 13:12 techmannih

benjagm This would be great to have. @rishabhknowss The tools data for the /tools page is available here: here. Currently, adding a new tool to the data involves creating an issue manually and waiting for someone to pick it up and create a pull request (PR). However, this process can be automated by using a GitHub Action that creates a PR with the necessary changes to add the tools. Hope this helps!

Okay working on this issue !

rishabhknowss avatar Dec 21 '24 17:12 rishabhknowss

@rishabhknowss, can I collaborate with you on this?

techmannih avatar Dec 21 '24 18:12 techmannih

hey @rishabhknowss are you working on this cause i have almost solved this, please let me know .

Sahil-Shadwal avatar Dec 24 '24 09:12 Sahil-Shadwal

@Sahil-Shadwal, I'm also working on it. If you want, we can work together.

techmannih avatar Dec 24 '24 09:12 techmannih

Hey @benjagm , @DarhkVoyd

i have few doubts, i have done this to solve this issue:

  • a workflow (.github/workflows/auto-add-tool.yml) that triggers on issues.opened, runs a script (scripts/parseIssue.ts), and creates a PR.
  • the script parses the issue body, updates tooling-data.yaml, and downloads the logo (if provided).

is this the right approach ?

Sahil-Shadwal avatar Jan 02 '25 14:01 Sahil-Shadwal

Ah, I got the time to work on this! While I was solving this issue, I simply created a GitHub Action that triggers when an issue is created and saves the issue's information directly to the tooling-data.json file. After that, it creates a commit. image Something like this ? What do you think, guys? I guess not using another script would be a better approach here @Sahil-Shadwal Can anyone tell me how to test the GitHub Actions locally? Meanwhile, I am fixing the workflow code!!

rishabhknowss avatar Jan 03 '25 12:01 rishabhknowss

@rishabhknowss I think you can use yalc package

techmannih avatar Jan 04 '25 11:01 techmannih

hi

i work on the this workflow create-tool-pr.yml This GitHub Actions workflow is designed to automate the process of adding a new tool to the data/tooling-data.yaml file whenever an issue is triggered with the "Add Tool" label.

Key Features:

  • Trigger: The workflow is activated when an issue is opened or edited with the "Add Tool" label.
  • Branch Creation: Automatically creates a new branch named after the tool and the current timestamp.
  • Data Addition: Appends the extracted tool information to the data/tooling-data.yaml file.
  • Commit and Push: Commits the changes and pushes the new branch to the repository.
  • Pull Request Creation: Automatically creates a pull request for the new tool addition, summarizing the changes made.

Video Demo

https://github.com/user-attachments/assets/9e35570d-7fd5-4389-985f-f6f930c5f87a

MadhavDhatrak avatar Jan 10 '25 05:01 MadhavDhatrak

@DhairyaMajmudar @benjagm @DarhkVoyd Can you assign me to this issue To make a PR?

MadhavDhatrak avatar Jan 10 '25 05:01 MadhavDhatrak

@MadhavDhatrak still up to take this ?

DhairyaMajmudar avatar Mar 11 '25 09:03 DhairyaMajmudar

@DhairyaMajmudar can I work on this issue?, since no one is working and I have basic understanding of the process because just opened a PR #1494

Vishv04 avatar Mar 11 '25 10:03 Vishv04

@DhairyaMajmudar Yes,I am still interested this Please assign me and I'll make a PR soon

MadhavDhatrak avatar Mar 11 '25 12:03 MadhavDhatrak

Hii @DhairyaMajmudar, if this issue available, love to take this up.

vtushar06 avatar Jul 11 '25 08:07 vtushar06

Hey @DhairyaMajmudar @Utkarsh-123github Approach: Create a .yml file. This GitHub Actions setup helps automate the process of inserting a new tool into the data/tooling-data.yaml file whenever an issue is tagged with the "Add Tool" label. Main Functions:

  • PR Automation: It then opens a pull request that outlines the details of the tool being added.
  • Activation: The workflow kicks in whenever an issue is created or modified and carries the "Add Tool" label.
  • Versioning: The workflow commits these updates and pushes the newly formed branch.
  • Branch Setup: It spins up a fresh branch that includes the tool's name along with a timestamp.
  • Data Update: The tool information collected from the issue is added to the data/tooling-data.yaml file.

I would also like to take up this issue, as it seems really exciting to me. Let me know if any refinements are needed!

vishwansh01 avatar Nov 16 '25 10:11 vishwansh01