mirror of
https://git.vectorsigma.ru/public/atlantis.git
synced 2026-08-03 00:08:32 +00:00
df0d58d29b
* feat: add userConfig.VCSStatusName to applyCommandRunner context * fix: use vcsstatusname from context * chore: normalize tests * chore: update interface mock
49 lines
2.6 KiB
Go
49 lines
2.6 KiB
Go
// Copyright 2017 HootSuite Media Inc.
|
|
//
|
|
// 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.
|
|
// Modified hereafter by contributors to runatlantis/atlantis.
|
|
|
|
package vcs
|
|
|
|
import (
|
|
"github.com/runatlantis/atlantis/server/events/models"
|
|
)
|
|
|
|
//go:generate pegomock generate -m --use-experimental-model-gen --package mocks -o mocks/mock_client.go Client
|
|
|
|
// Client is used to make API calls to a VCS host like GitHub or GitLab.
|
|
type Client interface {
|
|
// GetModifiedFiles returns the names of files that were modified in the merge request
|
|
// relative to the repo root, e.g. parent/child/file.txt.
|
|
GetModifiedFiles(repo models.Repo, pull models.PullRequest) ([]string, error)
|
|
CreateComment(repo models.Repo, pullNum int, comment string, command string) error
|
|
HidePrevCommandComments(repo models.Repo, pullNum int, command string) error
|
|
PullIsApproved(repo models.Repo, pull models.PullRequest) (models.ApprovalStatus, error)
|
|
PullIsMergeable(repo models.Repo, pull models.PullRequest, vcsstatusname string) (bool, error)
|
|
// UpdateStatus updates the commit status to state for pull. src is the
|
|
// source of this status. This should be relatively static across runs,
|
|
// ex. atlantis/plan or atlantis/apply.
|
|
// description is a description of this particular status update and can
|
|
// change across runs.
|
|
// url is an optional link that users should click on for more information
|
|
// about this status.
|
|
UpdateStatus(repo models.Repo, pull models.PullRequest, state models.CommitStatus, src string, description string, url string) error
|
|
MergePull(pull models.PullRequest, pullOptions models.PullRequestOptions) error
|
|
MarkdownPullLink(pull models.PullRequest) (string, error)
|
|
GetTeamNamesForUser(repo models.Repo, user models.User) ([]string, error)
|
|
|
|
// DownloadRepoConfigFile return `atlantis.yaml` content from VCS (which support fetch a single file from repository)
|
|
// The first return value indicate that repo contain atlantis.yaml or not
|
|
// if BaseRepo had one repo config file, its content will placed on the second return value
|
|
DownloadRepoConfigFile(pull models.PullRequest) (bool, []byte, error)
|
|
SupportsSingleFileDownload(repo models.Repo) bool
|
|
}
|