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

[FEATURE]Automated project structure updation using github workflows, python scripts and action bot #152

Closed
1 task done
J-B-Mugundh opened this issue Oct 20, 2024 · 5 comments · Fixed by #162
Closed
1 task done
Assignees
Labels
enhancement New feature or request gssoc-ext GSSoC'24 Extended Version hacktoberfest Hacktober Collaboration hacktoberfest-accepted Hacktoberfest 2024 level2 25 Points 🥈(GSSoC)

Comments

@J-B-Mugundh
Copy link
Contributor

Is this a unique feature?

  • I have checked "open" AND "closed" issues and this is not a duplicate

Is your feature request related to a problem/unavailable functionality? Please describe.

Currently, we dont have the automated project structure updation in our repository. It'll be benefitial for the new commers to understand the project structure from readme itself and reduces the manual work as well.

Proposed Solution

Automated project structure updation using github workflows, python scripts and action bot

Screenshots

image

Do you want to work on this issue?

Yes

If "yes" to above, please explain how you would technically implement this (issue will not be assigned if this is skipped)

I can work by creating a workflow in .github/workflow and necessary script in .github/scripts and integrate with action bot.

@J-B-Mugundh J-B-Mugundh added the enhancement New feature or request label Oct 20, 2024
Copy link
Contributor

Ensure the issue is not similar or previously being worked on.Thanks for your time

@jvedsaqib
Copy link
Collaborator

Hi @J-B-Mugundh can you tell me how you are planning to execute this?

@J-B-Mugundh
Copy link
Contributor Author

Hi @J-B-Mugundh can you tell me how you are planning to execute this?

The project structure automation process enhances repository organization and accessibility for contributors by leveraging GitHub Actions and a Python script.

Script Development: A Python script is created to traverse the repository’s file system, generating a visual representation of the project structure. This script outputs the structure to a file (e.g., repo_structure.txt).

GitHub Workflow Setup: A GitHub Actions workflow is configured to automate the script execution based on specified triggers, such as scheduled intervals or repository changes.

Execution Flow:

The workflow checks out the repository.
It sets up the Python environment and installs any necessary dependencies.
The script runs, updating the project structure file as needed.
If changes are detected, the workflow commits and pushes these updates back to the repository.

Documentation Update: The workflow the updates the project structure in readme.

@jvedsaqib
Copy link
Collaborator

Hi @J-B-Mugundh can you tell me how you are planning to execute this?

The project structure automation process enhances repository organization and accessibility for contributors by leveraging GitHub Actions and a Python script.

Script Development: A Python script is created to traverse the repository’s file system, generating a visual representation of the project structure. This script outputs the structure to a file (e.g., repo_structure.txt).

GitHub Workflow Setup: A GitHub Actions workflow is configured to automate the script execution based on specified triggers, such as scheduled intervals or repository changes.

Execution Flow:

The workflow checks out the repository. It sets up the Python environment and installs any necessary dependencies. The script runs, updating the project structure file as needed. If changes are detected, the workflow commits and pushes these updates back to the repository.

Documentation Update: The workflow the updates the project structure in readme.

Instead of updating the readme, can you do it in a separate markdown file?

@J-B-Mugundh
Copy link
Contributor Author

Hi @J-B-Mugundh can you tell me how you are planning to execute this?

The project structure automation process enhances repository organization and accessibility for contributors by leveraging GitHub Actions and a Python script.
Script Development: A Python script is created to traverse the repository’s file system, generating a visual representation of the project structure. This script outputs the structure to a file (e.g., repo_structure.txt).
GitHub Workflow Setup: A GitHub Actions workflow is configured to automate the script execution based on specified triggers, such as scheduled intervals or repository changes.
Execution Flow:
The workflow checks out the repository. It sets up the Python environment and installs any necessary dependencies. The script runs, updating the project structure file as needed. If changes are detected, the workflow commits and pushes these updates back to the repository.
Documentation Update: The workflow the updates the project structure in readme.

Instead of updating the readme, can you do it in a separate markdown file?

Yeah sure! I could do that

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request gssoc-ext GSSoC'24 Extended Version hacktoberfest Hacktober Collaboration hacktoberfest-accepted Hacktoberfest 2024 level2 25 Points 🥈(GSSoC)
Projects
None yet
3 participants