Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docgen: make automated docs generation more efficient #66007

Open
RichardJCai opened this issue Jun 2, 2021 · 0 comments
Open

docgen: make automated docs generation more efficient #66007

RichardJCai opened this issue Jun 2, 2021 · 0 comments
Labels
C-enhancement Solution expected to add code/behavior + preserve backward-compat (pg compat issues are exception) T-sql-foundations SQL Foundations Team (formerly SQL Schema + SQL Sessions)

Comments

@RichardJCai
Copy link
Contributor

RichardJCai commented Jun 2, 2021

See:
https://github.com/cockroachdb/cockroach/blob/v21.1.1/build/teamcity-diagram-generation.sh

Right now we generate both the bnfs/svgs in the job no matter what. This takes more CPU time than needed.

We can be smarter about this by

  1. Only generate the bnfs if sql.y or diagrams.go has changed.
  2. Only generate svgs if the bnfs have changed (this is easier, bnf generation is quick whereas svg generation takes the bulk of the time)

2 is likely easier - we can also only generate SVGs for bnfs that have changed.

Note that this has to be backported to 20.2 and 21.1 as well if a change is made.

Side note: the TC job fails right now if the git push does nothing, (no changes) we should fix this.

Jira issue: CRDB-7832

@RichardJCai RichardJCai added the C-enhancement Solution expected to add code/behavior + preserve backward-compat (pg compat issues are exception) label Jun 2, 2021
@RichardJCai RichardJCai added this to Triage in SQL Sessions - Deprecated via automation Jun 2, 2021
@RichardJCai RichardJCai added the T-sql-foundations SQL Foundations Team (formerly SQL Schema + SQL Sessions) label Jun 2, 2021
@rafiss rafiss moved this from Triage to Longer term backlog in SQL Sessions - Deprecated Jun 8, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C-enhancement Solution expected to add code/behavior + preserve backward-compat (pg compat issues are exception) T-sql-foundations SQL Foundations Team (formerly SQL Schema + SQL Sessions)
Projects
No open projects
SQL Sessions - Deprecated
Longer term backlog
Development

No branches or pull requests

2 participants