Repository navigation
Feat/scaffold config v2 docs - #612
Merged
Merged
Conversation
|
Review the following changes in direct dependencies. Learn more about Socket for GitHub.
|
1 task done
chadoh
approved these changes
Oct 1, 2026
Merged
This was referenced Oct 5, 2026
1 task done
zachfedor
pushed a commit
that referenced
this pull request
Oct 14, 2026
## 🤖 New release
* `stellar-scaffold-ext-types`: 0.0.3 -> 0.0.4 (✓ API compatible
changes)
* `stellar-scaffold-cli`: 0.0.27 -> 0.0.28 (⚠ API breaking changes)
* `stellar-scaffold-reporter`: 0.1.2 -> 0.1.3 (✓ API compatible changes)
### ⚠ `stellar-scaffold-cli` breaking changes
```text
--- failure constructible_struct_adds_field: struct exhaustively constructible through public API adds field ---
Description:
A pub struct that could be exhaustively constructed with a literal using only public API has a new pub field, breaking existing exhaustive literals.
ref: https://doc.rust-lang.org/reference/expressions/struct-expr.html
impl: https://github.com/obi1kenobi/cargo-semver-checks/tree/v0.51.0/src/lints/constructible_struct_adds_field.ron
Failed in:
field Contract.resolved in /tmp/.tmpkeJfYY/cli/crates/stellar-scaffold-cli/src/commands/build/env_toml.rs:204
field Args.network in /tmp/.tmpkeJfYY/cli/crates/stellar-scaffold-cli/src/commands/build/clients.rs:77
field Args.plan in /tmp/.tmpkeJfYY/cli/crates/stellar-scaffold-cli/src/commands/build/clients.rs:80
field Network.allow_http in /tmp/.tmpkeJfYY/cli/crates/stellar-scaffold-cli/src/commands/build/env_toml.rs:158
field Environment.from_scaffold_yml in /tmp/.tmpkeJfYY/cli/crates/stellar-scaffold-cli/src/commands/build/env_toml.rs:66
--- failure enum_missing: pub enum removed or renamed ---
Description:
A publicly-visible enum cannot be imported by its prior path. A `pub use` may have been removed, or the enum itself may have been renamed or removed entirely.
ref: https://doc.rust-lang.org/cargo/reference/semver.html#item-remove
impl: https://github.com/obi1kenobi/cargo-semver-checks/tree/v0.51.0/src/lints/enum_missing.ron
Failed in:
enum stellar_scaffold_cli::commands::build::scaffold_yml::Error, previously in file /tmp/.tmpKvelwu/stellar-scaffold-cli/src/commands/build/scaffold_yml.rs:10
--- failure enum_variant_added: enum variant added on exhaustive enum ---
Description:
A publicly-visible enum without #[non_exhaustive] has a new variant.
ref: https://doc.rust-lang.org/cargo/reference/semver.html#enum-variant-new
impl: https://github.com/obi1kenobi/cargo-semver-checks/tree/v0.51.0/src/lints/enum_variant_added.ron
Failed in:
variant Error:Config in /tmp/.tmpkeJfYY/cli/crates/stellar-scaffold-cli/src/commands/build/mod.rs:74
variant Error:ScaffoldYmlEdit in /tmp/.tmpkeJfYY/cli/crates/stellar-scaffold-cli/src/commands/init/instantiate.rs:64
variant Error:Doctor in /tmp/.tmpkeJfYY/cli/crates/stellar-scaffold-cli/src/commands/mod.rs:144
variant Error:Config in /tmp/.tmpkeJfYY/cli/crates/stellar-scaffold-cli/src/commands/mod.rs:146
variant Error:ContractsFailed in /tmp/.tmpkeJfYY/cli/crates/stellar-scaffold-cli/src/commands/build/clients.rs:169
variant Error:MissingMainnetAccount in /tmp/.tmpkeJfYY/cli/crates/stellar-scaffold-cli/src/commands/build/clients.rs:173
variant Cmd:Doctor in /tmp/.tmpkeJfYY/cli/crates/stellar-scaffold-cli/src/commands/mod.rs:118
variant Cmd:Config in /tmp/.tmpkeJfYY/cli/crates/stellar-scaffold-cli/src/commands/mod.rs:121
--- failure function_missing: pub fn removed or renamed ---
Description:
A publicly-visible function cannot be imported by its prior path. A `pub use` may have been removed, or the function itself may have been renamed or removed entirely.
ref: https://doc.rust-lang.org/cargo/reference/semver.html#item-remove
impl: https://github.com/obi1kenobi/cargo-semver-checks/tree/v0.51.0/src/lints/function_missing.ron
Failed in:
function stellar_scaffold_cli::commands::build::scaffold_yml::check_version, previously in file /tmp/.tmpKvelwu/stellar-scaffold-cli/src/commands/build/scaffold_yml.rs:88
--- failure function_parameter_count_changed: pub fn parameter count changed ---
Description:
A publicly-visible function now takes a different number of parameters.
ref: https://doc.rust-lang.org/cargo/reference/semver.html#fn-change-arity
impl: https://github.com/obi1kenobi/cargo-semver-checks/tree/v0.51.0/src/lints/function_parameter_count_changed.ron
Failed in:
stellar_scaffold_cli::commands::build::docker::start_local_stellar now takes 1 parameters instead of 0, in /tmp/.tmpkeJfYY/cli/crates/stellar-scaffold-cli/src/commands/build/docker.rs:18
--- failure inherent_method_missing: pub method removed or renamed ---
Description:
A publicly-visible method or associated fn is no longer available under its prior name. It may have been renamed or removed entirely.
ref: https://doc.rust-lang.org/cargo/reference/semver.html#item-remove
impl: https://github.com/obi1kenobi/cargo-semver-checks/tree/v0.51.0/src/lints/inherent_method_missing.ron
Failed in:
PackageManagerSpec::write_to_package_json, previously in file /tmp/.tmpKvelwu/stellar-scaffold-cli/src/commands/mod.rs:145
--- failure module_missing: pub module removed or renamed ---
Description:
A publicly-visible module cannot be imported by its prior path. A `pub use` may have been removed, or the module may have been renamed, removed, or made non-public.
ref: https://doc.rust-lang.org/cargo/reference/semver.html#item-remove
impl: https://github.com/obi1kenobi/cargo-semver-checks/tree/v0.51.0/src/lints/module_missing.ron
Failed in:
mod stellar_scaffold_cli::commands::build::scaffold_yml, previously in file /tmp/.tmpKvelwu/stellar-scaffold-cli/src/commands/build/scaffold_yml.rs:1
--- failure pub_module_level_const_missing: pub module-level const is missing ---
Description:
A public const is missing or renamed
ref: https://doc.rust-lang.org/cargo/reference/semver.html#item-remove
impl: https://github.com/obi1kenobi/cargo-semver-checks/tree/v0.51.0/src/lints/pub_module_level_const_missing.ron
Failed in:
CURRENT_SCHEMA_VERSION in file /tmp/.tmpKvelwu/stellar-scaffold-cli/src/commands/build/scaffold_yml.rs:7
CONFIG_FILE in file /tmp/.tmpKvelwu/stellar-scaffold-cli/src/commands/build/scaffold_yml.rs:4
--- failure struct_missing: pub struct removed or renamed ---
Description:
A publicly-visible struct cannot be imported by its prior path. A `pub use` may have been removed, or the struct itself may have been renamed or removed entirely.
ref: https://doc.rust-lang.org/cargo/reference/semver.html#item-remove
impl: https://github.com/obi1kenobi/cargo-semver-checks/tree/v0.51.0/src/lints/struct_missing.ron
Failed in:
struct stellar_scaffold_cli::commands::build::scaffold_yml::ScaffoldConfig, previously in file /tmp/.tmpKvelwu/stellar-scaffold-cli/src/commands/build/scaffold_yml.rs:36
```
<details><summary><i><b>Changelog</b></i></summary><p>
## `stellar-scaffold-ext-types`
<blockquote>
##
[0.0.4](stellar-scaffold-ext-types-v0.0.3...stellar-scaffold-ext-types-v0.0.4)
- 2026-10-12
### Other
- Feat/scaffold config v2 docs
([#612](#612))
</blockquote>
## `stellar-scaffold-cli`
<blockquote>
##
[0.0.28](stellar-scaffold-cli-v0.0.27...stellar-scaffold-cli-v0.0.28)
- 2026-10-12
### Other
- Allow `clients: false` per contract in scaffold.yml
([#614](#614))
- Feat/scaffold config v2 docs
([#612](#612))
- Feat/scaffold config v2 build
([#611](#611))
- Feat/scaffold config v2
([#610](#610))
- Feat/doctor command
([#593](#593))
</blockquote>
## `stellar-scaffold-reporter`
<blockquote>
##
[0.1.3](stellar-scaffold-reporter-v0.1.2...stellar-scaffold-reporter-v0.1.3)
- 2026-10-12
### Other
- Feat/scaffold config v2 docs
([#612](#612))
</blockquote>
</p></details>
---
This PR was generated with
[release-plz](https://github.com/release-plz/release-plz/).
Co-authored-by: aha-release-plz[bot] <211513279+aha-release-plz[bot]@users.noreply.github.com>
zachfedor
added a commit
that referenced
this pull request
Oct 16, 2026
Three admonitions added in #612 never close on the deployed site, so everything after them renders inside the box: - `configuration.md`: the `environments.toml` note near the top and the "build supports only `workspace`/`contract`" caution - `extensions.md`: the `environments.toml` note **Cause.** The docs' Prettier config sets `proseWrap: "never"`, which joins each paragraph onto one line. An admonition written without blank lines around its body is a single paragraph, so Prettier turns it into `:::note … :::`. Docusaurus only recognizes `:::` as a closing fence on its own line. The [Docusaurus docs](https://docusaurus.io/docs/markdown-features/admonitions#usage-with-prettier) recommend putting blank lines around the body, which is the form every other admonition on the site already uses. **Changes** - Rewrote the three admonitions with blank lines around their bodies. - Added `lint:admonitions` and made `npm run linter` (already run by `website.yml`) call it. It fails on any admonition that opens and closes on the same line. Prettier accepts that line, so the check has to be separate. It uses POSIX character classes so it also works with macOS's grep. **Testing** - With the guard but without the fix, `npm run linter` fails and lists the three lines. - With the fix, it passes. - `docusaurus build --locale en` succeeds. In the built HTML, each of the three admonitions contains only its own text, and no stray `:::` remains on either page. 🤖 Generated with [Claude Code](https://claude.com/claude-code) https://claude.ai/code/session_01QhmaWLv4yExX8LahP5UtUb --------- Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds documentation for the new scaffold.yml v2 change from #181 as well as the hosted agent skill for Scaffold which closes #394