Sharing on GitHub

[dfay]

Is there a recommended directory structure etc. for sharing workflows on GitHub?  

[vitor]

I think we have another thread on the forum about it. The answer is “no”. If even us — who are the ones who share the most Workflows and share ideas — don’t have a common directory structure, there’s little chance a “recommended” method would emerge.

But if you’re undecided about which directory structure to use, we can discuss it. If I shared one Workflow per repo, I’d do it the way I do for my standalone apps, like Fog: on the root have an app or source directory which contains what is necessary to build the project (i.e. the code people will use), and everything else on the root are support files and directories, such as documentation.

[deanishe]

I have one workflow per repo so I can use GitHub releases for updates.

 

Fundamentally, I have a subdirectory with the actual workflow contents (that I can symlink or copy to Alfred’s workflow directory).

 

In the case of scripting languages, this is called “src”,  and I have the README, licence and probably the built workflow in the repo root.

 

In the case of compiled languages (Go in my case), the “build” subdirectory is what gets linked to Alfred’s workflow directory. The top-level contains code and build scripts (as is normal with Go).

[xilopaint]

5 hours ago, deanishe said:

I have one workflow per repo so I can use GitHub releases for updates.

 

Fundamentally, I have a subdirectory with the actual workflow contents (that I can symlink or copy to Alfred’s workflow directory).

 

In the case of scripting languages, this is called “src”,  and I have the README, licence and probably the built workflow in the repo root.

 

In the case of compiled languages (Go in my case), the “build” subdirectory is what gets linked to Alfred’s workflow directory. The top-level contains code and build scripts (as is normal with Go).

 

I adopted your folder structure. Btw, I also created a workflow for your script to symlink/install workflows. It's awesome.