You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
A [Windows Forms](https://github.com/dotnet/winforms) application, built using [VS Community 2022](https://visualstudio.microsoft.com/vs/community/) for Windows 7+. The purpose of this app is to notify the user through a notification when their [Github Page](https://pages.github.com/)'s build and deployment checks have passed since the last push, indicating it has been updated server-side.
4
-
Not affiliated with Github.
5
-
<br><br><br>
1
+
# GitHub Pages Deploy Monitor
2
+
3
+
A [Windows Forms](https://github.com/dotnet/winforms) application, built using [VS Community 2022](https://visualstudio.microsoft.com/vs/community/) for Windows 10+. The purpose of this app is to notify the user through a notification when their [Github Page](https://pages.github.com/)'s build and deployment checks have passed since the last push, indicating it has been updated server-side.
4
+
Not affiliated with Github.
6
5
7
6
## Installation
8
7
@@ -12,5 +11,42 @@ Not affiliated with Github.
12
11
13
12
## Usage
14
13
15
-
- Enter the directory of the repository that you want to monitor in the first box, in the format `owner/repo`.
16
-
- If you want to, you may enter your own Github
14
+
### Choosing repository to monitor
15
+
Enter the directory of the Github Page repository that you want to monitor in the first box, in the format of `owner/repo`.
16
+
17
+
### API Key
18
+
- Not using a personal API key will only allow 60 requests per hour, so a higher check interval or API key is recommended. You will not be able to monitor a private repository without an API key.
19
+
- To generate and use an API key with the correct scopes, you may follow these instructions:
20
+
1. Go to https://github.com/settings/personal-access-tokens/new?type=fine-grained.
21
+
2. Choose any name, such as `Github Pages Deploy Monitor`.
22
+
3. If you are planning to monitor a public repository, choose `Public repositories` under `Repository access`.
23
+
4. If you are planning to monitor a private repo, choose `Only select repositories` under `Repository access`. Then select `Read-only` for `Contents` in `Repository permissions`.
24
+
5. Generate the API key and paste it in the settings.
25
+
26
+
### Ignoring commits by certain authors
27
+
If you wish to not monitor commits made by a certain author, add a text that is contained in the authors name. For example, if you wish to ignore commits made by [Dependabot](https://github.com/dependabot), you may add `bot` to the list.
28
+
29
+
### Adjusting check interval
30
+
The check interval sets how many milliseconds pass between checking for a new push and how many milliseconds pass between waiting for checks to complete. A higher check interval is recommended if not using an API key, as only 60 requests are allowed per hour. The default value is 3000 milliseconds.
31
+
32
+
## How the UI and notifications look like
33
+
34
+
<table>
35
+
<tr>
36
+
<td align="center" width=1000>
37
+
<img src="/assets/UI.png"/>
38
+
</td>
39
+
<td align="center" width=1000>
40
+
<img src="/assets/PushDetected.png"/>
41
+
<img src="/assets/PageUpdated.png"/>
42
+
</td>
43
+
</tr>
44
+
</table>
45
+
46
+
## To-do list
47
+
- Change Add/remove program version to 1.0.0-beta instead of 1.0.0
48
+
- Exit program instead of starting to monitor when closing the settings via the X.
49
+
50
+
### About me
51
+
52
+
This is my first Windows application, my first time using Windows Forms, and my first time using Visual Studio. I've leaked my own API keys while testing it a few times, so I really am an amateur. (Don't worry, I've disabled them now) If I have structured something wrong, please correct me, as I was never taught how to share Visual Studio projects on Github, and just created a new repo in my project's files folder.
0 commit comments