Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/boringcodes/create-dotgithub
:airplane: Boring GitHub Dotfiles Generator - @boringcodes
https://github.com/boringcodes/create-dotgithub
boringcodes cli eslint github-actions github-workflows husky lint-staged npm prettier rollup standard-version yeoman
Last synced: about 2 months ago
JSON representation
:airplane: Boring GitHub Dotfiles Generator - @boringcodes
- Host: GitHub
- URL: https://github.com/boringcodes/create-dotgithub
- Owner: boringcodes
- License: mit
- Created: 2020-03-26T11:16:00.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2023-01-07T22:56:52.000Z (about 2 years ago)
- Last Synced: 2024-03-25T02:02:31.059Z (10 months ago)
- Topics: boringcodes, cli, eslint, github-actions, github-workflows, husky, lint-staged, npm, prettier, rollup, standard-version, yeoman
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/generator-create-dotgithub
- Size: 826 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
## Features
Supported features:
- [x] **Workflows**
- [ ] **Actions**
Workflows grouped by steps:
- Test
- [x] **lint-source.yml**: check code style & quality
- [ ] **test.yml**: run unit test
- Build
- [x] **build-source.yml**: build source
- [x] **build-image.yml**: build Docker image
- Push
- [x] **create-github-release.yml**: create GitHub Release
- [x] **publish-npm.yml**: publish source to NPM Registry
- [x] **push-dockerhub.yml**: push Docker image to DockerHub
- Deploy
- [x] **deploy-cloudflare-workers.yml**: deploy source to CloudFlare Workers
## Install
Make sure `yeoman` is installed
```sh
$ yarn global add yo
```
Then install the generator
```sh
$ yarn global add generator-create-dotgithub
```
## Usage
Then navigate to the root directory and run the following command to generate source
```sh
$ yo create-dotgithub
```
This scaffolds out
```
├── .github
│ └── actions
│ │ └── generated-action.yml
│ └── workflows
│ └── generated-workflow.yml
└── ...
```
## Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
Please make sure to update tests as appropriate.
## Authors
[BoringCodes](https://github.com/boringcodes)
## License
[MIT](https://github.com/boringcodes/create-dotgithub/blob/master/LICENSE)
