Skip to content

Commit

Permalink
godoc: reformat to go 1.19 format
Browse files Browse the repository at this point in the history
Reformat the godoc to be inline with the new format introduced with go 1.19
  • Loading branch information
fho committed Sep 22, 2022
1 parent faa80b4 commit 24465f0
Show file tree
Hide file tree
Showing 3 changed files with 31 additions and 25 deletions.
52 changes: 29 additions & 23 deletions internal/autoupdate/autoupdate.go
Original file line number Diff line number Diff line change
Expand Up @@ -215,33 +215,39 @@ func (a *Autoupdater) eventLoop() {
//
// The following actions are triggered on events:
//
// - Enqueue a pull request on:
// - PullRequestEvent auto_merge_enabled
// - PullRequestEvent labeled
// Enqueue a pull request on:
//
// - Dequeue a pull request on:
// - PullRequestEvent closed
// - PullRequestEvent auto_merge_disabled
// - PullRequestEvent unlabeled
// - PullRequestEvent auto_merge_enabled
// - PullRequestEvent labeled
//
// - Move a pull request to another base branch queue on:
// - PullRequestEvent edited and Base object is set
// Dequeue a pull request on
//
// - Resume updates for a suspended pull request on:
// - PullRequestEvent synchronize for the pr branch
// - PushEvent for it's base-branch
// - StatusEvent with success state and the StatusCheckRollup is successful and ReviewDecision approved.
// - CheckRunEvent with a neutral, success or skipped check conclusion and
// the StatusCheckRollup is successful and ReviewDecision approved.
// - PullRequestReviewEvent with action submitted and state approved
// - PullRequestEvent closed
// - PullRequestEvent auto_merge_disabled
// - PullRequestEvent unlabeled
//
// - Trigger update with base-branch on:
// - PushEvent for a base branch
// - (updates for pull request branches on git-push are triggered via
// PullRequest synchronize events)
// - StatusEvent with error or failure state
// - CheckRunEvent with cancelled, failure, timed_out or action_required
// conclusion
// Move a pull request to another base branch queue on:
//
// - PullRequestEvent edited and Base object is set
//
// Resume updates for a suspended pull request on:
//
// - PullRequestEvent synchronize for the pr branch
// - PushEvent for it's base-branch
// - StatusEvent with success state and the StatusCheckRollup is successful
// and ReviewDecision approved.
// - CheckRunEvent with a neutral, success or skipped check conclusion and
// the StatusCheckRollup is successful and ReviewDecision approved.
// - PullRequestReviewEvent with action submitted and state approved
//
// Trigger update with base-branch on:
//
// - PushEvent for a base branch
// - (updates for pull request branches on git-push are triggered via
// PullRequest synchronize events)
// - StatusEvent with error or failure state
// - CheckRunEvent with cancelled, failure, timed_out or action_required
// conclusion
//
// Other events are ignored and a debug message is logged for those.
func (a *Autoupdater) processEvent(ctx context.Context, event *github_prov.Event) {
Expand Down
3 changes: 1 addition & 2 deletions internal/autoupdate/doc.go
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,7 @@
// pull requests are removed from the autoupdate queue, when it was closed, or
// an inverse trigger event (auto_merge_disabled, unlabeled) was received.
//
//
// Components
// # Components
//
// The main components are the queue and autoupdater.
//
Expand Down
1 change: 1 addition & 0 deletions internal/autoupdate/httpservice.go
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ import (
)

// templFS contains the web pages.
//
//go:embed pages/templates/*
var templFS embed.FS

Expand Down

0 comments on commit 24465f0

Please sign in to comment.