fix(docs): fix snippet publishing (#512)

* fix(docs): fix snippet publishing * fix(docs): explicitly list which files to publish
ucb-substrate · Jan 22, 2025 · 456f8bf · 456f8bf
1 parent 5bb9121
commit 456f8bf
Show file tree

Hide file tree

Showing 9 changed files with 23 additions and 8 deletions.
diff --git a/.release-please-manifest.json b/.release-please-manifest.json
@@ -3,6 +3,7 @@
   "codegen": "0.9.0",
   "config": "0.3.0",
   "docs/snippets": "0.6.0",
+  "examples": "0.1.0",
   "examples/latest/sky130_inverter": "0.0.0",
   "examples/latest/spice_vdivider": "0.0.0",
   "examples/latest/colbuf": "0.0.0",

diff --git a/Cargo.lock b/Cargo.lock
diff --git a/codegen/Cargo.toml b/codegen/Cargo.toml
@@ -24,6 +24,7 @@ rust_decimal_macros = "1.30"
 
 [build-dependencies]
 snippets = { version = "0.6.0", registry = "substrate", path = "../docs/snippets" }
+examples = { version = "0.1.0", registry = "substrate", path = "../examples" }
 
 [lib]
 proc-macro = true
diff --git a/codegen/build.rs b/codegen/build.rs
@@ -1,10 +1,7 @@
 use snippets::build_snippets;
 
 fn main() {
-    let example_path = concat!(
-        env!("CARGO_MANIFEST_DIR"),
-        "/../examples/latest/substrate_api_examples/src/lib.rs"
-    );
+    let example_path = examples::get_path("latest/substrate_api_examples/src/lib.rs");
     println!("cargo::rerun-if-changed={example_path}");
     build_snippets(example_path, "substrate");
 }
diff --git a/examples/Cargo.toml b/examples/Cargo.toml
@@ -0,0 +1,8 @@
+[package]
+name = "examples"
+version = "0.1.0"
+edition = "2021"
+include = [
+    "**/*.rs",
+    "Cargo.toml",
+]
diff --git a/examples/src/lib.rs b/examples/src/lib.rs
@@ -0,0 +1,3 @@
+pub fn get_path(rel_path: &str) -> String {
+    format!("{}/{rel_path}", env!("CARGO_MANIFEST_DIR"))
+}
diff --git a/release-please-config.json b/release-please-config.json
@@ -11,6 +11,7 @@
     "codegen": {},
     "config": {},
     "docs/snippets": {},
+    "examples": {},
     "examples/latest/sky130_inverter": {},
     "examples/latest/spice_vdivider": {},
     "examples/latest/colbuf": {},

diff --git a/substrate/Cargo.toml b/substrate/Cargo.toml
@@ -45,3 +45,4 @@ lazy_static = "1"
 
 [build-dependencies]
 snippets = { version = "0.6.0", registry = "substrate", path = "../docs/snippets" }
+examples = { version = "0.1.0", registry = "substrate", path = "../examples" }
diff --git a/substrate/build.rs b/substrate/build.rs
@@ -1,10 +1,7 @@
 use snippets::build_snippets;
 
 fn main() {
-    let example_path = concat!(
-        env!("CARGO_MANIFEST_DIR"),
-        "/../examples/latest/substrate_api_examples/src/lib.rs"
-    );
+    let example_path = examples::get_path("latest/substrate_api_examples/src/lib.rs");
     println!("cargo::rerun-if-changed={example_path}");
     build_snippets(example_path, "substrate");
 }
Original file line number	Diff line number	Diff line change
Expand Up		@@ -45,3 +45,4 @@ lazy_static = "1"

		[build-dependencies]
		snippets = { version = "0.6.0", registry = "substrate", path = "../docs/snippets" }
		examples = { version = "0.1.0", registry = "substrate", path = "../examples" }