Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/fsprojects/syntacticversioning

Helper tool to verify semantic version changes based on API surface area changes
https://github.com/fsprojects/syntacticversioning

fsharp semantic-versioning syntactic-versioning

Last synced: about 2 months ago
JSON representation

Helper tool to verify semantic version changes based on API surface area changes

Host: GitHub
URL: https://github.com/fsprojects/syntacticversioning
Owner: fsprojects
License: other
Created: 2016-12-19T08:26:37.000Z (about 8 years ago)
Default Branch: master
Last Pushed: 2024-06-20T16:13:22.000Z (8 months ago)
Last Synced: 2024-12-17T17:41:26.880Z (about 2 months ago)
Topics: fsharp, semantic-versioning, syntactic-versioning
Language: F#
Homepage:
Size: 258 KB
Stars: 45
Watchers: 8
Forks: 8
Open Issues: 3
Metadata Files:
- Readme: README.md
- License: LICENSE.txt

Awesome Lists containing this project

README

        [![NuGet Status](https://img.shields.io/nuget/v/SynVer.svg?style=flat)](https://www.nuget.org/packages/SynVer/)

# SyntacticVersioning

## Goal

Be able to get an idea about the semantic version changes based on the surface area changes of a .net assembly.

Developers should be able to use the tool to give a magnitude of any API changes. This is helpful when pushing NuGet-packages from a continuous integration server. Internally used NuGet packages of a .net developer organisation often focus on delivering on business goals; the versioning is easily forgotten. I.e. we want to be able to use this from [TeamCity](https://www.jetbrains.com/teamcity/) and others.

When upgrading a package you want to know the magnitude of the changes. In many cases the easiest way right now is to upgrade and look at the compilation errors. Having more information directly in NuGet helps.

## Integration

- You can use the SynVer.Lib found on NuGet [![NuGet Status](https://img.shields.io/nuget/v/SynVer.Lib.svg?style=flat)](https://www.nuget.org/packages/SynVer.Lib/)

- In order to integrate with FAKE you can use the NuGet [![NuGet Status](https://img.shields.io/nuget/v/SynVer.FAKE.svg?style=flat)](https://www.nuget.org/packages/SynVer.FAKE/)

## Requirements

SyntacticVersioning requires a local git installation. You can download git from [Git Downloads](https://git-scm.com/downloads).

## Maintainer(s)

- [@gentauro](https://github.com/gentauro)

- [@wallymathieu](https://github.com/wallymathieu)

- [@baronfel](https://github.com/baronfel)

The default maintainer account for projects under "fsprojects" is [@fsprojectsgit](https://github.com/fsprojectsgit) - F# Community Project Incubation Space (repo management)