Skip to content

Commit 56bc8c3

Browse files
author
Jake Ginnivan
committed
Remove beta tag and document breaking changes
1 parent b7160c7 commit 56bc8c3

File tree

4 files changed

+14
-7
lines changed

4 files changed

+14
-7
lines changed

GitVersionConfig.yaml

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1 @@
1-
next-version: 3.0.0
2-
branches:
3-
master:
4-
tag: beta
1+
next-version: 3.0.0

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ TestStack.ConventionTests also will generate a convention report of the conventi
3030
Convention.Is(new AllMethodsAreVirtual(), nhibernateEntities);
3131
}
3232

33-
For more information [view the TestStack.ConventionTests documentation](http://conventiontests.teststack.net/docs/)
33+
For more information [view the TestStack.ConventionTests documentation](http://teststackconventiontests.readthedocs.org/)
3434

3535
### Packaged Conventions
3636
Here is a list of some of the pacakged conventions
@@ -47,7 +47,7 @@ Here is a list of some of the pacakged conventions
4747
- Types ending in *Controller must inherit from ApiController (or Controller), and
4848
- Types inheriting from ApiController must be named *Controller
4949

50-
If you would like to define your own conventions see [Defining Conventions](http://conventiontests.teststack.net/docs/getting-started#section-defining-conventions)
50+
If you would like to define your own conventions see [Defining Conventions](http://teststackconventiontests.readthedocs.org/en/latest/defining-conventions/)
5151

5252
### More Information
5353
[Krzysztof Koźmic](https://github.com/kkozmic) first spoke about ConventionTests at NDC 2012. You can find the video of that talk [here](http://vimeo.com/43676874), slides [here](http://kozmic.pl/presentations/) and the introductory blog post [here](http://kozmic.pl/2012/06/14/using-conventiontests/).

docs/changelog.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
## v3.0.0
2+
### Breaking changes
3+
v3 removes external dependencies from the core TestStack.ConventionTest project.
4+
5+
1. Mono.Cecil is now ILMerged internally
6+
So if you use the Mono.Cecil functionality, leave it installed. Otherwise uninstall it to remove unneeded dependencies
7+
2. ApprovalTests is no longer a dependency
8+
This also means the `Convention.IsWithApprovedExeptions` method is gone.
9+
Replace usage with `var failures = Convention.GetFailures` then use Shouldly's `failures.ShouldMatchApproved()` extension or `ApprovalTests.Verify(failures)` to verify the failures.

docs/mkdocs.yml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,4 +5,5 @@ repo_url: https://github.com/TestStack/TestStack.ConventionTests
55
pages:
66
- Home: index.md
77
- 'Defining Conventions': 'defining-conventions.md'
8-
- 'Symmetric Conventions': 'symmetric-conventions.md'
8+
- 'Symmetric Conventions': 'symmetric-conventions.md'
9+
- 'Changelog': 'changelog.md'

0 commit comments

Comments
 (0)