githubImpl

Documentation

Overview

Package githubImpl implements the zedpm-plugin-github plugin.

Index

• type Plugin
  • func (p *Plugin) Cancel(ctx context.Context, task plugin.Task) error
  • func (p *Plugin) Complete(ctx context.Context, task plugin.Task) error
  • func (p *Plugin) Goal(context.Context, string) (plugin.GoalDescription, error)
  • func (p *Plugin) Implements(context.Context) ([]plugin.TaskDescription, error)
  • func (p *Plugin) Prepare(_ context.Context, task string) (plugin.Task, error)
• type ReleaseMintTask
  • func (s *ReleaseMintTask) CreateGithubPullRequest(ctx context.Context) error
  • func (s *ReleaseMintTask) End(context.Context) (plugin.Operations, error)
  • func (s *ReleaseMintTask) Setup(ctx context.Context) error
• type ReleasePublishTask
  • func (f *ReleasePublishTask) Check(ctx context.Context) error
  • func (f *ReleasePublishTask) CheckReadyForMerge(ctx context.Context) error
  • func (f *ReleasePublishTask) CreateRelease(ctx context.Context) error
  • func (f *ReleasePublishTask) End(context.Context) (plugin.Operations, error)
  • func (f *ReleasePublishTask) MergePullRequest(ctx context.Context) error
  • func (s *ReleasePublishTask) Setup(ctx context.Context) error

Types

type Plugin

type Plugin struct{}

Plugin implements plugin.Interface for handling github-related tasks.

func (*Plugin) Cancel

func (p *Plugin) Cancel(ctx context.Context, task plugin.Task) error

Cancel is a no-op.

func (*Plugin) Complete

func (p *Plugin) Complete(ctx context.Context, task plugin.Task) error

Complete is a no-op.

func (*Plugin) Goal

func (p *Plugin) Goal(context.Context, string) (plugin.GoalDescription, error)

Goal returns plugin.ErrUnsupportedGoal.

func (*Plugin) Implements

func (p *Plugin) Implements(context.Context) ([]plugin.TaskDescription, error)

Implements returns the task descriptions for the /release/mint/github and /release/publish/github tasks.

func (*Plugin) Prepare

func (p *Plugin) Prepare(
	_ context.Context,
	task string,
) (plugin.Task, error)

Prepare returns the implemented tasks.

type ReleaseMintTask

type ReleaseMintTask struct {
	plugin.TaskBoilerplate
	zGithub.Github
}

ReleaseMintTask implements the /release/mint/github task.

func (*ReleaseMintTask) CreateGithubPullRequest

func (s *ReleaseMintTask) CreateGithubPullRequest(ctx context.Context) error

CreateGithubPullRequest creates the PR on github for monitoring the test results for release testing. This will also be used to merge the release branch when testing passes.

func (*ReleaseMintTask) End

func (s *ReleaseMintTask) End(context.Context) (plugin.Operations, error)

End configures CreateGithubPullRequest to run.

func (*ReleaseMintTask) Setup

func (s *ReleaseMintTask) Setup(ctx context.Context) error

Setup configures the github and git clients.

type ReleasePublishTask

type ReleasePublishTask struct {
	plugin.TaskBoilerplate
	zGithub.Github
}

ReleasePublishTask implements the /release/publish/github task.

func (*ReleasePublishTask) Check

func (f *ReleasePublishTask) Check(ctx context.Context) error

Check executes CheckReadyForMerge in a loop until either the Github checks pass or 15 minutes have elapsed, whichever comes first.

func (*ReleasePublishTask) CheckReadyForMerge

func (f *ReleasePublishTask) CheckReadyForMerge(ctx context.Context) error

CheckReadyForMerge ensures that all the required tests are passing.

func (*ReleasePublishTask) CreateRelease

func (f *ReleasePublishTask) CreateRelease(ctx context.Context) error

CreateRelease creates a release on github for the release.

func (*ReleasePublishTask) End

func (f *ReleasePublishTask) End(context.Context) (plugin.Operations, error)

Run configures MergePullRequest and CreateRelease to run.

func (*ReleasePublishTask) MergePullRequest

func (f *ReleasePublishTask) MergePullRequest(ctx context.Context) error

MergePullRequest merges the PR into master.

func (*ReleasePublishTask) Setup

func (s *ReleasePublishTask) Setup(ctx context.Context) error

Setup configures the github and git clients.