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

Automated of project structure updation using GitHub workflows and Python scripts #203

Merged
merged 9 commits into from
Oct 30, 2024

Conversation

rajdeepchakraborty-rc
Copy link
Contributor

Issue Resolved:

Description

I have added the Project Repository in a new file named PROJECT_STRUCTURE.md :
image
image
image
image

I have automated the updation of the Project Structure using GitHub workflows and Python scripts. The Project Structure will update when you push any changes to the main branch

I have also added a redirect to the file in the README.md file:
image

Copy link

vercel bot commented Oct 30, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
chaos-web ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 30, 2024 5:52pm

Copy link
Contributor

Thank you for submitting your chaotic pull request! 🙌 We'll review it as soon as possible. In the meantime, please ensure that your changes align with our chaotic CONTRIBUTING.md. If there are any specific instructions or feedback regarding your PR, we'll provide them here. Thanks again for your contribution! 😊

Copy link
Contributor

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👋 Welcome, @rajdeepchakraborty-rc! Thank you for your first pull request to ChaosWeb! We’re excited to see how you’ve contributed to the madness. 🎉 Our team will review your chaotic creation soon. Keep the disorder coming! 🚀

Copy link
Contributor

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🎉 Thanks @rajdeepchakraborty-rc! Your pull request has added more chaos to ChaosWeb. We’ll review it shortly. Keep breaking the rules! 🚀

@rajdeepchakraborty-rc
Copy link
Contributor Author

I hope this helps in making the project more readable and scalable to the users. I would appreciate it if this could be assigned level3 level since I have automated the entire updation process.

@vansh-codes
Copy link
Owner

gh_token = os.getenv('GH_TOKEN')
gh_repo = os.getenv('GITHUB_REPOSITORY')

Do I have to create any personal access tokens?
I can see it in your code

also whats the difference between repo_structure and project_structure

@rajdeepchakraborty-rc
Copy link
Contributor Author

gh_token = os.getenv('GH_TOKEN')
gh_repo = os.getenv('GITHUB_REPOSITORY')

Do I have to create any personal access tokens? I can see it in your code

also whats the difference between repo_structure and project_structure

You don't have to make any personalized tokens.
Also repo_structure is a text file where I have used python file handling to create the repository structure first and then the project_structure.md file is to add the headings and other stuff(HTML markdown structure) to make it look good and accessible.

@rajdeepchakraborty-rc
Copy link
Contributor Author

@vansh-codes Check the commit history, I have already tested it once and I have not changed any tokens. It will work as long as the Github Actions bot has write permissions which I have provided:

permissions:
      contents: write   # Permission to the GitHub Bot to access and update the Project Repository

This was creating an issue previously and I debugged it.

@vansh-codes
Copy link
Owner

why is repo_structure is needed?

@rajdeepchakraborty-rc
Copy link
Contributor Author

rajdeepchakraborty-rc commented Oct 30, 2024

why is repo_structure is needed?

repo_structure is a .txt(text) file and the python code was not working earlier on the project_structure [.md(Markdown)] file. The python code is first updating the code in the text file and then the applying the changes into the project_structure file.

@rajdeepchakraborty-rc
Copy link
Contributor Author

@vansh-codes Have I answered your query?

@vansh-codes
Copy link
Owner

Okay got it @rajdeepchakraborty-rc

Copy link
Owner

@vansh-codes vansh-codes left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good job! Keep up the good work

@vansh-codes vansh-codes added documentation Improvements or additions to documentation gssoc-ext GSSOC'24 Extd Participant level3 awards 45 points hacktoberfest-accepted hacktoberfest accepted chaos Chaotic update labels Oct 30, 2024
@vansh-codes
Copy link
Owner

Rewarded level3 for your good work, documentation and such things has to be level2 but you did a goodjob thats why i am giving you level3 on this

@vansh-codes
Copy link
Owner

Gityzer

Please create same issue for this project also

@vansh-codes vansh-codes merged commit 6efce56 into vansh-codes:main Oct 30, 2024
5 checks passed
@rajdeepchakraborty-rc
Copy link
Contributor Author

Gityzer

Please create same issue for this project also

@vansh-codes I will do it by tomorrow and let you know. It is late night for me today and I am signing off for today.

@rajdeepchakraborty-rc
Copy link
Contributor Author

Rewarded level3 for your good work, documentation and such things has to be level2 but you did a goodjob thats why i am giving you level3 on this

Thanks for the appreciation. I am glad that this feature is helpful to people.

@rajdeepchakraborty-rc
Copy link
Contributor Author

@vansh-codes I have opened the issue at:
vansh-codes/Gityzer#71
You can assign it to me. I will complete the work by tomorrow.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
chaos Chaotic update documentation Improvements or additions to documentation gssoc-ext GSSOC'24 Extd Participant hacktoberfest-accepted hacktoberfest accepted level3 awards 45 points
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Chaotic Feat: Automation of project structure updation using GitHub workflows and Python scripts
2 participants