Previews in PR Conversation

[IstoraMandiri]

UPDATED

This PR implements a number of fixes and features to do with preview tweets, which makes collaboration in twitter-together repos a lot more streamlined.

Primarily, this PR fixes #223, adding support for the action to create (and update) a generated comment that renders a preview the latest committed tweet(s). Here's an example, using this PR's build. ethereumclassic/tweets-etc_network#92.

I have refactored a fair amount of the pull-request code path to separate concerns, splitting the create-check-run logic and making the report type more explicit.

It fixes #219 by generating previews for all Front Matter types.

It also fixes #218 by updating the documentation for the workflow file to check out the head of the pull request so that the action can check the presence of the media files to be uploaded.

Test cases for PRs have also been added for all recently introduced Front Matter types and threading.

For repos currently using this action, the old behavior will remain, but for those using pull_request_target, the action will create comments instead of check runs to report the result of new tweets. It can be enabled for pull_request PRs from local branches using a documented environment variable.

Important: I have updated the README documentation with this optional config change, a fix for #218 by checking out the PR branch, as well as explaining the pull_request_target security implications. I would like someone with more knowledge of GitHub actions to review this to ensure it's correct guidance. I'm confused as to what happens if an outside contributor submits an innocent PR, which runs, and then updates their branch to modify the workflow file. Could this leave the repository vulnerable?

Once the README has been reviewed, I can update the relevant config docs elsewhere.

This PR does not include any version changes or new distributions, and should be backwards compatible, but perhaps a v4 major bump might be considered guarantee these significant changes don't break anything.

If this is approved and merged, I'll submit another PR for adding Tweeted URLs to the merged PR comment thread.

[IstoraMandiri]

I have just added another commit to this PR that fixes #221 by adding an additional check to parse-tweet-file-content.js for retweets and replies that will throw if they are invalid.

I have also split out the URL parsing function so we can extend if to support other formats such as tweet IDs or malformed URLs.

[gr2m]

https://github.com/IstoraMandiri/twitter-together-testing/runs/8713977079

do you think we could link to the media for preview, or even show a preview in the markdown?

Otherwise fantastic work 👍🏼

[gr2m]

that's a great idea, can you file a follow up issue?

[IstoraMandiri]

Thanks for those suggestions @gr2m. Yes, I'll update this PR shortly to generate better previews of media. I had left it generic for now as I wasn't sure whether it supported videos, but for now I can at least render images.

[gr2m]

let me know when it's ready for another review

[IstoraMandiri]

I've just updated this branch to render images as so:

https://github.com/IstoraMandiri/twitter-together-testing/runs/8860835815

[IstoraMandiri]

Ah, hold on, need to deal with nested filenames.

[IstoraMandiri]

Okay, nested media files in sub directories are now supported.

(see dog)
https://github.com/IstoraMandiri/twitter-together-testing/runs/8867019970

[IstoraMandiri]

@gr2m @MattIPv4 I have updated the top comment of this thread, I think it is ready for a review, but not quite ready to merge pending advice on the documentation.

[gr2m]

I'll be very busy this week, I try my best to review but no promises. Feel free to go ahead without me if you both agree

[IstoraMandiri]

FYI, the merge_schedule check on this PR seems to be failing for this and other PRs, seems to be misconfigured.

[gr2m]

I wont be able to review the pull request in depth. I can look at specific things and happy to merge it and fix follow up problems as they occur.