README
¶
openMFP - golang-commons
Description
golang-commons contains golang library packages to be reused across microservices and operators/controllers. The scope includes, but is not limited to:
- JWT handling
- Context handling
- Error handling
- Logging
- Controllers
Getting started
Add the dependency to your go module based project like so:
go get github.com/openmfp/golang-commons
Releasing
The release is performed automatically through a GitHub Actions Workflow.
All the released versions will be available through access to GitHub (as any other Golang library).
Requirements
golang-commons requires a installation of go. Checkout the go.mod for the required go version.
Mocks
golang commons uses mockery for mocking. If mock is absent, you can update .mockery.yaml file by adding the missing mock. Then run the following command to generate the mock files:
task mockery
P.S. If you have golang installed, it automatically installs the mockery binary in golang-commons/bin directory.
Contributing
Please refer to the CONTRIBUTING.md file in this repository for instructions on how to contribute to openMFP.
Code of Conduct
Please refer to the CODE_OF_CONDUCT.md file in this repository informations on the expected Code of Conduct for contributing to openMFP.
Licensing
Copyright 2024 SAP SE or an SAP affiliate company and openMFP contributors. Please see our LICENSE for copyright and license information. Detailed information including third-party components and their licensing/copyright information is available via the REUSE tool.
Directories
¶
| Path | Synopsis |
|---|---|
|
Package context implements a safe way to create a context which will have a timeout after closing the context
|
Package context implements a safe way to create a context which will have a timeout after closing the context |
|
controller
|
|