Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

✨ 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 #1133

Open
benjagm opened this issue Nov 23, 2024 · 13 comments
Labels
✨ Enhancement Indicates that the issue suggests an improvement or new feature. Status: Available No one has claimed responsibility for resolving this issue.

Comments

@benjagm
Copy link
Collaborator

benjagm commented Nov 23, 2024

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 benjagm added ✨ Enhancement Indicates that the issue suggests an improvement or new feature. Status: Triage This is the initial status for an issue that requires triage. labels Nov 23, 2024
@benjagm benjagm added Status: Available No one has claimed responsibility for resolving this issue. and removed Status: Triage This is the initial status for an issue that requires triage. labels Nov 23, 2024
@benjagm benjagm moved this to Waiting for Contributions in Website Contributor Board Nov 23, 2024
@benjagm
Copy link
Collaborator Author

benjagm commented Nov 23, 2024

What do you think @aialok @DarhkVoyd ?

@github-actions github-actions bot added the Status: Triage This is the initial status for an issue that requires triage. label Nov 23, 2024
@benjagm benjagm removed the Status: Triage This is the initial status for an issue that requires triage. label Nov 23, 2024
@rishabhknowss
Copy link
Contributor

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

@DarhkVoyd
Copy link
Member

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!

@techmannih
Copy link
Contributor

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

@rishabhknowss
Copy link
Contributor

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 !

@techmannih
Copy link
Contributor

@rishabhknowss, can I collaborate with you on this?

@Sahil-Shadwal
Copy link
Contributor

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

@techmannih
Copy link
Contributor

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

@Sahil-Shadwal
Copy link
Contributor

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 ?

@rishabhknowss
Copy link
Contributor

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!!

@techmannih
Copy link
Contributor

techmannih commented Jan 4, 2025

@rishabhknowss I think you can use yalc package

@MadhavDhatrak
Copy link
Contributor

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

untitled-video-made-with-clipchamp-4_2w26SEki.mp4

@MadhavDhatrak
Copy link
Contributor

MadhavDhatrak commented Jan 10, 2025

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
✨ Enhancement Indicates that the issue suggests an improvement or new feature. Status: Available No one has claimed responsibility for resolving this issue.
Projects
Status: Waiting for Contributions
Development

No branches or pull requests

6 participants