This repository has been archived by the owner on Dec 21, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
1c2d3b6
commit 44a8ea1
Showing
2 changed files
with
2 additions
and
34 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,37 +1,5 @@ | ||
# Contributing | ||
|
||
## Versions | ||
|
||
### Publishing Versions | ||
|
||
Install the prerequisites: | ||
|
||
```bash | ||
cargo install [email protected] | ||
cargo install [email protected] | ||
``` | ||
|
||
To release, do the following: | ||
|
||
1. Update & commit the version & release date in `CHANGELOG.md` | ||
2. Run: `scripts/release.sh x.x.x` | ||
|
||
**Prereleases** | ||
|
||
To create a prerelease version, append `rc` like: `x.x.x-rc.x`. `cargo-dist` will automatically flag this as a prerelease on GitHub. | ||
|
||
### Retracting a version | ||
|
||
If something goes wrong with a deploy: | ||
|
||
1. Remove the release on GitHub | ||
2. In order to re-release the version, delete the tag: | ||
|
||
``` | ||
git tag -d vx.x.x | ||
git push -u origin :refs/tags/vx.x.x | ||
``` | ||
## Developing | ||
|
||
### Run CLI in Example Project | ||
|