Page MenuHomePhabricator

[QB] [TECH] Add documentation on where 'branch-deploy' script is used
Open, Needs TriagePublic

Description

It is not documented anywhere within the Query Builder codebase where or how the branch-deploy script is configured to run in CI.

A/C

  • There is a new section in the README.md file that explains briefly and links to where the branch-deploy script is being used.

Relevant pieces of code where the Query Builder branch deployment happens;
https://github.com/wikimedia/integration-config/blob/a38b97254d04ee3410c08942823084193732ebec/jjb/job-templates.yaml#L534
https://github.com/wikimedia/integration-config/blob/a38b97254d04ee3410c08942823084193732ebec/jjb/job-templates.yaml#L984
https://github.com/wikimedia/integration-config/blob/a38b97254d04ee3410c08942823084193732ebec/jjb/wikidata.yaml#L154

Event Timeline

guergana.tzatchkova renamed this task from QueryBuilder: Add documentation on how branch deployments happen to QueryBuilder: Add documentation on where 'branch-deploy' script is used.Feb 21 2023, 3:12 PM
guergana.tzatchkova updated the task description. (Show Details)

From a conversation on Mattermost we know currently that deployed branches are available at a url with the format: https://[GERRIT-CHANGE-NUMBER]--clicky-sparqly.netlify.app/. For example: https://889547--clicky-sparqly.netlify.app/

Also, this url is published under the test results section on gerrit.

Prio Notes:

  • Does not affect end users / production
  • Does not affect development efforts
  • Does affect onboarding efforts
  • Does not affect additional stakeholders
ItamarWMDE renamed this task from QueryBuilder: Add documentation on where 'branch-deploy' script is used to [SW] QueryBuilder: Add documentation on where 'branch-deploy' script is used.Mar 28 2023, 1:43 PM
ItamarWMDE moved this task from [QT] By Project to [DOT] Prioritized on the wmde-wikidata-tech board.
ItamarWMDE renamed this task from [SW] QueryBuilder: Add documentation on where 'branch-deploy' script is used to QueryBuilder: Add documentation on where 'branch-deploy' script is used.Apr 12 2023, 12:31 PM
ItamarWMDE updated the task description. (Show Details)
ItamarWMDE renamed this task from QueryBuilder: Add documentation on where 'branch-deploy' script is used to [QB] Add documentation on where 'branch-deploy' script is used.Sep 20 2023, 2:56 PM
ItamarWMDE renamed this task from [QB] Add documentation on where 'branch-deploy' script is used to [QB] [TECH] Add documentation on where 'branch-deploy' script is used.

Notes: let's park this until we have the approach for the Wikit to Codex migration @HasanAkgun_WMDE