diff --git a/README.md b/README.md index c7f9b09aff3d98a399be741648ffa631f78ce7ae..776f307216cffbbf15643b5e7174c8edea91688f 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,16 @@ # Antragsraum-Proxy Der Antragsraum-Proxy nimmt HTTP Requests vom Antragsraum-Server entgegen, mappt diese auf gRPC -und leitet sie an den Vorgang-Manager weiter. Zum Protokollmapping von HTTP auf gRPC wird die -Bibliothek [gRPC-Gateway](https://grpc-ecosystem.github.io/grpc-gateway/) verwendet. Dadurch -können die HTTP-Endpunkte inkl. des Mappings größtenteils automatisch aus proto-Dateien +und leitet sie an den Vorgang-Manager weiter. Zum Protokollmapping von HTTP auf gRPC wird die +Bibliothek [gRPC-Gateway](https://grpc-ecosystem.github.io/grpc-gateway/) verwendet. Dadurch +können die HTTP-Endpunkte inkl. des Mappings größtenteils automatisch aus proto-Dateien generiert werden. -Requests werden zunächst an den gRPC-Router weitergeleitet. Das ist ein Proxy-eigener gRPC-Server, der -auf localhost und dem unter config.grpc.router.port eingetragenen Port läuft. Dort wird die -Adresse des Ziel-Vorgang-Managers aus einem HTTP Header extrahiert. Der Port des -Ziel-Vorgang-Managers ist konstant und wird unter config.grpc.server.port festgelegt. Anschließend -leitet der gRPC-Router die gRPC Request an die URL weiter, die aus der extrahierten Adresse und dem +Requests werden zunächst an den gRPC-Router weitergeleitet. Das ist ein Proxy-eigener gRPC-Server, der +auf localhost und dem unter config.grpc.router.port eingetragenen Port läuft. Dort wird die +Adresse des Ziel-Vorgang-Managers aus einem HTTP Header extrahiert. Der Port des +Ziel-Vorgang-Managers ist konstant und wird unter config.grpc.server.port festgelegt. Anschließend +leitet der gRPC-Router die gRPC Request an die URL weiter, die aus der extrahierten Adresse und dem Port zusammengesetzt wird. ## Getting Started @@ -61,4 +61,24 @@ grpc: port: Port des gRPC Routers (int) logging: level: "ERROR" | "WARN" | "INFO" | "DEBUG" -``` \ No newline at end of file +``` + +### Releasing + +Diese Schritte ausführen: + +* Master-Branch auschecken +* Master-Branch updaten +* Release-Branch auschecken +* Release-Branch updaten +* Master in den Release-Branch mergen - noch nicht pushen! +* Die Version von 'var version' in cmd/antragraum-proxy/main.go "vX.X.X-beta.x" auf "vX.X.X" ändern +* Commit erstellen: "release version X.X.X" +* Release Branch pushen +* Tag "X.X.X" erstellen: git tag "X.X.X" +* tag pushen: git push origin X.X.X +* Master auschecken +* Release-Branch in den Master mergen nicht pushen! +* Die Version von 'var version' in cmd/antragraum-proxy/main.go "vX.X.X" auf "vX.X.X-beta.x" ändern +* Master Branch pushen +