Skip to content

Commit 42fc439

Browse files
committed
chore: public 🎉
1 parent 4d377d1 commit 42fc439

File tree

17 files changed

+4200
-125
lines changed

17 files changed

+4200
-125
lines changed

.eslintignore

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
dist
2+
knightly
3+
node_modules
4+
res

.gitignore

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
node_modules
2+
dist
3+
knightly
4+
knightly.yml

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 (c) 2020 Anthony Fu<https://github.com/antfu>
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.

README.md

Lines changed: 64 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,73 @@
11
<p align='center'>
22
<img src='./res/logo.png' width='300' alt="Knightly Logo"/>
33
</p>
4-
<br>
54

65
<p align='center'>
76
<img src='./res/badge.svg'>
87
<p>
98

10-
<p align='center'>
11-
<strong>{Working in Progress}</strong>
12-
<p>
13-
<p align='center'>
14-
Early access available in my <a href="https://github.com/sponsors/antfu">Sponsor Program</a>
9+
<br>
10+
11+
## Motivation
12+
13+
Waiting for PRs getting merged and new version getting released sometimes can be a long process. And I do understand sometimes an annoying bug could block the progress of your projects, or you are just excited to try the new feature.
14+
15+
So I made `Knightly`, trying to **make the nightly build process universally available to any projects**. Don't get frustrated when the maintainers are not available to make releases. And maintainers could also have less pressure to make everything on schedule.
16+
17+
## Usages
18+
19+
### Badge
20+
21+
![](./res/badge.svg)
22+
23+
```md
24+
![Nightly Build](https://github.com/knightlyjs/knightly/blob/main/res/badge.svg?raw=true)
25+
```
26+
27+
### Community Maintained Builds
28+
29+
Community maintained builds will be published under the [@knightly](https://www.npmjs.com/org/knightly) npm org. You can find the active build tasks in [knightlyjs/tasks](https://github.com/knightlyjs/tasks).
30+
31+
#### Request for Repo
32+
33+
It's currently a manual process. [Submit your request issue](https://github.com/knightlyjs/tasks/issues/new?assignees=&labels=repo-request&template=knightly-build-request.md&title=%5BRequest%5D) for repos you would like to enable Knightly on, and we will add it for you.
34+
35+
#### Request for PRs
36+
37+
Once the repo enables Knightly, everyone can pin [@knightly-bot](https://github.com/knightly-bot) in **a PR**, like:
38+
39+
![](./res/pinning.png)
40+
41+
```css
42+
@knightly-bot build this
43+
```
44+
45+
![](./res/vote.png)
46+
47+
The bot will leaves a comment asking the community to vote on it. If the comment receives 10 thumbs up 👍. The nightly build for the PR will be enabled automatically.
48+
49+
![](./res/build.png)
50+
51+
Scripts for the bot can be found in [knightlyjs/bot](https://github.com/knightlyjs/bot)
52+
53+
### Standalone Use
54+
55+
> 🚧 Support for project owners / maintainers to make official nightly builds on their own will be added later. We are currently focusing on Community Maintained Builds support.
56+
57+
### APIs
58+
59+
> 🚧 This project is still under heavy development, the APIs may change without advance notice. You can use TypeScript auto-completion for now.
60+
61+
## Sponsors
62+
63+
This project is part of my <a href='https://github.com/antfu-sponsors'>Sponsor Program</a>
64+
65+
<p align="center">
66+
<a href="https://cdn.jsdelivr.net/gh/antfu/static/sponsors.svg">
67+
<img src='https://cdn.jsdelivr.net/gh/antfu/static/sponsors.svg'/>
68+
</a>
1569
</p>
70+
71+
## License
72+
73+
MIT

bin/knightly.js

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
#!/usr/bin/env node
2+
'use strict'
3+
require('../dist/cli')

package.json

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
{
2+
"name": "knightly",
3+
"version": "0.3.2",
4+
"main": "dist/index.js",
5+
"module": "dist/index.mjs",
6+
"types": "dist/index.d.ts",
7+
"author": "Anthony Fu <[email protected]>",
8+
"license": "MIT",
9+
"scripts": {
10+
"prepare": "rimraf dist && npm run build",
11+
"dev": "KNIGHTLY_DEBUG=true esno src/cli.ts --dry-run",
12+
"build": "tsup src/index.ts src/cli.ts --format cjs,esm --dts",
13+
"release": "npx bumpp --commit --push --tag && npm publish"
14+
},
15+
"bin": {
16+
"knightly": "bin/knightly.js"
17+
},
18+
"files": [
19+
"bin",
20+
"dist",
21+
"src"
22+
],
23+
"dependencies": {
24+
"@octokit/rest": "^18.0.6",
25+
"chalk": "^4.1.0",
26+
"dayjs": "^1.9.1",
27+
"debug": "^4.2.0",
28+
"fast-glob": "^3.2.4",
29+
"fs-extra": "^9.0.1",
30+
"js-yaml": "^3.14.0",
31+
"pacote": "^11.1.11",
32+
"param-case": "^3.0.3",
33+
"semver": "^7.3.2",
34+
"simple-git": "^2.21.0",
35+
"yargs": "^16.0.3"
36+
},
37+
"devDependencies": {
38+
"@antfu/eslint-config-ts": "^0.3.3",
39+
"@types/debug": "^4.1.5",
40+
"@types/fs-extra": "^9.0.1",
41+
"@types/js-yaml": "^3.12.5",
42+
"@types/node": "^14.11.8",
43+
"@types/pacote": "^11.1.0",
44+
"@types/semver": "^7.3.4",
45+
"@types/yargs": "^15.0.8",
46+
"eslint": "^7.11.0",
47+
"esno": "^0.2.0",
48+
"rimraf": "^3.0.2",
49+
"tsup": "^3.7.0",
50+
"typescript": "^4.0.3"
51+
},
52+
"eslintConfig": {
53+
"extends": "@antfu/eslint-config-ts"
54+
}
55+
}

0 commit comments

Comments
 (0)