Releasehantering av API-specifikation på GitHub

[mattiaspalmqvist]

För att göra det tydligt vilken version som ett elnätsbolag supportar i sitt API så bör vi ha releasehantering här på GitHub. Det kan hjälpa till att göra det extra tydligt för alla konsumenter av API.

Förslagsvis släpper vi en version nu som heter 0.1.0. Eller om vi hellre vill ha ett alpha/beta-koncept med 1.0.0-alpha/beta.

Är det kanske en alpha vi ska släppa nu först?

"version": "1.0.0-alpha"
"url": "https://api.example.com/v1-alpha"

Sedan:
"version": "1.0.0-beta"
"url": "https://api.example.com/v1-beta"

Och slutligen:
"version": "1.0.0"
"url": "https://api.example.com/v1"

[mattiaspalmqvist]

@portcallbuilder Har du någon idé på hur vi sköter releasehantering på ett snyggt sätt?

[portcallbuilder]

Vad gäller versionsnummer tänker jag att 1.0.0 skulle kunna vara det vi siktar på till den skarpa utrullningen, så att det blir den versionen som går över i förvaltning.
Katalogtjänsten väntar jag mig inga stora förändringar i, den gör ju det den behöver i nuläget, så där är det kanske bra som det är.
Om vi känner oss klara för det kan vi väl skapa en release av nuvarande och då tycker jag 0.1.0 är bästa varianten.
Har aldrig hanterat releases på github, men jag antar att vi behöver bestämma oss för vilka filer som skall paketeras som en release. Alla specifikationsfiler, tänker jag, men kanske även lite dokumentation och samples. Eller skall vi helt enkelt distribuera alla filer i repot som releaser?