twitter-together / action

:bird: A GitHub action to tweet from a repository
https://github.com/marketplace/actions/twitter-together
MIT License
697 stars 77 forks source link

Support relative media paths #214

Open IstoraMandiri opened 2 years ago

IstoraMandiri commented 2 years ago

What’s missing?

Currently media uploads need to be in a top level media directory. To giver users optionality in how they organize their projects, they should be able to specify a relative file path for media uploads, allowing media to be organized alongside their relevant .tweet files with the tweets directory.

Why?

For projects with many tweets, especially with nested directories, a separate top level media folder may become disorganized, and specifying unique names for each file may be confusing.

MattIPv4 commented 2 years ago

There is nothing stopping folks from putting subdirectories within the media folder, unless there's a bug there I've missed? The only requirement is that the media folder is at the same level as the tweets folder, which seems a fair requirement to have given we require the tweets folder exactly the same.

IstoraMandiri commented 2 years ago

I understand that the media folder can also be nested, but why force users to keep media and tweets in separate places?

Allowing associated files to exist next to each other in the same folder helps keep the directory structure DRY, organization is easier and less confusing for contributors, especially for larger projects.

tweets
   cats
      charlie
        cute.jpg
        catnip.tweet        
        kittens.jpg
        january-fun.tweet
  dogs
     spot
        fetch.tweet
        dinner.jpg
        dinner.tweet

Instead of

media
   cats
      charlie
        cute.jpg
        kittens.jpg
  dogs
     spot
        dinner.jpg
tweets
   cats
      charlie
        catnip.tweet        
        january-fun.tweet
  dogs
     spot
        fetch.tweet
        dinner.tweet
MattIPv4 commented 2 years ago

Ah yeah true, I could see it being a bit of a pain to have a dedicated media directory if someone were using this action in a repo that were doing things other than just tweets etc.

I wonder if the best approach might be to accept a path as it is currently (e.g. cat.jpg) and then search in a few different places for it (/media, /tweets/media, /tweets).