Skip to content

Latest commit

 

History

History
60 lines (46 loc) · 2.57 KB

CONTRIBUTING.md

File metadata and controls

60 lines (46 loc) · 2.57 KB
Raw

HAProxy

Contributing guide

This document is a short guide for contributing to this project.

API Specification - Development guide

Dataplane API generation

Data Plane API is generated using go-swagger from the swagger spec found here using the following command.

make generate

or if you prefer to run it directly (not in docker)

make generate-native

make generate-native must also be used if you are using local client-native on disk (you have replace github.com/haproxytech/client-native/v6 => ../client-native in go.mod file)

This command generates some of the files in this project, which are marked with // Code generated by go-swagger; DO NOT EDIT. comments at the top of the files. These are not to be edited, as they are overwritten when specification is changed and the above-mentioned command is run. If you want to change those files, please change the specification where necessary and then generate them again.

handlers/parents_xxx_generated.go generation

Some handler files handler/parents_xxx_generated.go are automatically generated. For this use the following command:

make generate-parent-aliases

Pre-requisites: for this command to run you need to update the following files:

  • generate/parents/main.go
    • Update this section with the list of children for which you generate a handler/parents_xxx_generated.go
	children := []string{
		cnparents.ServerChildType,
		cnparents.HTTPAfterResponseRuleChildType,
		cnparents.HTTPCheckChildType,
		cnparents.HTTPErrorRuleChildType,
		cnparents.HTTPRequestRuleChildType,
		cnparents.HTTPResponseRuleChildType,
		cnparents.TCPCheckChildType,
		cnparents.TCPRequestRuleChildType,
		cnparents.TCPResponseRuleChildType,
		cnparents.ACLChildType,
		cnparents.BindChildType,
		cnparents.FilterChildType,
		cnparents.LogTargetChildType,
	}
  • generate/parents/operations.go
    • Contains the list of operations to generate an alias for in the handler/parents_xxx_generated.go.
    • Note that the list of parents for wich an alias is generated is defined in: client-native (refer to client-native specification/README.md)

Commit Messages and General Style

For commit messages and general style please follow the haproxy project's CONTRIBUTING guide and use that where applicable.