How to Customize Sticky Comments

Get instructions on customizing sticky comments in Aviator with a configuration example. Sticky comments can provide you with the status of a PR within GitHub.

Aviator uses sticky comments to give you the status of a PR within GitHub.

You can customize the sticky comment to show up when the PR is created, when it’s ready for review, or when it’s queued. You can also add your custom messages that could be helpful to link your own FAQs or self help documents for your team.

Here’s a sample config, see merge_rules.status_comment in the schema documentation.

merge_rules:
  status_comment:
    # Optional. Valid values are "always", "ready", "queued", or "never".
    # Default value is "always".
    publish: "always"
    # A message to include when the pull request is in the open state.
    open_message: "..."
    # A message to include when the pull request is in the queued state.
    queued_message: "..."
    # A message to include when the pull request is in the blocked state.
    blocked_message: "..."

publish controls when the comment is first posted:

• always - post the comment when the pull request is opened. This is the default.

• ready - post the comment once the pull request is out of draft.

• queued - post the comment only once the pull request is queued.

• never - do not post the comment.

Once the comment has been posted, it is updated in place for the rest of the pull request lifecycle regardless of this setting.

Pull requests that are part of a stack always get a sticky comment when they are opened, since the comment carries the stack information. publish does not apply to them.

Comments are enabled by default in your repository, you can modify this configuration from the config file:

merge_rules:
  enable_comments: true