go-plugin/repo.go

// Copyright 2023 Woodpecker Authors
//
// 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.

package plugin

import (
	"github.com/urfave/cli/v3"
)

// Repository defines runtime metadata for a repository.
type Repository struct {
	RemoteID      string `json:"remote_id,omitempty"`
	Name          string `json:"name,omitempty"`
	Owner         string `json:"owner,omitempty"`
	Link          string `json:"link,omitempty"`
	URL           string `json:"url,omitempty"`
	CloneURL      string `json:"clone_url,omitempty"`
	Private       bool   `json:"private,omitempty"`
	DefaultBranch string `json:"default_branch,omitempty"`

	// Deprecated: Please use DefaultBranch instead.
	Branch string
}

func repositoryFlags() []cli.Flag {
	return []cli.Flag{
		&cli.StringFlag{
			Name:  "repo.remote-id",
			Usage: "repo remote id",
			Sources: cli.EnvVars(
				"CI_REPO_REMOTE_ID",
			),
		},
		&cli.StringFlag{
			Name:  "repo.name",
			Usage: "repo name",
			Sources: cli.EnvVars(
				"CI_REPO_NAME",
				"DRONE_REPO_NAME",
			),
		},
		&cli.StringFlag{
			Name:  "repo.owner",
			Usage: "repo owner",
			Sources: cli.EnvVars(
				"CI_REPO_OWNER",
				"DRONE_REPO_OWNER",
			),
		},
		&cli.StringFlag{
			Name:    "repo.url",
			Aliases: []string{"repo.link"},
			Usage:   "repo url",
			Sources: cli.EnvVars(
				"CI_REPO_URL",
				"CI_REPO_LINK",
				"DRONE_REPO_LINK",
			),
		},
		&cli.StringFlag{
			Name:  "repo.clone-url",
			Usage: "repo clone url",
			Sources: cli.EnvVars(
				"CI_REPO_CLONE_URL",
				"DRONE_GIT_HTTP_URL",
			),
		},
		&cli.BoolFlag{
			Name:  "repo.private",
			Usage: "repo private",
			Sources: cli.EnvVars(
				"CI_REPO_PRIVATE",
				"DRONE_REPO_PRIVATE",
			),
		},
		&cli.StringFlag{
			Name:  "repo.default-branch",
			Usage: "repo default branch",
			Sources: cli.EnvVars(
				"CI_REPO_DEFAULT_BRANCH",
				"DRONE_REPO_BRANCH",
			),
		},
	}
}

func repositoryFromContext(c *cli.Command) Repository {
	return Repository{
		RemoteID:      c.String("repo.remote-id"),
		Name:          c.String("repo.name"),
		Owner:         c.String("repo.owner"),
		URL:           c.String("repo.url"),
		Link:          c.String("repo.url"),
		CloneURL:      c.String("repo.clone-url"),
		Private:       c.Bool("repo.private"),
		Branch:        c.String("repo.default-branch"),
		DefaultBranch: c.String("repo.default-branch"),
	}
}