Skip to content

[-] fix first-use setup and YAML argument examples - #867

Open
dajiaohuang wants to merge 3 commits into
cybertec-postgresql:masterfrom
dajiaohuang:repostew/docs-first-use-yaml-20261015
Open

dajiaohuang wants to merge 3 commits into
cybertec-postgresql:masterfrom
dajiaohuang:repostew/docs-first-use-yaml-20261015

Conversation

@dajiaohuang

Copy link
Copy Markdown

Summary

Correct a group of runnable documentation/example errors without changing scheduler behavior:

  • Give the quick-start role LOGIN and initialize the schema with --init before calling timetable.add_job. On a fresh PostgreSQL database the old order fails with schema "timetable" does not exist, and the password-only role cannot log in. Apply the same sequence to the first-chain tutorial (which schedules a nightly, not one-off, job).
  • Nest SQL/PROGRAM argument arrays in the README, YAML reference and affected YAML samples. Each outer parameter entry is a separate execution; a scalar entry currently fails JSON unmarshalling before the SQL/program runs. BUILTIN parameter shapes are unchanged.
  • Point Docker installation instructions at the existing release workflow instead of the deleted docker.yml, and stop describing latest as tracking every master commit.

TestYamlExampleParameters parses the shipped YAML and complete README/reference YAML examples, checking SQL/PROGRAM parameter shapes without executing programs or connecting to a database. It fails against the base examples and passes with these corrections.

Validation

  • Go 1.27.0: binary build; config/API/notify units; selected YAML/SQL engine units; new example regression; go vet ./...; git diff --check.
  • Isolated PostgreSQL 18: reproduced the fresh-start role/schema failures, then verified initialization and manual execution of the VACUUM job; reproduced the README YAML parameter failure and verified the corrected chain with synthetic functions. Also ran the corrected Basic/Chain YAML samples and all four upstream SQL fixture files (cron, DDL, job functions, JSON schema).
  • SQL-only synthetic chains: transaction rollback, ignore-error/savepoint continuation, autonomous execution and notification cancellation/active-row cleanup.
  • MkDocs build passes; generated godoc navigation is absent locally and produces a warning.

Limits: no real/user databases or host PROGRAM jobs were executed. The local Testcontainers integration attempt failed before PostgreSQL startup because Ryuk disappeared before readiness; direct isolated Docker PostgreSQL validation above succeeded. Full Linux/Windows-service integration was not run. Local golangci-lint was built with Go 1.26 and refuses this repository's Go 1.27 target, so lint remains for CI; no language/version constraint was changed.

Comment thread docs/tutorial-first-chain.md Outdated
@pashagolub pashagolub self-assigned this Oct 15, 2026
@pashagolub pashagolub added the documentation Good for newcomers label Oct 15, 2026
@coveralls

coveralls commented Oct 15, 2026 •

Copy link
Copy Markdown

Coverage Report for CI Build 38942744595

Coverage increased (+0.04%) to 87.931%

Details

  • Coverage increased (+0.04%) from the base build.
  • Patch coverage: No coverable lines changed in this PR.
  • 3 coverage regressions across 2 files.

Uncovered Changes

No uncovered changes found.

Coverage Regressions

3 previously-covered lines in 2 files lost coverage.

File Lines Losing Coverage Coverage
internal/otel/otel.go 2 90.98%
internal/pgengine/log_hook.go 1 82.22%

Coverage Stats

Coverage Status
Relevant Lines: 2552
Covered Lines: 2244
Line Coverage: 87.93%
Coverage Strength: 0.9 hits per line

💛 - Coveralls

dajiaohuang and others added 2 commits October 16, 2026 14:28
Move yaml-format.md chain examples into samples/yaml and pull them in
with pymdownx.snippets, so the sample test covers them without regex
extraction from Markdown.
@pashagolub pashagolub changed the title Fix first-use setup and YAML argument examples [-] fix first-use setup and YAML argument examples Oct 16, 2026
@pashagolub
pashagolub requested review from 0xgouda and df7cb October 16, 2026 18:03

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Good for newcomers

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants