You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/modules/language-reference/pages/index.adoc
+8Lines changed: 8 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5951,6 +5951,14 @@ To fully set up mirroring, an HTTP(s) server will need be running, and which mir
5951
5951
[[references]]
5952
5952
=== References
5953
5953
5954
+
[WARNING]
5955
+
.Experimenal Feature
5956
+
====
5957
+
The API and semantics of references are subject to change in a future release.
5958
+
The Pkl team is soliciting feedback from authors of libraries considering adopting references.
5959
+
For questions and feedback, please reach out via https://github.com/apple/pkl/discussions[GitHub Discussions] or https://github.com/apple/pkl/issues/new[create an issue].
5960
+
====
5961
+
5954
5962
pkldoc:Reference[pkl:ref]s (provided by the `pkl.ref` module) are an advanced API design tool that serves use cases where configuration must refer to values that are not known at evaluation time.
5955
5963
This is common in task-based execution systems like CI platforms and Infrastructure as Code (IaC) tools.
5956
5964
Today, many such systems encode this kind of reference using strings containing an expression language; this approach makes it difficult to write and debug such references, as target systems may not know where in the Pkl source an error occurred.
0 commit comments