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.

Sign up for GitHub

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

Cobradocs sync: improve makefile, resync without commit hash #1904

Open
wants to merge 8 commits into
base: prod
Choose a base branch
from
+50 −105
Open

Cobradocs sync: improve makefile, resync without commit hash #1904

Changes from 1 commit
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
2cad703
Use single target for all binaries
rohit-nayak-ps Dec 14, 2024
6d76aed
add debugging output for docgen runs: needed this to identify failure…
rohit-nayak-ps Dec 14, 2024
04b14c1
Commit updated files as part of make target
rohit-nayak-ps Dec 14, 2024
33fa661
Add binary to the commit message
rohit-nayak-ps Dec 14, 2024
e9153e0
Add more debug messages
rohit-nayak-ps Dec 15, 2024
eb43dfe
Don't try to commit if there are no files. Otherwise we get a spuriou…
rohit-nayak-ps Dec 15, 2024
01e7df9
set -x to show what's going on. Alert if wrong go version. Delete -e …
rohit-nayak-ps Jan 7, 2025
580ff95
Run docgen in debug mode for now to identify any issues due to recent…
rohit-nayak-ps Jan 11, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Loading
Loading status checks…
Add binary to the commit message 
Signed-off-by: Rohit Nayak <[email protected]>
@rohit-nayak-ps
rohit-nayak-ps committed Dec 14, 2024

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Verified
Learn about vigilant mode
commit 33fa661dc342f3d5570df5403e0a0afc6e0cd0b1
2 changes: 1 addition & 1 deletion Makefile
View file
Original file line number Diff line number Diff line change
@@ -60,7 +60,7 @@ BINS := mysqlctl mysqlctld vtaclcheck topo2topo vtbackup vtclient vtcombo \
%-docs:
go run ./tools/cobradocs/ --vitess-dir "${VITESS_DIR}" --version-pairs "${COBRADOC_VERSION_PAIRS}" $(patsubst %-docs,%,$@)
Copy link
Collaborator

@mattlord mattlord Dec 26, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If you don't specify anything for COBRADOC_VERSION_PAIRS it does not work:

❯ make generated-docs
go run ./tools/cobradocs/ --vitess-dir "/Users/matt/git/vitess" --version-pairs ""main:22.0,v21.0.0:21.0,v20.0.3:20.0,v19.0.7:19.0"" mysqlctl
2024/12/26 16:58:00 exit status 1
exit status 1
make: *** [mysqlctl-docs] Error 1

❯ git status
On branch rohit/slimmer-docs
Your branch is ahead of 'origin/rohit/slimmer-docs' by 1 commit.
  (use "git push" to publish your local commits)

Untracked files:
  (use "git add <file>..." to include in what will be committed)
	content/en/docs/21.0/reference/programs/mysqlctl/_index.md-e

nothing added to commit but untracked files present (use "git add" to track)

❯ git diff
diff --git a/content/en/docs/21.0/reference/programs/mysqlctl/mysqlctl_init.md b/content/en/docs/21.0/reference/programs/mysqlctl/mysqlctl_init.md
index 7d63ff46..5528f87a 100644
--- a/content/en/docs/21.0/reference/programs/mysqlctl/mysqlctl_init.md
+++ b/content/en/docs/21.0/reference/programs/mysqlctl/mysqlctl_init.md
@@ -44,7 +44,7 @@ mysqlctl \
       --config-file string                                          Full path of the config file (with extension) to use. If set, --config-path, --config-type, and --config-name are ignored.
       --config-file-not-found-handling ConfigFileNotFoundHandling   Behavior when a config file is not found. (Options: error, exit, ignore, warn) (default warn)
       --config-name string                                          Name of the config file (without extension) to search for. (default "vtconfig")
-      --config-path strings                                         Paths to search for config files in. (default [<WORKDIR>])
+      --config-path strings                                         Paths to search for config files in. (default [/Users/matt/git/vitess])
       --config-persistence-min-interval duration                    minimum interval between persisting dynamic config changes back to disk (if no change has occurred, nothing is done). (default 1s)
       --config-type string                                          Config file type (omit to infer config type from file extension).
       --db-credentials-file string                                  db credentials file; send SIGHUP to reload this file
...


❯ export COBRADOC_VERSION_PAIRS="main:22.0"

❯ make generated-docs
go run ./tools/cobradocs/ --vitess-dir "/Users/matt/git/vitess" --version-pairs "main:22.0" mysqlctl
COMMIT_HASH=7386140b97; \
    	git add -u content && \
    	if ! git diff --cached --quiet HEAD --; then \
    	  git commit -s -m "Update cobradocs for $COMMIT_HASH for mysqlctl"; \
    	fi
[rohit/slimmer-docs fb7ce160] Update cobradocs for 7386140b97 for mysqlctl
 7 files changed, 7 insertions(+), 7 deletions(-)
...

COMMIT_HASH=$(shell cd $(VITESS_DIR) && git rev-parse --short HEAD) && \
git add -u content && git commit -s -m "Update cobradocs for $$COMMIT_HASH"
git add -u content && git commit -s -m "Update cobradocs for $$COMMIT_HASH for $(patsubst %-docs,%,$@)"

# Target to run them all.
.PHONY: generated-docs