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
Copy file name to clipboardExpand all lines: README.md
+48Lines changed: 48 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,6 +3,7 @@
3
3
# Purpose
4
4
5
5
This bot exists to automate the development process/workflow for
6
+
<<<<<<< HEAD
6
7
https://github.com/microsoft/vscode-python. It also acts as a simple demo of a
7
8
GitHub bot running on Azure.
8
9
@@ -20,6 +21,23 @@ Currently the bot will do the following things for you:
20
21
21
22
1. Add/remove the `classify` label based on whether any other status label is
22
23
set.
24
+
=======
25
+
https://github.com/microsoft/vscode-python. It also acts as a simple demo of
26
+
a GitHub bot running on Azure.
27
+
28
+
This bot is what is known as an OAuth app and is not a GitHub app. The
29
+
[differences](https://developer.github.com/apps/differences-between-apps/) come
30
+
down to simplicity in authentication and how widely can the bot be deployed. Since
31
+
this bot is only deployed for a single repository and the original author was
32
+
intimately familiar with OAuth apps that was the route taken.
33
+
34
+
This bot also predates [GitHub Actions](https://developer.github.com/actions/)
35
+
being released. As such some things this bot does may be easier to do as an action.
36
+
37
+
Currently the bot will do the following things for you:
38
+
39
+
1. Add/remove the `classify` label based on whether any other status label is set.
40
+
>>>>>>> upstream/master
23
41
1. When an issue is closed, remove any status-related labels, e.g. `needs PR`
24
42
(with the idea that if an issue is re-opened then it needs to be re-evaluated
25
43
as to why the issue is still open).
@@ -32,6 +50,7 @@ Currently the bot will do the following things for you:
32
50
33
51
You must set two environment variables for the bot to function:
34
52
53
+
<<<<<<< HEAD
35
54
1.`GH_SECRET`:
36
55
[secret between GitHub and your bot](https://developer.github.com/webhooks/securing/#setting-your-secret-token).
37
56
1.`GH_AUTH`:
@@ -50,6 +69,21 @@ The
50
69
is to empower your bot to make changes to your repo on your behalf. You can use
51
70
a token from your personal GitHub account or create a fake bot account. Make
52
71
sure the token has the following scopes/permissions:
72
+
=======
73
+
1.`GH_SECRET`: [secret between GitHub and your bot](https://developer.github.com/webhooks/securing/#setting-your-secret-token).
74
+
1.`GH_AUTH`: [Auth token](https://help.github.com/en/articles/creating-a-personal-access-token-for-the-command-line) for the bot to make changes in your repo.
75
+
76
+
The [shared secret](https://developer.github.com/webhooks/securing/#setting-your-secret-token)
77
+
between GitHub and your bot is used to verify that the webhook payload actually
78
+
originated from GitHub for your repository and isn't malicious. This is important
79
+
as a malicious user could send fake webhook payloads to your bot and cause it to
80
+
make changes on the malicious user's behalf.
81
+
82
+
The [personal access token](https://help.github.com/en/articles/creating-a-personal-access-token-for-the-command-line)
83
+
is to empower your bot to make changes to your repo on your behalf. You can use
84
+
a token from your personal GitHub account or create a fake bot account. Make sure
85
+
the token has the following scopes/permissions:
86
+
>>>>>>> upstream/master
53
87
54
88
1.`repo:public_repo` (if your repo is public; adjust accordingly for your needs)
55
89
@@ -69,6 +103,7 @@ running on Python 3.7.
69
103
70
104
# Contributing
71
105
106
+
<<<<<<< HEAD
72
107
This project welcomes contributions and suggestions. Most contributions require
73
108
you to agree to a Contributor License Agreement (CLA) declaring that you have
74
109
the right to, and actually do, grant us the rights to use your contribution. For
@@ -85,3 +120,16 @@ For more information see the
85
120
[Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or
86
121
contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any
87
122
additional questions or comments.
123
+
=======
124
+
This project welcomes contributions and suggestions. Most contributions require you to agree to a
125
+
Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us
126
+
the rights to use your contribution. For details, visit https://cla.microsoft.com.
127
+
128
+
When you submit a pull request, a CLA-bot will automatically determine whether you need to provide
129
+
a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions
130
+
provided by the bot. You will only need to do this once across all repos using our CLA.
131
+
132
+
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
133
+
For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or
134
+
contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.
Microsoft takes the security of our software products and services seriously, which includes all source code repositories managed through our GitHub organizations, which include [Microsoft](https://github.com/Microsoft), [Azure](https://github.com/Azure), [DotNet](https://github.com/dotnet), [AspNet](https://github.com/aspnet), [Xamarin](https://github.com/xamarin), and [our GitHub organizations](https://opensource.microsoft.com/).
6
+
7
+
If you believe you have found a security vulnerability in any Microsoft-owned repository that meets Microsoft's [Microsoft's definition of a security vulnerability](https://docs.microsoft.com/en-us/previous-versions/tn-archive/cc751383(v=technet.10)) of a security vulnerability, please report it to us as described below.
8
+
9
+
## Reporting Security Issues
10
+
11
+
**Please do not report security vulnerabilities through public GitHub issues.**
12
+
13
+
Instead, please report them to the Microsoft Security Response Center (MSRC) at [https://msrc.microsoft.com/create-report](https://msrc.microsoft.com/create-report).
14
+
15
+
If you prefer to submit without logging in, send email to [secure@microsoft.com](mailto:secure@microsoft.com). If possible, encrypt your message with our PGP key; please download it from the the [Microsoft Security Response Center PGP Key page](https://www.microsoft.com/en-us/msrc/pgp-key-msrc).
16
+
17
+
You should receive a response within 24 hours. If for some reason you do not, please follow up via email to ensure we received your original message. Additional information can be found at [microsoft.com/msrc](https://www.microsoft.com/msrc).
18
+
19
+
Please include the requested information listed below (as much as you can provide) to help us better understand the nature and scope of the possible issue:
20
+
21
+
* Type of issue (e.g. buffer overflow, SQL injection, cross-site scripting, etc.)
22
+
* Full paths of source file(s) related to the manifestation of the issue
23
+
* The location of the affected source code (tag/branch/commit or direct URL)
24
+
* Any special configuration required to reproduce the issue
25
+
* Step-by-step instructions to reproduce the issue
26
+
* Proof-of-concept or exploit code (if possible)
27
+
* Impact of the issue, including how an attacker might exploit the issue
28
+
29
+
This information will help us triage your report more quickly.
30
+
31
+
If you are reporting for a bug bounty, more complete reports can contribute to a higher bounty award. Please visit our [Microsoft Bug Bounty Program](https://microsoft.com/msrc/bounty) page for more details about our active programs.
32
+
33
+
## Preferred Languages
34
+
35
+
We prefer all communications to be in English.
36
+
37
+
## Policy
38
+
39
+
Microsoft follows the principle of [Coordinated Vulnerability Disclosure](https://www.microsoft.com/en-us/msrc/cvd).
0 commit comments