Skip to content

Commit 7e78206

Browse files
epageepage
authored
Merge pull request #19 from epage/update
Expand docs and CI coverage
2 parents a4fb42f + 412695b commit 7e78206

File tree

4 files changed

+186
-19
lines changed

4 files changed

+186
-19
lines changed

‎.travis.yml

+48-18
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,54 @@
1+
sudo: false
12
language: rust
2-
33
rust:
4-
- nightly
5-
- beta
6-
- stable
7-
4+
- 1.22.0 # Two releases back
5+
- stable
6+
- beta
7+
- nightly
88
matrix:
99
include:
10-
- rust: nightly-2017-10-09
11-
env:
12-
- CLIPPY_VERS="0.0.165"
13-
- CLIPPY_TOOLCHAIN="2017-10-09"
14-
install:
15-
- cargo +nightly-$CLIPPY_TOOLCHAIN clippy -- --version || travis_wait cargo +nightly-$CLIPPY_TOOLCHAIN install clippy --vers "$CLIPPY_VERS" --force
16-
- export PATH=$HOME/.cargo/bin:$PATH
17-
script:
18-
- cargo +nightly-$CLIPPY_TOOLCHAIN clippy -- -D warnings
10+
- env: RUSTFMT
11+
rust: 1.25.0 # `stable`: Locking down for consistent behavior
12+
install:
13+
- rustup component add rustfmt-preview
14+
script:
15+
- cargo fmt -- --write-mode=diff
16+
- env: RUSTFLAGS="-D warnings"
17+
rust: 1.25.0 # `stable`: Locking down for consistent behavior
18+
install:
19+
script:
20+
- cargo check --tests --all-features
21+
- env: CLIPPY_VERSION="0.0.179"
22+
rust: nightly-2018-01-12
23+
install:
24+
- travis_wait cargo install clippy --version $CLIPPY_VERSION || echo "clippy already installed"
25+
script:
26+
- cargo clippy --all-features -- -D clippy
27+
28+
install:
29+
- rustc -Vv
30+
- cargo -V
31+
- export PATH=$HOME/.cargo/bin:$PATH
1932

2033
script:
21-
- rustc -Vv
22-
- cargo -V
23-
- cargo check --verbose
24-
- cargo test --verbose
34+
- cargo check --verbose
35+
- cargo check --verbose --no-default-features
36+
- cargo check --verbose --all-features
37+
- cargo test --verbose --all-features
38+
39+
branches:
40+
only:
41+
# Release tags
42+
- /^v\d+\.\d+\.\d+.*$/
43+
- master
44+
45+
cache:
46+
apt: true
47+
cargo: true
48+
before_cache:
49+
# Travis can't cache files that are not readable by "others"
50+
- chmod -R a+r $HOME/.cargo
51+
52+
notifications:
53+
email:
54+
on_success: never

‎CONTRIBUTING.md

+67
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
# Contributing to dir-diff
2+
3+
Thanks for wanting to contribute! There are many ways to contribute and we
4+
appreciate any level you're willing to do.
5+
6+
## Feature Requests
7+
8+
Need some new functionality to help? You can let us know by opening an
9+
[issue][new issue]. It's helpful to look through [all issues][all issues] in
10+
case its already being talked about.
11+
12+
## Bug Reports
13+
14+
Please let us know about what problems you run into, whether in behavior or
15+
ergonomics of API. You can do this by opening an [issue][new issue]. It's
16+
helpful to look through [all issues][all issues] in case its already being
17+
talked about.
18+
19+
## Pull Requests
20+
21+
Looking for an idea? Check our [issues][issues]. If it's look more open ended,
22+
it is probably best to post on the issue how you are thinking of resolving the
23+
issue so you can get feedback early in the process. We want you to be
24+
successful and it can be discouraging to find out a lot of re-work is needed.
25+
26+
Already have an idea? It might be good to first [create an issue][new issue]
27+
to propose it so we can make sure we are aligned and lower the risk of having
28+
to re-work some of it and the discouragement that goes along with that.
29+
30+
### Process
31+
32+
When you first post a PR, we request that the the commit history get cleaned
33+
up. We recommend avoiding this during the PR to make it easier to review how
34+
feedback was handled. Once the commit is ready, we'll ask you to clean up the
35+
commit history. Once you let us know this is done, we can move forward with
36+
merging! If you are uncomfortable with these parts of git, let us know and we
37+
can help.
38+
39+
We ask that all new files have the copyright header. Please update the
40+
copyright year for files you are modifying.
41+
42+
As a heads up, we'll be running your PR through the following gauntlet:
43+
- warnings turned to compile errors
44+
- `cargo test`
45+
- `rustfmt`
46+
- `clippy`
47+
- `rustdoc`
48+
49+
Check out our [CI][travis] for more information.
50+
51+
## Releasing
52+
53+
When we're ready to release, a project owner should do the following
54+
- Determine what the next version is, according to semver
55+
- Bump version in a commit
56+
- Update CHANGELOG.md
57+
- Update the version in `Cargo.toml`
58+
- Update the dependency version in `src/lib.rs`
59+
- Update the dependency version in `README.md`
60+
- Tag the commit via `git tag -am "v<X>.<Y>.<Z>" v<X>.<Y>.<Z>`
61+
- `git push upstream master --tag v<X>.<Y>.<Z>`
62+
- Run `cargo publish` (run `cargo login` first if needed)
63+
64+
[issues]: https://github.com/assert-rs/dir-diff/issues
65+
[new issue]: https://github.com/assert-rs/dir-diff/issues/new
66+
[all issues]: https://github.com/assert-rs/dir-diff/issues?utf8=%E2%9C%93&q=is%3Aissue
67+
[travis]: https://github.com/assert-rs/dir-diff/blob/master/.travis.yml

‎README.md

+22-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,10 @@
22

33
Are the contents of two directories different?
44

5-
[![Build Status](https://travis-ci.org/steveklabnik/dir-diff.svg?branch=master)](https://travis-ci.org/steveklabnik/dir-diff)
5+
[![Travis Status](https://travis-ci.org/assert-rs/dir-diff.svg?branch=master)](https://travis-ci.org/assert-rs/dir-diff)
6+
[![Appveyor Status](https://ci.appveyor.com/api/projects/status/xsayr0kcerir694j/branch/master?svg=true)](https://ci.appveyor.com/project/epage/dir-diff/branch/master)
7+
[![Documentation](https://img.shields.io/badge/docs-master-blue.svg)][Documentation]
8+
![License](https://img.shields.io/crates/l/dir-diff.svg)
69
[![Crates Status](https://img.shields.io/crates/v/dir-diff.svg)](https://crates.io/crates/dir-diff)
710

811
Mostly useful for integration-style tests when you want to check some generated
@@ -26,4 +29,22 @@ fn smoke_test() {
2629
}
2730
```
2831

32+
## License
33+
34+
Licensed under either of
35+
36+
* Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)
37+
* MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)
38+
39+
at your option.
40+
41+
### Contribution
42+
43+
Unless you explicitly state otherwise, any contribution intentionally
44+
submitted for inclusion in the work by you, as defined in the Apache-2.0
45+
license, shall be dual licensed as above, without any additional terms or
46+
conditions.
47+
48+
[Crates.io]: https://crates.io/crates/dir-diff
49+
[Documentation]: https://docs.rs/dir-diff
2950
[`tempdir`]: https://crates.io/crates/tempdir

‎appveyor.yml

+49
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
environment:
2+
global:
3+
RUST_VERSION: stable
4+
#APPVEYOR_CACHE_SKIP_RESTORE: true
5+
6+
matrix:
7+
# Stable channel
8+
- TARGET: i686-pc-windows-msvc
9+
CHANNEL: stable
10+
- TARGET: x86_64-pc-windows-msvc
11+
CHANNEL: stable
12+
# Beta channel
13+
- TARGET: x86_64-pc-windows-msvc
14+
CHANNEL: beta
15+
# Nightly channel
16+
- TARGET: x86_64-pc-windows-msvc
17+
CHANNEL: nightly
18+
19+
install:
20+
- ps: >-
21+
$Env:PATH += ';C:\msys64\usr\bin'
22+
- curl -sSf -o rustup-init.exe https://win.rustup.rs/
23+
- rustup-init.exe -y --default-host %TARGET% --default-toolchain %RUST_VERSION%
24+
- set PATH=%PATH%;C:\Users\appveyor\.cargo\bin
25+
- rustc -Vv
26+
- cargo -V
27+
28+
test_script:
29+
- cargo check --verbose
30+
- cargo check --verbose --no-default-features
31+
- cargo check --verbose --all-features
32+
- cargo test --verbose --all-features
33+
34+
branches:
35+
only:
36+
# Release tags
37+
- /^v\d+\.\d+\.\d+.*$/
38+
- master
39+
40+
cache:
41+
- C:\Users\appveyor\.cargo\registry
42+
- target
43+
44+
notifications:
45+
- provider: Email
46+
on_build_success: false
47+
48+
# Building is done in the test phase, so we disable Appveyor's build phase.
49+
build: false

0 commit comments

Comments
 (0)