Skip to content

[Amplify] Share links of pages that have received an update #540

@dgarcia360

Description

@dgarcia360

Motivation

Amplify publishes a message for every pull request with a link to the preview site:

image

This allows contributors to preview the sample documentation page, but they have to surf the site to find the page(s) that have received an update.

Proposal

Create a custom GitHub workflow & action that triggers when the Amplify bot publishes the message. This will:

  • Read the AWS Amplify message and parse the preview URL.
  • Detect which RST and MarkDown files within the docs folder received an update.
  • Post a new message in the pull request with a list of links pointing to the preview pages for every doc updated.

Possible enhancements

We need to check if it is possible to:

  • Instead of publishing a new message, edit the message created by the Amplify bot.
  • Delete the Amplify bot message if there are no docs updates.

Metadata

Metadata

Assignees

Labels

enhancementNew feature or request

Type

No type

Projects

No projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions