Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

Commit12ee1c7

Browse files
authored
Merge pull request#4 from github/tarebyte/prepare-for-open-source
Prepare project for open source contributions
2 parents7229e12 +0260d00 commit12ee1c7

File tree

11 files changed

+2993
-171
lines changed

11 files changed

+2993
-171
lines changed

‎.github/workflows/linting.yml‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
name:Linting
2+
3+
on:
4+
push:
5+
branches:[ $default-branch ]
6+
pull_request:
7+
branches:[ $default-branch ]
8+
9+
jobs:
10+
build:
11+
runs-on:ubuntu-latest
12+
steps:
13+
-uses:actions/checkout@v3
14+
-uses:actions/setup-node@v3
15+
with:
16+
node-version:18
17+
cache:'npm'
18+
-run:npm run lint

‎CODEOWNERS‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
*@github/ecosystem-apps-reviewers

‎CODE_OF_CONDUCT.md‎

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
#Contributor Covenant Code of Conduct
2+
3+
##Our Pledge
4+
5+
In the interest of fostering an open and welcoming environment, we as
6+
contributors and maintainers pledge to making participation in our project and
7+
our community a harassment-free experience for everyone, regardless of age, body
8+
size, disability, ethnicity, gender identity and expression, level of experience,
9+
nationality, personal appearance, race, religion, or sexual identity and
10+
orientation.
11+
12+
##Our Standards
13+
14+
Examples of behavior that contributes to creating a positive environment
15+
include:
16+
17+
* Using welcoming and inclusive language
18+
* Being respectful of differing viewpoints and experiences
19+
* Gracefully accepting constructive criticism
20+
* Focusing on what is best for the community
21+
* Showing empathy towards other community members
22+
23+
Examples of unacceptable behavior by participants include:
24+
25+
* The use of sexualized language or imagery and unwelcome sexual attention or
26+
advances
27+
* Trolling, insulting/derogatory comments, and personal or political attacks
28+
* Public or private harassment
29+
* Publishing others' private information, such as a physical or electronic
30+
address, without explicit permission
31+
* Other conduct which could reasonably be considered inappropriate in a
32+
professional setting
33+
34+
##Our Responsibilities
35+
36+
Project maintainers are responsible for clarifying the standards of acceptable
37+
behavior and are expected to take appropriate and fair corrective action in
38+
response to any instances of unacceptable behavior.
39+
40+
Project maintainers have the right and responsibility to remove, edit, or
41+
reject comments, commits, code, wiki edits, issues, and other contributions
42+
that are not aligned to this Code of Conduct, or to ban temporarily or
43+
permanently any contributor for other behaviors that they deem inappropriate,
44+
threatening, offensive, or harmful.
45+
46+
##Scope
47+
48+
This Code of Conduct applies both within project spaces and in public spaces
49+
when an individual is representing the project or its community. Examples of
50+
representing a project or community include using an official project e-mail
51+
address, posting via an official social media account, or acting as an appointed
52+
representative at an online or offline event. Representation of a project may be
53+
further defined and clarified by project maintainers.
54+
55+
##Enforcement
56+
57+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
58+
reported by contacting the project team atopensource@github.com. All
59+
complaints will be reviewed and investigated and will result in a response that
60+
is deemed necessary and appropriate to the circumstances. The project team is
61+
obligated to maintain confidentiality with regard to the reporter of an incident.
62+
Further details of specific enforcement policies may be posted separately.
63+
64+
Project maintainers who do not follow or enforce the Code of Conduct in good
65+
faith may face temporary or permanent repercussions as determined by other
66+
members of the project's leadership.
67+
68+
##Attribution
69+
70+
This Code of Conduct is adapted from the[Contributor Covenant][homepage], version 1.4,
71+
available at[http://contributor-covenant.org/version/1/4][version]
72+
73+
[homepage]:http://contributor-covenant.org
74+
[version]:http://contributor-covenant.org/version/1/4/

‎CONTRIBUTING.md‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
##Contributing
2+
3+
[fork]:https://github.com/github/github-app-js-sample/fork
4+
[pr]:https://github.com/github/github-app-js-sample/compare
5+
[style]:https://standardjs.com/rules.html
6+
[code-of-conduct]:CODE_OF_CONDUCT.md
7+
8+
Hi there! We're thrilled that you'd like to contribute to this project. Your help is essential for keeping it great.
9+
10+
Contributions to this project are[released](https://help.github.com/articles/github-terms-of-service/#6-contributions-under-repository-license) to the public under the[project's open source license](LICENSE.md).
11+
12+
Please note that this project is released with a[Contributor Code of Conduct](CODE_OF_CONDUCT.md). By participating in this project you agree to abide by its terms.
13+
14+
##Submitting a pull request
15+
16+
1.[Fork][fork] and clone the repository
17+
1. Install the dependencies:`npm install`
18+
1. Make sure the linter passes on your machine:`npx standard --fix`
19+
1. Create a new branch:`git checkout -b my-branch-name`
20+
1. Make your change, and make sure the linter is still happy
21+
1. Push to your fork and[submit a pull request][pr]
22+
1. Pat your self on the back and wait for your pull request to be reviewed and merged.
23+
24+
Here are a few things you can do that will increase the likelihood of your pull request being accepted:
25+
26+
- Follow the[style guide][style].
27+
- Keep your change as focused as possible. If there are multiple changes you would like to make that are not dependent upon each other, consider submitting them as separate pull requests.
28+
- Write a[good commit message](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html).
29+
30+
##Resources
31+
32+
-[How to Contribute to Open Source](https://opensource.guide/how-to-contribute/)
33+
-[Using Pull Requests](https://help.github.com/articles/about-pull-requests/)
34+
-[GitHub Help](https://help.github.com)

‎LICENSE‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright GitHub
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.
File renamed without changes.

‎SECURITY.md‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
Thanks for helping make GitHub safe for everyone.
2+
3+
#Security
4+
5+
GitHub takes the security of our software products and services seriously, including all of the open source code repositories managed through our GitHub organizations, such as[GitHub](https://github.com/GitHub).
6+
7+
Even though[open source repositories are outside of the scope of our bug bounty program](https://bounty.github.com/index.html#scope) and therefore not eligible for bounty rewards, we will ensure that your finding gets passed along to the appropriate maintainers for remediation.
8+
9+
##Reporting Security Issues
10+
11+
If you believe you have found a security vulnerability in any GitHub-owned repository, please report it to us through coordinated disclosure.
12+
13+
**Please do not report security vulnerabilities through public GitHub issues, discussions, or pull requests.**
14+
15+
Instead, please send an email to opensource-security[@]github.com.
16+
17+
Please include as much of the information listed below as you can to help us better understand and resolve the issue:
18+
19+
* The type of issue (e.g., buffer overflow, SQL injection, or cross-site scripting)
20+
* Full paths of source file(s) related to the manifestation of the issue
21+
* The location of the affected source code (tag/branch/commit or direct URL)
22+
* Any special configuration required to reproduce the issue
23+
* Step-by-step instructions to reproduce the issue
24+
* Proof-of-concept or exploit code (if possible)
25+
* Impact of the issue, including how an attacker might exploit the issue
26+
27+
This information will help us triage your report more quickly.
28+
29+
##Policy
30+
31+
See[GitHub's Safe Harbor Policy](https://docs.github.com/en/github/site-policy/github-bug-bounty-program-legal-safe-harbor#1-safe-harbor-terms)

‎SUPPORT.md‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
#Support
2+
3+
##How to file issues and get help
4+
5+
This project uses GitHub issues to track bugs and feature requests. Please search the existing issues before filing new issues to avoid duplicates. For new issues, file your bug or feature request as a new issue.
6+
7+
This project is not actively developed but is maintained by GitHub staff**AND THE COMMUNITY**. We will do our best to respond to support and community questions in a timely manner.
8+
9+
##GitHub Support Policy
10+
11+
Support for this project is limited to the resources listed above.

‎app.js‎

Lines changed: 48 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -1,70 +1,78 @@
1-
importdotenvfrom"dotenv";
2-
importfsfrom"fs";
3-
importhttpfrom"http";
4-
import{App}from"octokit";
5-
import{createNodeMiddleware}from"@octokit/webhooks";
1+
importdotenvfrom'dotenv'
2+
importfsfrom'fs'
3+
importhttpfrom'http'
4+
import{Octokit,App}from'octokit'
5+
import{createNodeMiddleware}from'@octokit/webhooks'
66

77
// Load environment variables from .env file
8-
dotenv.config();
8+
dotenv.config()
99

1010
// Set configured values
11-
constappId=process.env.APP_ID;
12-
constprivateKeyPath=process.env.PRIVATE_KEY_PATH;
13-
constprivateKey=fs.readFileSync(privateKeyPath,"utf8");
14-
constsecret=process.env.WEBHOOK_SECRET;
15-
constenterpriseHostname=process.env.ENTERPRISE_HOSTNAME;
16-
constmessageForNewPRs=fs.readFileSync("./message.md","utf8");
11+
constappId=process.env.APP_ID
12+
constprivateKeyPath=process.env.PRIVATE_KEY_PATH
13+
constprivateKey=fs.readFileSync(privateKeyPath,'utf8')
14+
constsecret=process.env.WEBHOOK_SECRET
15+
constenterpriseHostname=process.env.ENTERPRISE_HOSTNAME
16+
constmessageForNewPRs=fs.readFileSync('./message.md','utf8')
1717

1818
// Create an authenticated Octokit client authenticated as a GitHub App
1919
constapp=newApp({
20-
appId:appId,
21-
privateKey:privateKey,
20+
appId,
21+
privateKey,
2222
webhooks:{
23-
secret:secret
23+
secret
2424
},
2525
...(enterpriseHostname&&{
2626
Octokit:Octokit.defaults({
27-
baseUrl:`https://${enterpriseHostname}/api/v3`,
28-
}),
29-
}),
27+
baseUrl:`https://${enterpriseHostname}/api/v3`
28+
})
29+
})
3030
})
3131

3232
// Optional: Get & log the authenticated app's name
33-
const{ data}=awaitapp.octokit.request("/app");
33+
const{ data}=awaitapp.octokit.request('/app')
3434

3535
// Read more about custom logging: https://github.com/octokit/core.js#logging
36-
app.octokit.log.debug(`Authenticated as '${data.name}'`);
36+
app.octokit.log.debug(`Authenticated as '${data.name}'`)
3737

3838
// Subscribe to the "pull_request.opened" webhook event
39-
app.webhooks.on("pull_request.opened",async({ octokit, payload})=>{
40-
console.log(`Received a pull request event for #${payload.pull_request.number}`);
41-
awaitoctokit.rest.issues.createComment({
42-
owner:payload.repository.owner.login,
43-
repo:payload.repository.name,
44-
issue_number:payload.pull_request.number,
45-
body:messageForNewPRs,
46-
});
47-
});
39+
app.webhooks.on('pull_request.opened',async({ octokit, payload})=>{
40+
console.log(`Received a pull request event for #${payload.pull_request.number}`)
41+
try{
42+
awaitoctokit.rest.issues.createComment({
43+
owner:payload.repository.owner.login,
44+
repo:payload.repository.name,
45+
issue_number:payload.pull_request.number,
46+
body:messageForNewPRs
47+
})
48+
}catch(error){
49+
if(error.response){
50+
console.error(`Error! Status:${error.response.status}. Message:${error.response.data.message}`)
51+
}else{
52+
console.error(error)
53+
}
54+
}
55+
})
4856

4957
// Optional: Handle errors
5058
app.webhooks.onError((error)=>{
51-
if(error.name==="AggregateError"){
59+
if(error.name==='AggregateError'){
5260
// Log Secret verification errors
53-
console.log(`Error processing request:${error.event}`);
61+
console.log(`Error processing request:${error.event}`)
5462
}else{
55-
console.log(error);
63+
console.log(error)
5664
}
57-
});
65+
})
5866

5967
// Launch a web server to listen for GitHub webhooks
60-
constport=process.env.PORT||3000;
61-
constpath="/api/webhook";
62-
constlocalWebhookUrl=`http://localhost:${port}${path}`;
68+
constport=process.env.PORT||3000
69+
constpath='/api/webhook'
70+
constlocalWebhookUrl=`http://localhost:${port}${path}`
6371

6472
// See https://github.com/octokit/webhooks.js/#createnodemiddleware for all options
65-
constmiddleware=createNodeMiddleware(app.webhooks,{ path});
73+
constmiddleware=createNodeMiddleware(app.webhooks,{ path})
6674

67-
http.createServer(middleware).listen(port,()=>{
68-
console.log(`Server is listening for events at:${localWebhookUrl}`);
75+
http.createServer(middleware).listen(port,()=>{
76+
console.log(`Server is listening for events at:${localWebhookUrl}`)
6977
console.log('Press Ctrl + C to quit.')
70-
});
78+
})

0 commit comments

Comments
 (0)

[8]ページ先頭

©2009-2025 Movatter.jp