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

Add Update structure workflow #12

Merged
merged 13 commits into from
Oct 2, 2024
Merged

Conversation

yashksaini-coder
Copy link
Contributor

This pull request introduces a script to automatically update the repository structure and a corresponding GitHub Actions workflow to run the script periodically. Additionally, it updates the README.md and repo_structure.txt files to reflect the new structure. The most important changes include the addition of the update script, the creation of the workflow, and the updates to the documentation files.

Automation and Scripting:

Workflow Configuration:

Documentation Updates:

  • README.md: Updated the repository structure section to use markers and dynamically insert the structure generated by the script.
  • repo_structure.txt: Updated to reflect the current directory structure of the repository.# Pull Request for PyVerse 💡

Issue Title :

  • Info about the related issue (Aim of the project) :
  • Name: Yash K. Saini
  • GitHub ID: yashksaini-coder
  • Idenitfy yourself: (Mention in which program you are contributing in. Eg. For a WoB 2024 participant it's, WoB Participant) WoB'24 Participant

Closes: #4

Describe the add-ons or changes you've made 📃

  • GitHub actions workflow to update the repo structure as it expands.
  • Runs every hour
  • Updates as new files are added ☑️
Before After
Before Image After Image

What sort of change have you made:

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Code style update (formatting, local variables)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

How Has This Been Tested? ⚙️

Describe how it has been tested

  • Ran in my own branch, till it generated the desired result. Achieved breakthrough after 4 workflow runs.

image

Checklist: ☑️

  • My code follows the guidelines of this project.
  • I have performed a self-review of my own code.
  • I have commented my code, particularly wherever it was hard to understand.
  • I have made corresponding changes to the documentation.
  • My changes generate no new warnings.
  • I have added things that prove my fix is effective or that my feature works.
  • Any dependent changes have been merged and published in downstream modules.

Copy link

github-actions bot commented Oct 1, 2024

👋 Thank you for opening this pull request! We're excited to review your contribution. Please give us a moment, and we'll get back to you shortly!

@github-actions github-actions bot requested a review from UTSAVS26 October 1, 2024 16:56
@yashksaini-coder
Copy link
Contributor Author

yashksaini-coder commented Oct 1, 2024

@UTSAVS26 Review & add label Level3 to this PR. Also add to the issue #4 too.

@UTSAVS26
Copy link
Owner

UTSAVS26 commented Oct 2, 2024

@UTSAVS26 Review & add label Level3 to this PR. Also add to the issue #4 too.

@yashksaini-coder please reorder the project structure like a way in which all the folders come on top with the / at last to show that these are folders and all the single files at last

@yashksaini-coder
Copy link
Contributor Author

@UTSAVS26 As you can see the changes below the project structure is automatically updated after I add a basic Data-science.md This will be the same to all the files that are uploaded inside other folders. Also the workflow is designed to detect any incoming changes or commits & trigger to execute the update-structure.py python script.

It can also reformat the Project structure if a subfolder is also stored inside the main root folders.

Before After
Before Image After Image

@UTSAVS26
Copy link
Owner

UTSAVS26 commented Oct 2, 2024

@yashksaini-coder good work I am changing the level from level1 to level2

@UTSAVS26 UTSAVS26 added Contributor Denotes issues or PRs submitted by contributors to acknowledge their participation. Status: Approved ✔️ PRs that have passed review and are approved for merging. WoB'24 (Winter of Blockchain) Contributions or tasks specific to the Winter of Blockchain 2024 event, focusing on blockchain-relat level2 labels Oct 2, 2024
@yashksaini-coder
Copy link
Contributor Author

@yashksaini-coder good work I am changing the level from level1 to level2

why not level3 ?

@UTSAVS26
Copy link
Owner

UTSAVS26 commented Oct 2, 2024

@yashksaini-coder I will merge your PR after sometime as it showing some error at my side when it is done I will close the pr automatically you can work other issues till then.
Best of Luck 🍀

@yashksaini-coder
Copy link
Contributor Author

@yashksaini-coder I will merge your PR after sometime as it showing some error at my side when it is done I will close the pr automatically you can work other issues till then. Best of Luck 🍀

oh also you need to create a github token and add it in the secrets. It gives the script access to the root dir

@UTSAVS26
Copy link
Owner

UTSAVS26 commented Oct 2, 2024

@yashksaini-coder I will merge your PR after sometime as it showing some error at my side when it is done I will close the pr automatically you can work other issues till then. Best of Luck 🍀

oh also you need to create a github token and add it in the secrets. It gives the script access to the root dir

I will look into it thanks for the advice.

@yashksaini-coder
Copy link
Contributor Author

There are no conflicts showing with the main branch. so everything will be all good. 👍🏼

I think this issue could use level3

@UTSAVS26
Copy link
Owner

UTSAVS26 commented Oct 2, 2024

There are no conflicts showing with the main branch. so everything will be all good. 👍🏼

I think this issue could use level3

I will check it once then update the level otherwise it definitely covers level2

@yashksaini-coder
Copy link
Contributor Author

There are no conflicts showing with the main branch. so everything will be all good. 👍🏼
I think this issue could use level3

I will check it once then update the level otherwise it definitely covers level2

while you are at it, can you add hacktoberfest-accepted label

@UTSAVS26
Copy link
Owner

UTSAVS26 commented Oct 2, 2024

There are no conflicts showing with the main branch. so everything will be all good. 👍🏼
I think this issue could use level3

I will check it once then update the level otherwise it definitely covers level2

while you are at it, can you add hacktoberfest-accepted label

We are given strict guidelines to only add hacktoberfest-accepted labels for only GSSOC'24-Extd. Contributors. Sorry for your trouble

@yashksaini-coder
Copy link
Contributor Author

There are no conflicts showing with the main branch. so everything will be all good. 👍🏼
I think this issue could use level3

I will check it once then update the level otherwise it definitely covers level2

while you are at it, can you add hacktoberfest-accepted label

We are given strict guidelines to only add hacktoberfest-accepted labels for only GSSOC'24-Extd. Contributors. Sorry for your trouble

okh

@UTSAVS26 UTSAVS26 merged commit 908d0f7 into UTSAVS26:main Oct 2, 2024
@yashksaini-coder yashksaini-coder deleted the yash/fix-4 branch October 20, 2024 06:33
@yashksaini-coder
Copy link
Contributor Author

@UTSAVS26 can you add gssoc label in this PR & assign it to me.

@yashksaini-coder
Copy link
Contributor Author

hi @UTSAVS26 can you add gssoc & hacktoberfest labels on this PR, and assign it to me

@UTSAVS26
Copy link
Owner

@yashksaini-coder let me ask program manager if it is possible.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Contributor Denotes issues or PRs submitted by contributors to acknowledge their participation. level2 Status: Approved ✔️ PRs that have passed review and are approved for merging. WoB'24 (Winter of Blockchain) Contributions or tasks specific to the Winter of Blockchain 2024 event, focusing on blockchain-relat
Projects
None yet
Development

Successfully merging this pull request may close these issues.

📃: Adding Workflows to Update Directory Structure in Real Time
2 participants