-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
CHG: Move dev info to separate Readme file
- Loading branch information
1 parent
8577b08
commit 60530d8
Showing
3 changed files
with
34 additions
and
11 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,6 @@ | ||
[package] | ||
name = "neuroformats" | ||
version = "0.2.3" | ||
version = "0.2.4" | ||
authors = ["Tim Schäfer <[email protected]>"] | ||
edition = "2018" | ||
repository = "https://github.com/dfsp-spirit/neuroformats-rs" | ||
|
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 |
---|---|---|
@@ -0,0 +1,31 @@ | ||
# Developer information for neuroformats-rs | ||
|
||
## Running the unit tests | ||
|
||
Run `cargo test` in the repository root to run the tests locally. | ||
|
||
|
||
Continuous integration results: | ||
|
||
main branch: ![main](https://github.com/dfsp-spirit/neuroformats-rs/actions/workflows/tests.yml/badge.svg?branch=main) | ||
|
||
develop branch: ![main](https://github.com/dfsp-spirit/neuroformats-rs/actions/workflows/tests.yml/badge.svg?branch=develop) | ||
|
||
|
||
## Publishing a new release | ||
|
||
* Update the [CHANGES file](./CHANGES) | ||
* Bump version information in [Cargo.toml](./Cargo.toml) | ||
* Run the unit tests | ||
* Once everything is ready, publish to crates.io via ```cargo```: | ||
|
||
```shell | ||
cargo login | ||
cargo publish --dry-run | ||
``` | ||
|
||
And when you are satisfied with the result: | ||
|
||
```shell | ||
cargo publish | ||
``` |