godoc Integration

[BenLloydPearson]

Review godoc Changes

Automation Name: review_godoc

Auto-approve PRs that only change godoc content.

Conditions (all must be true):

• The PR only contains changes to godoc content.

Automation Actions:

• Assign the org/tech-writers team for optional review.
• Apply a green 📓 godoc Only label
• Approve the PR

Review Golang Input Parameters for godoc Changes

Automation Name: review_godoc_input

If a PR modifies the input parameters for a Golang method, but not the associated godocs, notify reviewers to check for godoc updates.

Conditions (all must be true):

• The PR changes one or more input parameters in Golang methods.
• The PR lacks changes to ‘@param’ declarations.

Automation Actions:

• Post a comment warning the user to review the method’s godoc to identify necessary updates.

Review godoc for Large Changes

Automation Name: review_godoc_large

Require more extensive reviews for large Golang changes that lack godoc updates.

Conditions (all must be true):

• The PR changes more than 25% of a Golang class.
• The PR lacks a review from someone on the org/tech-writers team.
• The PR lacks godoc changes.

Automation Actions:

• Post a comment asking the author to review all relevant godoc to identify necessary updates.
• Require a review from the my-organization/tech-writers team.
• Apply a yellow ⚠️ Missing godoc Label

Enforce godoc Requirements for New Classes

Automation Name: review_godoc_new_class

Automatically request changes when someone creates a new Golang class that lacks godoc content.

Conditions (all must be true):

• The PR creates a new Golang class.
• The PR lacks godoc content.

Automation Actions:

• Apply a ⚠️ Missing godoc label.
• Request changes, and post a comment explaining that godoc is required

Related Examples

https://docs.gitstream.cm/integrations/javadoc
https://docs.gitstream.cm/integrations/jsdoc

[BenLloydPearson]

https://docs.gitstream.cm/integrations/godoc