Contribution workflow: How to include additional files (e.g. plugin zip) in a PR?

[adamziel]

Contributing Guidelines say:

All static files (WXR, ZIP, JPG etc.) referenced by the Blueprint must be included in the submitted directory in your Pull Request and referenced via the raw.githubusercontent.com domain.

However, it's unclear how to actually reference these files in blueprint.json in a PR. That blueprint can ship URLs pointing to the newly proposed branch, but once that branch is merged these URLs will need to magically start pointing to trunk.

Two solutions that came to mind:

1. CI job to rewrite the URLs. I don't like it, though. It's extra work and will make forking and adjusting these files more difficult.
2. Support URLs relative to the Blueprint. For example { "step": "installPlugin", "pluginZipFile": "./plugin.zip" }. This would be a breaking change because relative URLs are now relative to the client site URL. Maybe that's fine, though? Or perhaps we could ship a new resource type, like "blueprint-relative-url"?

cc @bgrgicak @brandonpayton @dmsnell for ideas

[bgrgicak]

This would be a breaking change because relative URLs are now relative to the client site URL. Maybe that's fine, though? Or perhaps we could ship a new resource type, like "blueprint-relative-url"?

This could be confusing, relative URLs are usually tied to the site context.
Using a new resource type would help, but it still feels like a workaround.

What if blueprints accepted bas64 encoded data? This would remove the need for putting the data on a server.
Playground could use a blueprint exporter and this could support storing data using base64.

[dmsnell]

The Playground could help some URLs by rewriting dynamically couldn't it? That is, recognize that it's a Github link, and if it's not the right rawusercontent domain then rewrite it?

[adamziel]

Related: #18

[adamziel]

I went for the CI job to rewrite branch URLs to trunk URLs:

fabe4d2

Independently from that, I will explore @dmsnell's suggestion – it resolves another important problem.

[adamziel]

To resolve this issue, we'll need to document the expected URL for all assets is the https://raw.githubusercontent.com/ URL pointing to the proposed branch.

[adamziel]

Documented in d2f9f8d