joaopgrassi/otel-recipes

Define process to update the `recipefile.json` used by the website

Closed this issue · 3 comments

In #11 we did some research to find out how we could "combine" all recipefile.json of all languages into a single, JSON array.

Now we need to define the process in which we run the script to generate (and update) the file that is used by the website.

Potential ideas:

  • Every time something changes in a recipefile.json a GH action that generates the combined one, and commit it on the website folder
  • A "manual" step as part of the website deployment process

The command using jq can be either on its own bash script, or we could consider having a Makefile at the root with a task for it. The Makefile is nice because we could also define tasks for deploy or build the website.

@joaopgrassi, I have some questions regarding this...
We will define all the steps to create the recipefiles.json, build and deploy de webpage in the Makefile.
Then will we configure a GH action to call it on every PR?

That's it?

Something like that yeah.

It's one command to compile the recipefile.json as in #11. Then, in the website package.json there will be commands to build the site (which puts the bundled js files in a public folder), then the deploy command uses a npm package to deploy the site to a branch using GitHub pages.

The idea with the combined recipe file is that every time it is changed, we need to run an action when the branch is merged to generate the new combined one, and commit it to main.

Then we can create a release, which would trigger the build and deploy steps of the website.

I have to play with it to see how things would work and maybe if this workflow makes sense. I only have vague ideas at the moment, but without an initial version of the site is hard to know.

@joaopgrassi is that approach still the way to go?