Dagger
Search

github-issue

A generated module for GithubIssue functions

Installation

dagger install github.com/kpenfound/dag/github-issue@c6809821f7133cc03bea4290fbe81212e25338c8

Entrypoint

Return Type 
GithubIssue !
Arguments
NameTypeDefault ValueDescription
tokenSecret !-Github authentication token
Example
dagger -m github.com/kpenfound/dag/github-issue@c6809821f7133cc03bea4290fbe81212e25338c8 call \
 --token env:MYSECRET
func (m *MyModule) Example(token *dagger.Secret) *dagger.GithubIssue  {
	return dag.
			GithubIssue(token)
}
@function
def example(token: dagger.Secret) -> dagger.GithubIssue:
	return (
		dag.github_issue(token)
	)
@func()
example(token: Secret): GithubIssue {
	return dag
		.githubIssue(token)
}

Types

GithubIssue 🔗

read() 🔗

Returns a container that echoes whatever string argument is provided

Return Type 
GithubIssueData !
Arguments
NameTypeDefault ValueDescription
repoString !-No description provided
issueIdInteger !-No description provided
Example
dagger -m github.com/kpenfound/dag/github-issue@c6809821f7133cc03bea4290fbe81212e25338c8 call \
 --token env:MYSECRET read --repo string --issue-id integer
func (m *MyModule) Example(token *dagger.Secret, repo string, issueId int) *dagger.GithubIssueData  {
	return dag.
			GithubIssue(token).
			Read(repo, issueId)
}
@function
def example(token: dagger.Secret, repo: str, issue_id: int) -> dagger.GithubIssueData:
	return (
		dag.github_issue(token)
		.read(repo, issue_id)
	)
@func()
example(token: Secret, repo: string, issueId: number): GithubIssueData {
	return dag
		.githubIssue(token)
		.read(repo, issueId)
}

write() 🔗

TODO: Not yet implemented

Return Type 
GithubIssueData !
Arguments
NameTypeDefault ValueDescription
repoString !-No description provided
titleString !-No description provided
bodyString !-No description provided
Example
dagger -m github.com/kpenfound/dag/github-issue@c6809821f7133cc03bea4290fbe81212e25338c8 call \
 --token env:MYSECRET write --repo string --title string --body string
func (m *MyModule) Example(token *dagger.Secret, repo string, title string, body string) *dagger.GithubIssueData  {
	return dag.
			GithubIssue(token).
			Write(repo, title, body)
}
@function
def example(token: dagger.Secret, repo: str, title: str, body: str) -> dagger.GithubIssueData:
	return (
		dag.github_issue(token)
		.write(repo, title, body)
	)
@func()
example(token: Secret, repo: string, title: string, body: string): GithubIssueData {
	return dag
		.githubIssue(token)
		.write(repo, title, body)
}

GithubIssueData 🔗

issueNumber() 🔗

Return Type 
Integer !
Example
dagger -m github.com/kpenfound/dag/github-issue@c6809821f7133cc03bea4290fbe81212e25338c8 call \
 write --repo string --title string --body string \
 issue-number
func (m *MyModule) Example(ctx context.Context, repo string, title string, body string) int  {
	return dag.
			GithubIssue().
			Write(repo, title, body).
			IssueNumber(ctx)
}
@function
async def example(repo: str, title: str, body: str) -> int:
	return await (
		dag.github_issue()
		.write(repo, title, body)
		.issue_number()
	)
@func()
async example(repo: string, title: string, body: string): Promise<number> {
	return dag
		.githubIssue()
		.write(repo, title, body)
		.issueNumber()
}

title() 🔗

Return Type 
String !
Example
dagger -m github.com/kpenfound/dag/github-issue@c6809821f7133cc03bea4290fbe81212e25338c8 call \
 write --repo string --title string --body string \
 title
func (m *MyModule) Example(ctx context.Context, repo string, title string, body string) string  {
	return dag.
			GithubIssue().
			Write(repo, title, body).
			Title(ctx)
}
@function
async def example(repo: str, title: str, body: str) -> str:
	return await (
		dag.github_issue()
		.write(repo, title, body)
		.title()
	)
@func()
async example(repo: string, title: string, body: string): Promise<string> {
	return dag
		.githubIssue()
		.write(repo, title, body)
		.title()
}

body() 🔗

Return Type 
String !
Example
dagger -m github.com/kpenfound/dag/github-issue@c6809821f7133cc03bea4290fbe81212e25338c8 call \
 write --repo string --title string --body string \
 body
func (m *MyModule) Example(ctx context.Context, repo string, title string, body string) string  {
	return dag.
			GithubIssue().
			Write(repo, title, body).
			Body(ctx)
}
@function
async def example(repo: str, title: str, body: str) -> str:
	return await (
		dag.github_issue()
		.write(repo, title, body)
		.body()
	)
@func()
async example(repo: string, title: string, body: string): Promise<string> {
	return dag
		.githubIssue()
		.write(repo, title, body)
		.body()
}

headRef() 🔗

Return Type 
String !
Example
dagger -m github.com/kpenfound/dag/github-issue@c6809821f7133cc03bea4290fbe81212e25338c8 call \
 write --repo string --title string --body string \
 head-ref
func (m *MyModule) Example(ctx context.Context, repo string, title string, body string) string  {
	return dag.
			GithubIssue().
			Write(repo, title, body).
			HeadRef(ctx)
}
@function
async def example(repo: str, title: str, body: str) -> str:
	return await (
		dag.github_issue()
		.write(repo, title, body)
		.head_ref()
	)
@func()
async example(repo: string, title: string, body: string): Promise<string> {
	return dag
		.githubIssue()
		.write(repo, title, body)
		.headRef()
}

baseRef() 🔗

Return Type 
String !
Example
dagger -m github.com/kpenfound/dag/github-issue@c6809821f7133cc03bea4290fbe81212e25338c8 call \
 write --repo string --title string --body string \
 base-ref
func (m *MyModule) Example(ctx context.Context, repo string, title string, body string) string  {
	return dag.
			GithubIssue().
			Write(repo, title, body).
			BaseRef(ctx)
}
@function
async def example(repo: str, title: str, body: str) -> str:
	return await (
		dag.github_issue()
		.write(repo, title, body)
		.base_ref()
	)
@func()
async example(repo: string, title: string, body: string): Promise<string> {
	return dag
		.githubIssue()
		.write(repo, title, body)
		.baseRef()
}