framework

Documentation

Overview

Copyright (c) Huawei Technologies Co., Ltd. 2024. All rights reserved.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Copyright (c) Huawei Technologies Co., Ltd. 2024. All rights reserved.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Copyright (c) Huawei Technologies Co., Ltd. 2024. All rights reserved.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Copyright (c) Huawei Technologies Co., Ltd. 2024. All rights reserved.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Index

• Constants
• func NewLogger() *logrus.Entry
• func NewServer(bot Robot, opt config.FrameworkOptions) *http.Server
• func SetRobotUserID(userID string)
• func StartupServer(httpServer *http.Server, opt config.FrameworkOptions)
• type GenericHandlerFunc
• type HandlerRegister
• type Robot

Constants

const (
	PushEvent        = "Push Hook"
	IssueEvent       = "Issue Hook"
	PullRequestEvent = "Merge Request Hook"
	NoteEvent        = "Note Hook"
)

Functions

func NewLogger

func NewLogger() *logrus.Entry

func NewServer

func NewServer(bot Robot, opt config.FrameworkOptions) *http.Server

func SetRobotUserID

func SetRobotUserID(userID string)

func StartupServer

func StartupServer(httpServer *http.Server, opt config.FrameworkOptions)

Types

type GenericHandlerFunc

type GenericHandlerFunc func(evt *client.GenericEvent, cnf config.Configmap, logger *logrus.Entry)

type HandlerRegister

type HandlerRegister interface {
	RegisterIssueHandler(GenericHandlerFunc)
	RegisterIssueCommentHandler(GenericHandlerFunc)
	RegisterPullRequestHandler(GenericHandlerFunc)
	RegisterPullRequestCommentHandler(GenericHandlerFunc)
	RegisterPushEventHandler(GenericHandlerFunc)
}

type Robot

type Robot interface {
	GetConfigmap() config.Configmap
	RegisterEventHandler(HandlerRegister)
	GetLogger() *logrus.Entry
}