create-dotgithub

Boring GitHub Dotfiles Generator (templates fetched from boringcodes/.github)

Features

Supported features:

• Workflows
• Actions

Workflows grouped by steps:

• Test
  • lint-source.yml: check code style & quality
  • test.yml: run unit test
• Build
  • build-source.yml: build source
  • build-image.yml: build Docker image
• Push
  • create-github-release.yml: create GitHub Release
  • publish-npm.yml: publish source to NPM Registry
  • push-dockerhub.yml: push Docker image to DockerHub
• Deploy
  • deploy-cloudflare-workers.yml: deploy source to CloudFlare Workers

Install

Make sure yeoman is installed

$ yarn global add yo

Then install the generator

$ yarn global add generator-create-dotgithub

Usage

Then navigate to the root directory and run the following command to generate source

$ 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

License

MIT