Skip to content

Add Wallet Gateway generated reference PR target #775

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

Draft
danielporterda wants to merge 1 commit into
base: generated-reference-07-dashboard-pr-orchestrator
Choose a base branch
from
Draft

Add Wallet Gateway generated reference PR target #775

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
27 changes: 27 additions & 0 deletions scripts/update_generated_reference_prs.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,33 @@ class UpdateTarget:
"git diff --check",
),
),
UpdateTarget(
key="wallet-gateway-openrpc",
title="Update Wallet Gateway OpenRPC reference",
branch="generated-references/wallet-gateway-openrpc/update",
description=(
"Updates the Wallet Gateway OpenRPC source pin to the latest stable "
"wallet-gateway-remote release and regenerates the checked-in Wallet Gateway "
"OpenRPC reference pages."
),
generate_commands=(
("nix-shell", "--run", "npm run update:generated-reference-sources -- --source wallet-gateway-openrpc"),
("nix-shell", "--run", "npm run generate:wallet-gateway-openrpc-reference"),
),
paths=(
"config/x2mdx/wallet-gateway-openrpc/source-artifacts.json",
"docs-main/docs.json",
"docs-main/reference/wallet-gateway-json-rpc",
),
summary_kind="source-config",
summary_path="config/x2mdx/wallet-gateway-openrpc/source-artifacts.json",
summary_label="Wallet Gateway OpenRPC",
validation=(
"npm run update:generated-reference-sources -- --source wallet-gateway-openrpc",
"npm run generate:wallet-gateway-openrpc-reference",
"git diff --check",
),
),
)


Expand Down
17 changes: 9 additions & 8 deletions tests/test_update_generated_reference_prs.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,12 +51,12 @@ def test_targets_to_run_rejects_mixed_all_and_target_keys() -> None:
raise AssertionError("Expected targets_to_run to reject mixed all and target keys")


def test_targets_to_run_accepts_dashboard_target_key() -> None:
def test_targets_to_run_preserves_declared_target_order_for_target_keys() -> None:
module = load_script_module()

targets = module.targets_to_run(["version-dashboard"])
targets = module.targets_to_run(["wallet-gateway-openrpc", "version-dashboard"])

assert [target.key for target in targets] == ["version-dashboard"]
assert [target.key for target in targets] == ["version-dashboard", "wallet-gateway-openrpc"]


def test_generated_clean_paths_include_target_paths_and_internal_output() -> None:
Expand All @@ -65,21 +65,22 @@ def test_generated_clean_paths_include_target_paths_and_internal_output() -> Non
clean_paths = module.generated_clean_paths()

assert ".internal" in clean_paths
assert "docs-main/reference/wallet-gateway-json-rpc" in clean_paths
assert "docs-main/snippets/generated/version-dashboard-data.mdx" in clean_paths


def test_body_markdown_includes_description_changes_and_validation() -> None:
module = load_script_module()
target = next(target for target in module.UPDATE_TARGETS if target.key == "version-dashboard")
target = next(target for target in module.UPDATE_TARGETS if target.key == "wallet-gateway-openrpc")

body = module.body_markdown(
target=target,
changes=["- DevNet Splice: 0.6.6 -> 0.6.7"],
changes=["- Wallet Gateway OpenRPC publish_version: 0.25.0 -> 1.4.0"],
)

assert body.startswith("Updates the committed Canton Network version dashboard data")
assert "Version changes:\n- DevNet Splice: 0.6.6 -> 0.6.7" in body
assert "- `npm run generate:version-compatibility-dashboard`" in body
assert body.startswith("Updates the Wallet Gateway OpenRPC source pin")
assert "Version changes:\n- Wallet Gateway OpenRPC publish_version: 0.25.0 -> 1.4.0" in body
assert "- `npm run generate:wallet-gateway-openrpc-reference`" in body


def test_body_markdown_notes_when_no_versions_changed() -> None:
Expand Down