googlefonts / fontbakery-dashboard

A library-scale web dashboard for Font Bakery, no longer developed
Apache License 2.0
28 stars 10 forks source link

Feature: Sandboxed workflow #117

Open graphicore opened 5 years ago

graphicore commented 5 years ago

Mentioned in #114 and #115.

115 describes one prerequisite for this to work: A designer or engineer working on a release of a font project will likely (because it's good practice) work on a feature branch that is not master (or, if we'll allow it the, a special gf-releases-upstream branch). In that process, the author will want to test the feature branch against the QA-assembly-line, but without merging into master all the time and without triggering an actual pull request .

Short term

I want to establish a switch, when initiating a new process, between: sandbox and production. That will change:

  1. the input spreadsheet file to a version that is only used in sandbox mode "[dashboard SANDBOX Copy] Google Fonts Upstream Repos" and the actual production file.
  2. the output repo, that we use to PR to, to a Sandbox/non-production fork of google/fonts currently graphicore/googleFonts

At the very moment, the deployed version of FBD is by default in the Sandboxed mode, but that means there's no way to make production PRs. Also, #115 blocks the Sandboxes mode to be actually useful for our engineers, who also asked in #114 to be able to play with the dispatcher without the worries of breaking stuff or annoying anyone.

The "feature branch workflow" also suggests, that once an engineer is happy with the branch, the branch will be merged into the master (gf-production) branch and from there the dispatcher can be used in "production" mode to create an actual PR to google/fonts, which will be recognized and assessed by the gf-engineers.

User Stories

Mid Term

For the short term approach, we still need to give to trusted people access to the "[dashboard SANDBOX Copy]" spreadsheet or just do it via our engineers. But, if anyone is interested in releasing a font via google fonts, access to the QA tools (via the dispatcher) should be easy in sandbox mode. Further, switching the "input" spreadsheet only allows for one sandbox repository+branch per family, where in a distributed workflow many branches may be required to check different repos+branches in sandbox mode. Hence the sandbox mode should allow for easy registration and usage (maybe just per process -> copy the branch github url, maybe save in a personal profile) of a feature branch.

User Stories

graphicore commented 4 years ago

For the short term it's still missing that the PR goes to google/fonts