Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tj-actions/cookiecutter-action
:octocat: Cookiecutter for github actions
https://github.com/tj-actions/cookiecutter-action
actions cookiecutter-action python
Last synced: about 2 months ago
JSON representation
:octocat: Cookiecutter for github actions
- Host: GitHub
- URL: https://github.com/tj-actions/cookiecutter-action
- Owner: tj-actions
- License: mit
- Created: 2020-06-18T22:46:05.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2024-04-12T08:39:09.000Z (5 months ago)
- Last Synced: 2024-04-14T01:46:19.702Z (5 months ago)
- Topics: actions, cookiecutter-action, python
- Language: Dockerfile
- Homepage:
- Size: 2.84 MB
- Stars: 5
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- jimsghstars - tj-actions/cookiecutter-action - :octocat: Cookiecutter for github actions (Dockerfile)
README
[](https://app.codacy.com/gh/tj-actions/cookiecutter-action/dashboard?utm_source=gh\&utm_medium=referral\&utm_content=\&utm_campaign=Badge_grade)
[](#contributors-)
[](https://github.com/tj-actions/cookiecutter-action/actions/workflows/test.yml)
# cookiecutter-action
[Cookiecutter](https://github.com/cookiecutter/cookiecutter) for github actions
# Installation
```shell script
$ pip install "cookiecutter>=1.7.0"
```
# Usage
```shell script
$ cookiecutter https://github.com/tj-actions/cookiecutter-action.git
```
Answer the provided questions to create a default shell script Docker action.
### Sample answer
```shell script
$ cookiecutter https://github.com/tj-actions/cookiecutter-action.git
full_name [Tonye Jack]:
email [[email protected]]:
github_username [Enter the github user/organization name (e.g 'test')]: tj-actions
project_name [Enter the project name (e.g 'test-project')]: test-project
project_slug [test-project]:
project_short_description [Enter a short description (e.g 'Test Description')]: Test Description
default_branch [master]: main
action_name [Enter a descriptive action name (e.g 'My Test Action']: My Test Action
version [Enter the initial version (e.g: 'v1')]: v1
branding_icon [check-square]: hard-drive
Select action_color:
1 - white
2 - yellow
3 - blue
4 - green
5 - orange
6 - red
7 - purple
8 - gray-dark
Choose from 1, 2, 3, 4, 5, 6, 7, 8 (1, 2, 3, 4, 5, 6, 7, 8) [1]:
Select open_source_license:
1 - MIT license
2 - BSD license
3 - ISC license
4 - Apache Software License 2.0
5 - GNU General Public License v3
6 - Not open source
Choose from 1, 2, 3, 4, 5, 6 [1]: 1
```
This generates a [**test-project**](test-project)
* Free software: [MIT license](LICENSE)
If you feel generous and want to show some extra appreciation:
[![Buy me a coffee][buymeacoffee-shield]][buymeacoffee]
[buymeacoffee]: https://www.buymeacoffee.com/jackton1
[buymeacoffee-shield]: https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png
## Contributors ✨
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
