https://github.com/followtheprocess/rust_copier
Simple, clean rust crate copier template
https://github.com/followtheprocess/rust_copier
Last synced: 4 months ago
JSON representation
Simple, clean rust crate copier template
- Host: GitHub
- URL: https://github.com/followtheprocess/rust_copier
- Owner: FollowTheProcess
- License: mit
- Created: 2022-09-26T19:31:55.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2025-02-21T08:01:17.000Z (4 months ago)
- Last Synced: 2025-02-21T09:19:42.412Z (4 months ago)
- Language: Jinja
- Size: 123 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Rust Copier
A clean, simple Rust copier template.
## Features
### Choose Project Type
The template lets you choose whether you want to create a binary executable program (e.g. a CLI) or an importable library and the generated files will be tailored accordingly! For example, in a binary project, GitHub Actions will be configured to build across a range of OS and Architectures and upload the build binaries as release artifacts.
### [GitHub Actions]
The project template comes with a ready to go GitHub Actions configuration file which automates all your code quality checks:
* Testing with `cargo test`
* Linting with `clippy`
* Formatting with `rustfmt`
* Building, cross-compilation and release (for binary packages)
### [GitHub CLI]
Option to use the new GitHub CLI to create a GitHub repo for you during project creation. (You'll need to have this already installed)
### GitHub Issue Labelling
Series of helpful labels that you can use to categorise issues and pull requests. These come in especially handy when combined with the Release Drafter workflow!
### Automatic Release Drafts
Automatically generate release notes with the [Release Drafter] workflow. This uses the labels from issues and pull requests to draft pretty and detailed release notes for your GitHub releases.
This is automatically run when you push a new tag to main.
## Usage
* Ensure you have [copier] installed:
``` shell
pipx install copier
```
* Call copier with this template and answer all the questions
``` shell
copier gh:FollowTheProcess/rust_copier /path/to/put/your/new/project
```
* Create a git repo (if not using the gh cli) and start developing
* Make a first commit to set up the github repo (if you didn't use the gh cli)
* That should be it! from now on everything will be handled automatically. All you need to do is write code, tests and docs! Your code will be style checked, your tests will be run etc.
[GitHub actions]: https://docs.github.com/en/free-pro-team@latest/actions
[GitHub CLI]: https://cli.github.com
[copier]: https://github.com/copier-org/copier
[Release Drafter]: https://github.com/release-drafter/release-drafter