Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/knightlyjs/knightly
🌒 Nightly builds for projects and PRs (BETA)
https://github.com/knightlyjs/knightly
automation knightly nightly-build
Last synced: 5 days ago
JSON representation
🌒 Nightly builds for projects and PRs (BETA)
- Host: GitHub
- URL: https://github.com/knightlyjs/knightly
- Owner: knightlyjs
- License: mit
- Created: 2020-10-11T07:09:57.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2021-04-23T04:15:45.000Z (over 3 years ago)
- Last Synced: 2024-08-01T18:31:47.095Z (3 months ago)
- Topics: automation, knightly, nightly-build
- Language: TypeScript
- Homepage:
- Size: 783 KB
- Stars: 226
- Watchers: 3
- Forks: 2
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-list - knightly
README
## Motivation
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.
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.
No more *"when will this be merged?"* or *"when will x.x.x be released?"* - If you really need them, just use the nightly builds before the official release came out!
NPM Demo: [vuejs/vue-next@ref-sugar](https://www.npmjs.com/package/@knightly/vue/v/ref-sugar)
## Usages
### Community Maintained Builds
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).
#### Request for Repo
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.
#### Request for PRs
Once the repo enables Knightly, everyone can pin [@knightly-bot](https://github.com/knightly-bot) in **a PR**, like:
```css
@knightly-bot build this
```![](./res/pinning.png)
The bot will leave a comment asking the community to vote on it.
![](./res/vote.png)
If the comment receives 10 thumbs up 👍. The nightly build for the PR will be enabled automatically.
![](./res/build.png)
Scripts for the bot can be found in [knightlyjs/bot](https://github.com/knightlyjs/bot)
### Standalone Use
> 🚧 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.
### APIs
> 🚧 This project is still under heavy development, the APIs may change without advance notice. You can use TypeScript auto-completion for now.
### Badge
![](./res/badge.svg)
```md
![Nightly Build](https://github.com/knightlyjs/knightly/blob/main/res/badge.svg?raw=true)
```## Sponsors
This project is part of my Sponsor Program
## License
MIT