search

fastly / compute-starter-kit-rust-default

Default package template for Rust based Compute projects
https://fastly.dev/solutions/starters/compute-starter-kit-rust-default/
MIT License
50 stars 21 forks source link

Missing build instructions & build suggestions #37

Open yannh opened 3 years ago

yannh commented 3 years ago

Hello! I am starting to play with this, and I think it would save newcomers some time to provide some build instructions in the Readme.

The github workflow uses Cargo to build the project, while the official instructions here https://developer.fastly.com/learning/compute#compile-the-project-to-a-wasm-binary recommend to use fastly compute build (which I assume to be a wrapper).

I made a small Dockerfile / Makefile here https://github.com/fastly/compute-starter-kit-rust-default/compare/main...yannh:dockerfile?expand=1 for my own playground - to decouple the Rust version used to build this project from what might be installed on my system. If not too opinionated to be merged, I would be happy to iterate on it and add instructions.

Side note: with a Docker image, it would be pretty trivial to release a Github action to build Fastly Compute projects. Thanks!

Integralist commented 3 years ago

Hi @yannh

re: "release a Github action to build Fastly Compute projects."

This might be of interest to you: https://github.com/fastly/compute-actions

Integralist commented 3 years ago

re: "I think it would save newcomers some time to provide some build instructions in the Readme"

Thanks for this feedback, I'll be sure to pass it onto the relevant team(s).

The starter kits are typically expected to be consumed using the Fastly CLI tool. For example, when running fastly compute init you'll be presented with the option to select a supported programming language and, once that selection is made, you'll have the option to pull down one of the supported starter kits (this being one of them).

Those instructions can be found here.