github

No long description provided.

Installation

dagger install github.com/shykes/melvin/github@2cbe8a14772fedf250c33e992a5e73b2f1d2ee78

Entrypoint

Return Type

Github

Example

dagger -m github.com/shykes/melvin/github@2cbe8a14772fedf250c33e992a5e73b2f1d2ee78 call \

func (m *myModule) example() *Github  {
	return dag.
			Github()
}

@function
def example() -> dag.Github:
	return (
		dag.github()
	)

@func()
example(): Github {
	return dag
		.github()
}

Types

Github 🔗

newProgressReport() 🔗

NewProgressReport creates a new progress report for tracking tasks on a GitHub issue

Return Type

ProgressReport !

Arguments

Name	Type	Default Value	Description
key	String !	-	A unique identifier for this progress report in the given issue. Using the same key on the same issue will overwrite the same comment in the issue
token	Secret !	-	GitHub authentication token
repo	String !	-	Github repository to send updates
issue	Integer !	-	Issue number to report progress on

Example

dagger -m github.com/shykes/melvin/github@2cbe8a14772fedf250c33e992a5e73b2f1d2ee78 call \
 new-progress-report --key string --token env:MYSECRET --repo string --issue integer

func (m *myModule) example(key string, token *Secret, repo string, issue int) *GithubProgressReport  {
	return dag.
			Github().
			NewProgressReport(key, token, repo, issue)
}

@function
def example(key: str, token: dagger.Secret, repo: str, issue: int) -> dag.GithubProgressReport:
	return (
		dag.github()
		.new_progress_report(key, token, repo, issue)
	)

@func()
example(key: string, token: Secret, repo: string, issue: number): GithubProgressReport {
	return dag
		.github()
		.newProgressReport(key, token, repo, issue)
}

ProgressReport 🔗

A system for reporting on the progress of a task on a github issue

token() 🔗

Return Type

Secret !

Example

dagger -m github.com/shykes/melvin/github@2cbe8a14772fedf250c33e992a5e73b2f1d2ee78 call \
 new-progress-report --key string --token env:MYSECRET --repo string --issue integer \
 token

func (m *myModule) example(key string, token *Secret, repo string, issue int) *Secret  {
	return dag.
			Github().
			NewProgressReport(key, token, repo, issue).
			Token()
}

@function
def example(key: str, token: dagger.Secret, repo: str, issue: int) -> dagger.Secret:
	return (
		dag.github()
		.new_progress_report(key, token, repo, issue)
		.token()
	)

@func()
example(key: string, token: Secret, repo: string, issue: number): Secret {
	return dag
		.github()
		.newProgressReport(key, token, repo, issue)
		.token()
}

issue() 🔗

Return Type

Issue !

Example

dagger -m github.com/shykes/melvin/github@2cbe8a14772fedf250c33e992a5e73b2f1d2ee78 call \
 new-progress-report --key string --token env:MYSECRET --repo string --issue integer \
 issue

func (m *myModule) example(key string, token *Secret, repo string, issue int) *GithubIssue  {
	return dag.
			Github().
			NewProgressReport(key, token, repo, issue).
			Issue()
}

@function
def example(key: str, token: dagger.Secret, repo: str, issue: int) -> dag.GithubIssue:
	return (
		dag.github()
		.new_progress_report(key, token, repo, issue)
		.issue()
	)

@func()
example(key: string, token: Secret, repo: string, issue: number): GithubIssue {
	return dag
		.github()
		.newProgressReport(key, token, repo, issue)
		.issue()
}

title() 🔗

Return Type

String !

Example

dagger -m github.com/shykes/melvin/github@2cbe8a14772fedf250c33e992a5e73b2f1d2ee78 call \
 new-progress-report --key string --token env:MYSECRET --repo string --issue integer \
 title

func (m *myModule) example(ctx context.Context, key string, token *Secret, repo string, issue int) string  {
	return dag.
			Github().
			NewProgressReport(key, token, repo, issue).
			Title(ctx)
}

@function
async def example(key: str, token: dagger.Secret, repo: str, issue: int) -> str:
	return await (
		dag.github()
		.new_progress_report(key, token, repo, issue)
		.title()
	)

@func()
async example(key: string, token: Secret, repo: string, issue: number): Promise<string> {
	return dag
		.github()
		.newProgressReport(key, token, repo, issue)
		.title()
}

summary() 🔗

Return Type

String !

Example

dagger -m github.com/shykes/melvin/github@2cbe8a14772fedf250c33e992a5e73b2f1d2ee78 call \
 new-progress-report --key string --token env:MYSECRET --repo string --issue integer \
 summary

func (m *myModule) example(ctx context.Context, key string, token *Secret, repo string, issue int) string  {
	return dag.
			Github().
			NewProgressReport(key, token, repo, issue).
			Summary(ctx)
}

@function
async def example(key: str, token: dagger.Secret, repo: str, issue: int) -> str:
	return await (
		dag.github()
		.new_progress_report(key, token, repo, issue)
		.summary()
	)

@func()
async example(key: string, token: Secret, repo: string, issue: number): Promise<string> {
	return dag
		.github()
		.newProgressReport(key, token, repo, issue)
		.summary()
}

tasks() 🔗

Return Type

[Task ! ] !

Example

dagger -m github.com/shykes/melvin/github@2cbe8a14772fedf250c33e992a5e73b2f1d2ee78 call \
 new-progress-report --key string --token env:MYSECRET --repo string --issue integer \
 tasks

func (m *myModule) example(key string, token *Secret, repo string, issue int) []*GithubTask  {
	return dag.
			Github().
			NewProgressReport(key, token, repo, issue).
			Tasks()
}

@function
def example(key: str, token: dagger.Secret, repo: str, issue: int) -> List[dag.GithubTask]:
	return (
		dag.github()
		.new_progress_report(key, token, repo, issue)
		.tasks()
	)

@func()
example(key: string, token: Secret, repo: string, issue: number): GithubTask[] {
	return dag
		.github()
		.newProgressReport(key, token, repo, issue)
		.tasks()
}

writeSummary() 🔗

Write a new summary for the progress report. Any previous summary is overwritten. This function only stages the change. Call publish to actually apply it.

Return Type

ProgressReport !

Arguments

Name	Type	Default Value	Description
summary	String !	-	The text of the summary, markdown-formatted It will be formatted as-is in the comment, after the title and before the task list

Example

dagger -m github.com/shykes/melvin/github@2cbe8a14772fedf250c33e992a5e73b2f1d2ee78 call \
 new-progress-report --key string --token env:MYSECRET --repo string --issue integer \
 write-summary --summary string

func (m *myModule) example(key string, token *Secret, repo string, issue int, summary string) *GithubProgressReport  {
	return dag.
			Github().
			NewProgressReport(key, token, repo, issue).
			WriteSummary(summary)
}

@function
def example(key: str, token: dagger.Secret, repo: str, issue: int, summary: str) -> dag.GithubProgressReport:
	return (
		dag.github()
		.new_progress_report(key, token, repo, issue)
		.write_summary(summary)
	)

@func()
example(key: string, token: Secret, repo: string, issue: number, summary: string): GithubProgressReport {
	return dag
		.github()
		.newProgressReport(key, token, repo, issue)
		.writeSummary(summary)
}

appendSummary() 🔗

Append new text to the summary, without overwriting it This function only stages the change. Call publish to actually apply it.

Return Type

ProgressReport !

Arguments

Name	Type	Default Value	Description
summary	String !	-	The text of the summary, markdown-formatted It will be formatted as-is in the comment, after the title and before the task list

Example

dagger -m github.com/shykes/melvin/github@2cbe8a14772fedf250c33e992a5e73b2f1d2ee78 call \
 new-progress-report --key string --token env:MYSECRET --repo string --issue integer \
 append-summary --summary string

func (m *myModule) example(key string, token *Secret, repo string, issue int, summary string) *GithubProgressReport  {
	return dag.
			Github().
			NewProgressReport(key, token, repo, issue).
			AppendSummary(summary)
}

@function
def example(key: str, token: dagger.Secret, repo: str, issue: int, summary: str) -> dag.GithubProgressReport:
	return (
		dag.github()
		.new_progress_report(key, token, repo, issue)
		.append_summary(summary)
	)

@func()
example(key: string, token: Secret, repo: string, issue: number, summary: string): GithubProgressReport {
	return dag
		.github()
		.newProgressReport(key, token, repo, issue)
		.appendSummary(summary)
}

startTask() 🔗

Report the starting of a new task This function only stages the change. Call publish to actually apply it.

Return Type

ProgressReport !

Arguments

Name	Type	Default Value	Description
key	String !	-	A unique key for the task. Not sent in the comment. Use to update the task status later.
description	String !	-	The task description. It will be formatted as a cell in the first column of a markdown table
status	String !	-	The task status. It will be formatted as a cell in the second column of a markdown table

Example

dagger -m github.com/shykes/melvin/github@2cbe8a14772fedf250c33e992a5e73b2f1d2ee78 call \
 new-progress-report --key string --token env:MYSECRET --repo string --issue integer \
 start-task --key string --description string --status string

func (m *myModule) example(key string, token *Secret, repo string, issue int, key1 string, description string, status string) *GithubProgressReport  {
	return dag.
			Github().
			NewProgressReport(key, token, repo, issue).
			StartTask(key1, description, status)
}

@function
def example(key: str, token: dagger.Secret, repo: str, issue: int, key1: str, description: str, status: str) -> dag.GithubProgressReport:
	return (
		dag.github()
		.new_progress_report(key, token, repo, issue)
		.start_task(key1, description, status)
	)

@func()
example(key: string, token: Secret, repo: string, issue: number, key1: string, description: string, status: string): GithubProgressReport {
	return dag
		.github()
		.newProgressReport(key, token, repo, issue)
		.startTask(key1, description, status)
}

writeTitle() 🔗

Write a new title for the progress report. Any previous title is overwritten. This function only stages the change. Call publish to actually apply it.

Return Type

ProgressReport !

Arguments

Name	Type	Default Value	Description
title	String !	-	The summary. It should be a single line of unformatted text. It will be formatted as a H2 title in the markdown body of the comment

Example

dagger -m github.com/shykes/melvin/github@2cbe8a14772fedf250c33e992a5e73b2f1d2ee78 call \
 new-progress-report --key string --token env:MYSECRET --repo string --issue integer \
 write-title --title string

func (m *myModule) example(key string, token *Secret, repo string, issue int, title string) *GithubProgressReport  {
	return dag.
			Github().
			NewProgressReport(key, token, repo, issue).
			WriteTitle(title)
}

@function
def example(key: str, token: dagger.Secret, repo: str, issue: int, title: str) -> dag.GithubProgressReport:
	return (
		dag.github()
		.new_progress_report(key, token, repo, issue)
		.write_title(title)
	)

@func()
example(key: string, token: Secret, repo: string, issue: number, title: string): GithubProgressReport {
	return dag
		.github()
		.newProgressReport(key, token, repo, issue)
		.writeTitle(title)
}

updateTask() 🔗

Update the status of a task This function only stages the change. Call publish to actually apply it.

Return Type

ProgressReport !

Arguments

Name	Type	Default Value	Description
key	String !	-	A unique key for the task. Use to update the task status later.
status	String !	-	The task status. It will be formatted as a cell in the second column of a markdown table

Example

dagger -m github.com/shykes/melvin/github@2cbe8a14772fedf250c33e992a5e73b2f1d2ee78 call \
 new-progress-report --key string --token env:MYSECRET --repo string --issue integer \
 update-task --key string --status string

func (m *myModule) example(key string, token *Secret, repo string, issue int, key1 string, status string) *GithubProgressReport  {
	return dag.
			Github().
			NewProgressReport(key, token, repo, issue).
			UpdateTask(key1, status)
}

@function
def example(key: str, token: dagger.Secret, repo: str, issue: int, key1: str, status: str) -> dag.GithubProgressReport:
	return (
		dag.github()
		.new_progress_report(key, token, repo, issue)
		.update_task(key1, status)
	)

@func()
example(key: string, token: Secret, repo: string, issue: number, key1: string, status: string): GithubProgressReport {
	return dag
		.github()
		.newProgressReport(key, token, repo, issue)
		.updateTask(key1, status)
}

publish() 🔗

Publish all staged changes to the status update. This will cause a single comment on the target issue to be either created, or updated in-place.

Return Type

Void !

Example

dagger -m github.com/shykes/melvin/github@2cbe8a14772fedf250c33e992a5e73b2f1d2ee78 call \
 new-progress-report --key string --token env:MYSECRET --repo string --issue integer \
 publish

func (m *myModule) example(ctx context.Context, key string, token *Secret, repo string, issue int)   {
	return dag.
			Github().
			NewProgressReport(key, token, repo, issue).
			Publish(ctx)
}

@function
async def example(key: str, token: dagger.Secret, repo: str, issue: int) -> None:
	return await (
		dag.github()
		.new_progress_report(key, token, repo, issue)
		.publish()
	)

@func()
async example(key: string, token: Secret, repo: string, issue: number): Promise<void> {
	return dag
		.github()
		.newProgressReport(key, token, repo, issue)
		.publish()
}

Issue 🔗

issueNumber() 🔗

Return Type

Integer !

Example

Function GithubIssue.issueNumber is not accessible from the github module

Function GithubIssue.issueNumber is not accessible from the github module

Function GithubIssue.issueNumber is not accessible from the github module

Function GithubIssue.issueNumber is not accessible from the github module

title() 🔗

Return Type

String !

Example

Function GithubIssue.title is not accessible from the github module

Function GithubIssue.title is not accessible from the github module

Function GithubIssue.title is not accessible from the github module

Function GithubIssue.title is not accessible from the github module

body() 🔗

Return Type

String !

Example

Function GithubIssue.body is not accessible from the github module

Function GithubIssue.body is not accessible from the github module

Function GithubIssue.body is not accessible from the github module

Function GithubIssue.body is not accessible from the github module

Task 🔗

key() 🔗

Return Type

String !

Example

Function GithubTask.key is not accessible from the github module

Function GithubTask.key is not accessible from the github module

Function GithubTask.key is not accessible from the github module

Function GithubTask.key is not accessible from the github module

description() 🔗

Return Type

String !

Example

Function GithubTask.description is not accessible from the github module

Function GithubTask.description is not accessible from the github module

Function GithubTask.description is not accessible from the github module

Function GithubTask.description is not accessible from the github module

status() 🔗

Return Type

String !

Example

Function GithubTask.status is not accessible from the github module

Function GithubTask.status is not accessible from the github module

Function GithubTask.status is not accessible from the github module

Function GithubTask.status is not accessible from the github module