gh

package
v0.30.2 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Feb 21, 2024 License: MIT Imports: 15 Imported by: 0

Documentation

Overview

package gh contains github related actions

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func ActionAuthScopes added in v0.25.2 

func ActionAuthScopes() carapace.Action

ActionAuthScopes completes authentication scopes 

admin:gpg_key (Fully manage GPG keys)
admin:org (Fully manage the organization and its teams, projects, and memberships)

func ActionCacheFields added in v0.28.0 

func ActionCacheFields() carapace.Action

ActionCacheFields completes label fields 

id
key

func ActionCaches added in v0.25.2 

func ActionCaches(opts RepoOpts) carapace.Action

ActionCaches completes caches 

41 (refs/pull/1718/merge)
42 (refs/heads/master)

func ActionCodespaceViewFields added in v0.25.0 

func ActionCodespaceViewFields() carapace.Action

ActionCodespaceViewFields completes codespace fields for view

func ActionCommitFields added in v0.21.0 

func ActionCommitFields() carapace.Action

ActionCommitFields completes commit fields 

author
commit

func ActionConfigHosts added in v0.11.3 

func ActionConfigHosts() carapace.Action

ActionConfigHosts completes configured hosts 

github.com
another.com

func ActionConfigUsers added in v0.29.0 

func ActionConfigUsers(host string) carapace.Action

ActionConfigUsers completes configured users 

userA
userB

func ActionContents added in v0.13.5 

func ActionContents(opts ContentOpts) carapace.Action

ActionContents completes contents 

/README.md
/.github/workflows/go.yml

func ActionCurrentAuthScopes added in v0.25.2 

func ActionCurrentAuthScopes(hostname string) carapace.Action

ActionCurrentAuthScopes completes current authentication scopes for given hostname 

admin:gpg_key (Fully manage GPG keys)
admin:org (Fully manage the organization and its teams, projects, and memberships)

func ActionDateFields added in v0.21.0 

func ActionDateFields() carapace.Action

ActionDateFields completes date fields 

<=2023-01-01
2022-01-01...2023-01-01

func ActionDeployKeyFields added in v0.28.0 

func ActionDeployKeyFields() carapace.Action

ActionDeployKeyFields completes deploy key fields 

id
key

func ActionEmojis added in v0.20.0 

func ActionEmojis() carapace.Action

ActionEmojis completes emoji names 

100 (💯 hundred points)
1234 (🔢 input numbers)

func ActionEnvironmentVariables added in v0.24.0 

func ActionEnvironmentVariables(opts EnvironmentOpts) carapace.Action

ActionEnvironmentVariables completes environment variables 

first (value1)
second (value2)

func ActionGpgKeys added in v0.18.0 

func ActionGpgKeys(opts HostOpts) carapace.Action

ActionGpgKeys completes gpg keys 

AABBCCDDEEFF112 (example)
AABBCCDDEEFF113 (another)

func ActionIssueTemplates added in v0.24.0 

func ActionIssueTemplates(opts RepoOpts) carapace.Action

ActionIssueTemplates completes issue templates 

⭐ Submit a request (Surface a feature or problem that you think should be solved)
🐛 Bug report (Report a bug or unexpected behavior while using GitHub CLI)

func ActionLabelFields added in v0.12.4 

func ActionLabelFields() carapace.Action

ActionLabelFields completes label fields 

color
createdAt

func ActionLabels added in v0.12.4 

func ActionLabels(opts RepoOpts) carapace.Action

ActionLabels completes labels 

enhancement (New feature or request)
good first issue (Good for newcomers)

func ActionLicenses added in v0.12.4 

func ActionLicenses(opts HostOpts) carapace.Action

ActionLicenses completes licenses 

apache-2.0 (Apache License 2.0)
bsd-2-clause (BSD 2-Clause "Simplified" License)

func ActionOrganisationVariables added in v0.24.0 

func ActionOrganisationVariables(opts OwnerOpts) carapace.Action

ActionOrganisationVariables completes organisation variables 

first (value1)
second (value2)

func ActionOrganizations added in v0.12.5 

func ActionOrganizations(opts HostOpts) carapace.Action

ActionOrganizations completes organizations 

org (organization name)
another (another name)

func ActionOwnerRepositories 

func ActionOwnerRepositories(opts HostOpts) carapace.Action

ActionOwnerRepositories completes owner/repository 

rsteube/carapace
spf13/cobra

func ActionOwners added in v0.12.5 

func ActionOwners(opts HostOpts) carapace.Action

ActionOwners completes users and organizations 

user (user name)
org (organization name)

func ActionPinnedIssues added in v0.12.4 

func ActionPinnedIssues(opts RepoOpts) carapace.Action

ActionPinnedIssues completes pinned issues 

11 (issue description)
12 (issue description)

func ActionProjectItems added in v0.25.0 

func ActionProjectItems(opts ProjectItemOpts) carapace.Action

ActionProjectItems completes project items 

PVTI_lADOA48Fh84ABd_DzgBCG7c (Issue commands do not work with non-classic Projects)
PVTI_lADOA48Fh84ABd_DzgBCHAo (Checkout branch for issue)

func ActionProjects added in v0.25.0 

func ActionProjects(opts ProjectOpts) carapace.Action

ActionProjects completes projects 

1 (first project)
2 (second project)

func ActionPullRequestTemplates added in v0.24.0 

func ActionPullRequestTemplates(opts RepoOpts) carapace.Action

ActionPullRequestTemplates completes pull request templates 

PULL_REQUEST_TEMPLATE.md (content)

func ActionReleaseFields added in v0.30.2 

func ActionReleaseFields() carapace.Action

ActionReleaseFields completes release fields 

name
tagName

func ActionRepositories added in v0.12.4 

func ActionRepositories(opts OwnerOpts) carapace.Action

ActionRepositories completes repositories 

carapace (command argument completion generator for spf13/cobra)
carapace-bin (multi-shell multi-command argument completer)

func ActionRepositoryVariables added in v0.24.0 

func ActionRepositoryVariables(opts RepoOpts) carapace.Action

ActionRepositoryVariables completes repository variables 

first (value1)
second (value2)

func ActionRulesets added in v0.25.2 

func ActionRulesets(opts RepoOpts) carapace.Action

ActionRulesets completes rulesets 

1 (Rules)
2 (Another)

func ActionSecretFields added in v0.28.0 

func ActionSecretFields() carapace.Action

ActionSecretFields completes secret fields 

name
visibility

func ActionSshKeys added in v0.18.0 

func ActionSshKeys(opts HostOpts) carapace.Action

ActionSshKeys completes ssh keys 

12345678 (title)
23456789 (another)

func ActionUsers added in v0.8.2 

func ActionUsers(opts HostOpts) carapace.Action

ActionUsers completes users 

user (user name)
another (another name)

func ActionVariableFields added in v0.30.2 

func ActionVariableFields() carapace.Action

ActionVariableFields completes variable fields 

name
value

func ActionWorkflowEvents added in v0.24.5 

func ActionWorkflowEvents() carapace.Action

ActionWorkflowEvents completes events triggering a workflow 

create
delete

func ActionWorkflowFields added in v0.28.0 

func ActionWorkflowFields() carapace.Action

ActionWorkflowFields completes workflow fields.

Types

type ContentOpts added in v0.13.5 

type ContentOpts struct {
	Host   string
	Owner  string
	Name   string
	Branch string
	Path   string // TODO should be handled using `Context.Value`
}

type EnvironmentOpts added in v0.24.0 

type EnvironmentOpts struct {
	Host        string
	Owner       string
	Name        string
	Environment string
}

type HostOpts added in v0.12.4 

type HostOpts struct {
	Host string
}

type OwnerOpts added in v0.12.4 

type OwnerOpts struct {
	Host  string
	Owner string
}

type ProjectItemOpts added in v0.25.0 

type ProjectItemOpts struct {
	Host     string
	Owner    string
	Project  int
	Archived bool
}

type ProjectOpts added in v0.25.0 

type ProjectOpts struct {
	Host   string
	Owner  string
	Open   bool
	Closed bool
}

func (ProjectOpts) Default added in v0.25.0 

func (o ProjectOpts) Default() ProjectOpts

type RepoOpts added in v0.12.4 

type RepoOpts struct {
	Host  string
	Owner string
	Name  string
}

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.