Skip to content

Commit 3bda205

Browse files
authored
Create README.md
1 parent 5ab1890 commit 3bda205

1 file changed

Lines changed: 21 additions & 0 deletions

File tree

README.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# Assembly Differ
2+
Ensure library's public API has the expected level of changes (major, minor or patch) since a previous version. Built on top of [assembly-differ](https://github.com/nullean/assembly-differ) and [JustAssembly](https://github.com/telerik/JustAssembly).
3+
4+
# Usage
5+
This action is simple wrapper of the `assembly-differ` command-line tool. The arguments passed as the `args` parameter are forwarded to the command-line tool. The available assembly providers and examples can be found [here](https://github.com/nullean/assembly-differ#run).
6+
7+
## Example usage
8+
```yml
9+
jobs:
10+
build:
11+
steps:
12+
...
13+
- uses: codemerx/assembly-differ-action@v1
14+
with:
15+
args: '"assembly|${{github.workspace}}\latest-release\Library.dll" "assembly|${{github.workspace}}\Library\Library\bin\debug\netstandard2.0\Library.dll" -p=major'
16+
```
17+
18+
**Note:** `-p=<level>` is required to ensure failed job in case of public API changes higher or equal to the provided level, e.g. the example job will fail if the library has breaking changes. Possible values are `major`, `minor` and `patch`.
19+
20+
# License
21+
This project is [AGPL](https://github.com/codemerx/assembly-differ-action/blob/master/LICENSE) licensed.

0 commit comments

Comments
 (0)