Skip to content

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

@J-B-Mugundh

Description

@J-B-Mugundh

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

Explanation

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 or in a different file.

Preview Screenshots

image

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions