forked from sahil-sagwekar2652/GitHub-Automation-scripts
-
Notifications
You must be signed in to change notification settings - Fork 0
/
index.html
233 lines (211 loc) · 13.6 KB
/
index.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<link href="https://cdn.jsdelivr.net/npm/tailwindcss@2.2.17/dist/tailwind.min.css" rel="stylesheet">
<script defer src="https://use.fontawesome.com/releases/v6.2.1/js/all.js"></script>
<link href="css/style.css" rel="stylesheet">
<link rel="stylesheet" href="./css/contributors.css">
<title>GitHub Automation Scripts 🤖</title>
<style>
</style>
</head>
<body class="bg-gray-100">
<nav class="navbar">
<input type="checkbox" id="check">
<label for="check" class="checkbtn">
<i class="fas fa-bars"></i>
</label>
<label class="logo"><a href="https://github.com/sahil-sagwekar2652/GitHub-Automation-scripts">GitHub Automation Scripts 🤖</a></label>
<ul>
<li><a href="#about">About</a></li>
<li><a href="#contribute">Contribute</a></li>
<li><a href="#install">Installation</a></li>
<li><a href="#contributor">Contributors</a></li>
<li><a href="#contact">Contact</a></li>
</ul>
</nav>
<section class="h-screen bg-blue-900 flex items-center justify-center">
<div class="Viewcontainer mx-auto flex flex-wrap flex-col md:flex-row space-x-0 md:space-x-8">
<div class="mb-6 md:mb-0">
<img src="graphics/back.jpg" alt="Image Description" class="w-64 h-64 object-cover">
</div>
<div>
<h2 class="text-4xl text-white font-bold mb-4">About GitHub Automation Scripts</h2>
<p class="text-lg w-80 mb-6 text-gray-300">Bash and Python scripts to automate your Git & GitHub workflow. Made by using only standard python libraries.</p>
<div class="mt-8 md:mt-0 bg-gradient-to-r from-blue-600 to-purple-600 rounded-lg p-4 border-2 border-gray-300 inline-block">
<h2 class="text-xl text-white font-semibold mb-4">Tech Stack</h2>
<div class="flex flex-wrap">
<img src="https://skillicons.dev/icons?i=py" alt="Python" class="h-12 w-12 mx-2 icon">
<img src="https://skillicons.dev/icons?i=bash" alt="Bash" class="h-12 w-12 mx-2 icon">
<img src="https://skillicons.dev/icons?i=git" alt="Git" class="h-12 w-12 mx-2 icon">
<img src="https://skillicons.dev/icons?i=github" alt="GitHub" class="h-12 w-12 mx-2 icon">
</div>
</div>
</div>
</div>
</section>
<div class="desc-container mx-auto px-4" id="about">
<div class="description-section">
<div class="image-container">
<img src="graphics/repo.jpg" alt="gitrepo-Floating-Image">
</div>
<div class="content-container">
<h2 class="title">GitHub Automation Scripts 🤖</h2>
<p class="description">All types of contributions are encouraged and valued. See the Table of Contents for different ways to help and details about how this project handles them. Please make sure to read the relevant section before making your contribution. It will make it a lot easier for us maintainers and smooth out the experience for all involved. The community looks forward to your contributions. 🎉</p>
<a class="fg-black" href="https://github.com/sahil-sagwekar2652/GitHub-Automation-scripts" target="_blank" rel="noopener noreferrer">
<i class="fg-black fab fa-github"></i>
GitHub
</a>
</div>
</div>
</div>
<div class="container mx-auto px-4 py-8" id="contribute">
<div class="contribute-guide">
<h1 class="text-2xl font-semibold">Contributing to GitHub-Automation-Scripts</h1>
<p class="mt-4">First off, thanks for taking the time to contribute! ❤️</p>
<p>All types of contributions are encouraged and valued. See the <a href="#table-of-contents" class="link">Table of Contents</a> for different ways to help and details about how this project handles them. Please make sure to read the relevant section before making your contribution. It will make it a lot easier for us maintainers and smooth out the experience for all involved. The community looks forward to your contributions. 🎉</p>
<blockquote class="mt-4">
<p class="mb-2">And if you like the project, but just don't have time to contribute, that's fine. There are other easy ways to support the project and show your appreciation, which we would also be very happy about:</p>
<ul class="list-disc list-inside">
<li>Star the project</li>
<li>Tweet about it</li>
</ul>
</blockquote>
<h2 class="text-xl font-semibold mt-8">Table of Contents</h2>
<ul class="list-disc list-inside">
<li><a href="#asking-questions" class="link">Asking Questions</a></li>
<li><a href="#how-to-contribute" class="link">How To Contribute</a></li>
<li><a href="#styleguides" class="link">Styleguides</a></li>
</ul>
<h2 id="asking-questions" class="text-xl font-semibold mt-8">Asking Questions</h2>
<p>If you want to ask a question, join the 'GitHub Automation scripts' project channel on the GSSoC discord server. To join the project channel, make sure you have the 'GitHub Automation scripts' & 'Contributor' role assigned to you. If you don't have the role assigned to you, you can self-assign it in the <a href="https://discord.com/channels/1099745007172329592/1099745007675646046" class="link">#self-roles</a> channel.</p>
<p>Before you ask a question, it is best to search for existing <a href="https://github.com/sahil-sagwekar2652/GitHub-Automation-scripts.git/issues" class="link">Issues</a> that might help you. It is also advisable to search the internet for answers first.</p>
<p>If you then still feel the need to ask a question and need clarification, we recommend the following:</p>
<ul class="list-disc list-inside">
<li>Provide as much context as you can about what you're running into.</li>
<li>Provide details about your OS and environment.</li>
</ul>
<h2 id="how-to-contribute" class="text-xl font-semibold mt-8">How To Contribute</h2>
<ul class="list-disc list-inside">
<li>Fork the project on GitHub, clone it on your PC.</li>
<li>If you have an idea for an enhancement or a bug, you can first check the <a href="https://github.com/sahil-sagwekar2652/GitHub-Automation-scripts.git/issues" class="link">Issues</a> to see if your question has been asked before.</li>
<li>If you'd like to work on an issue, please ask the creator of the issue to assign it to you. This helps to keep the workflow streamlined.</li>
<li>Create a new branch for your contribution and make the changes you want to make. (Always check for updates on the main branch before creating a pull request to avoid merge conflicts.)</li>
<li>The pull request should mention the issue it is trying to solve and should be linked to it. Here is a video on how to link PRs to issues - <a href="https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword" class="link">video link</a>.</li>
<li>Make sure to make the appropriate changes in the README.md file if you are adding a new script or feature.</li>
</ul>
<h2 id="styleguides" class="text-xl font-semibold mt-8">Styleguides</h2>
<p>This project uses the Flake8 linter to lint the Python code. If you are using VSCode, I would suggest installing the <a href="https://marketplace.visualstudio.com/items?itemName=ms-python.flake8" class="link">Flake8 linter extension</a> for VSCode.</p>
</div>
</div>
</body>
</html>
<main class="container mx-auto px-4 py-8" id="install">
<nav class="mb-8 flex justify-center items-center">
<div class="inline-flex border border-gray-300 rounded">
<button class="py-2 px-4 bg-gray-200 font-semibold focus:outline-none active:bg-gray-300" onclick="openTab(event, 'installation')">Installation</button>
<button class="py-2 px-4 bg-gray-200 font-semibold focus:outline-none active:bg-gray-300" onclick="openTab(event, 'how-to-use')">How to Use</button>
<button class="py-2 px-4 bg-gray-200 rounded-r font-semibold focus:outline-none active:bg-gray-300" onclick="openTab(event, 'license')">License</button>
</div>
</nav>
<div id="installation" class="tab-content active">
<h1 class="text-xl font-semibold mb-4">Installation</h1>
<p class="mb-2">Requirements:</p>
<ul class="list-disc list-inside mb-4">
<li><a href="https://git-scm.com/downloads" class="text-blue-500 hover:underline">Git Bash</a> installed on your computer.</li>
<li>GitHub personal access token. (Go to your GitHub profile -> Settings -> Developer settings -> Personal Access Tokens -> Create new token with all the repository permissions)</li>
</ul>
<p class="mb-2">Note: This script is written exclusively for Git Bash on Windows. You will have to modify it for other shells.</p>
<ol class="list-decimal list-inside">
<li>
<p>Fork and clone the repository locally.</p>
</li>
<li>
<p>Create a <code>github_secrets.py</code> file in the <code>./scripts</code> folder and define the following variables inside it:</p>
<pre class="bg-gray-100 p-4 mt-2"><code class="text-sm text-gray-600">GITHUB_API_TOKEN = "Your GitHub personal access token"
USERNAME = "Your GitHub username"</code></pre>
</li>
<li>
<p>Add the project path to the PATH variable (Recommended):</p>
<pre class="bg-gray-100 p-4 mt-2"><code class="text-sm text-gray-600">$ export PATH=$PATH":"$(pwd)"/scripts"</code></pre>
<p class="mt-2">To permanently add the scripts path to the PATH variable, run the below command in the project's root directory. (This file is located in your home directory)</p>
<pre class="bg-gray-100 p-4 mt-2"><code class="text-sm text-gray-600">$ echo 'export PATH=$PATH''":'"$(pwd)"'/scripts''"' >> ~/.bash_profile</code></pre>
</li>
<li>
<p>OR</p>
<p class="mt-2">Run the following commands in the project folder to add the scripts to your bin directory:</p>
<pre class="bg-gray-100 p-4 mt-2"><code class="text-sm text-gray-600">$ cp -r /scripts/* /usr/bin/</code></pre>
</li>
</ol>
</div>
<div id="how-to-use" class="hidden tab-content">
<h1 class="text-xl font-semibold mb-4">How to Use</h1>
<pre class="bg-gray-100 p-4 mt-2">
<code class="text-sm text-gray-600">create_repo -h</code>
</pre>
<p>Sample usage:</p>
<pre class="bg-gray-100 p-4 mt-2">
<code class="text-sm text-gray-600">create_repo <PATH_NAME> <REPO_NAME></code>
</pre>
<p><PATH_NAME> is the path where you want to create the local repository and <REPO_NAME> is the name for your repo</p>
<p>Example:</p>
<pre class="bg-gray-100 p-4 mt-2">
<code class="text-sm text-gray-600">create_repo . test-repo</code>
</pre>
</div>
<div id="license" class="hidden tab-content">
<h1 class="text-xl font-semibold mb-4">License</h1>
<pre class="bg-gray-100 p-4 mt-2 rounded">
<code class="text-sm text-gray-600">
MIT License
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
</code>
</pre>
</div>
</main>
<div class="contributors">
<h1>Our Valuable Contributors</h1>
<div id="contributor"></div>
</div>
<footer class="py-4" id="contact">
<div class="container mx-auto px-4 footer-content">
<h3>GITHUB AUTOMATION SCRIPTS 🤖</h3>
<p>Bash and Python scripts to automate your Git & GitHub workflow. Made by using only standard python libraries.</p>
</div>
<ul class="socials">
<li><a class="tweet" href="https://twitter.com/sagwekar_sahil"><i class="fa-brands fa-twitter"></i></a></li>
<li><a class="mail" href="malito: sahilss2652@gmail.com"><i class="fa-solid fa-envelope"></i></a></li>
<li><a class="youtube" href="https://www.youtube.com/@SahilSagwekar"><i class="fa-brands fa-youtube"></i></a></li>
<li><a class="in" href="https://www.linkedin.com/in/sahil-sagwekar-0b955b223/"><i class="fa-brands fa-linkedin"></i></a></li>
<li><a class="git" href="https://github.com/sahil-sagwekar2652"><i class="fa-brands fa-github"></i></a></li>
</ul>
<div class="footer-bottom">
<p class="text-sm">© 2023 GitHub Automation Scripts 🤖. All rights reserved.</p>
</div>
</footer>
<div id="scroll">
<span id="scroll-bar">🠕</span>
<span class="pulse"></span>
</div>
</div>
<script src="js/scripts.js"></script>
<script src="./js/contributors.js"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.0.0-beta3/js/all.min.js"></script>
</body>
</html>