Automatically edit PRs with link to RTD preview

[hugovk]

Let's try this by RTD: https://github.com/readthedocs/actions/tree/v1/preview

GitHub Action that automatically edits Pull Requests' descriptions with a link to documentation's preview on Read the Docs.

For example:

• https://github.com/poliastro/poliastro/blob/main/.github/workflows/documentation-links.yaml
• ->
• MAINT: add changelog to project links poliastro/poliastro#1613

[hugovk]

I think this needs to be merged before it's active.

[humitos]

@hugovk yes, you have to merge the PR to be executed. I haven't find a way on GitHub to be able to test these actions from a Pull Request unfortunately.

[CAM-Gerlach]

yes, you have to merge the PR to be executed. I haven't find a way on GitHub to be able to test these actions from a Pull Request unfortunately.

Testing it on your fork works if it doesn't require something specific on the upstream, and I believe pushing it to a new upstream branch and then submitting a PR against that branch might work too, depending on the workflow trigger.

[hugovk]

Thank you @humitos (and RTD) for the Action (and RTD)!

[humitos]

@CAM-Gerlach

Testing it on your fork works

That's a pretty simple and great idea! 💯 . I haven't thought about this before. I will start using this workflow from now on 👍🏼 . Thanks!