Skip to content
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

Jump to bottom

Adjust filename according to style guide #484

Merged
merged 2 commits into from
May 13, 2024
Merged

Adjust filename according to style guide #484

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
696ea94
adjust file name according to style guide
garysassano May 9, 2024
0aa8e8c
Delete .vscode/settings.json
garysassano May 10, 2024
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
14 changes: 7 additions & 7 deletions docs/modules/language-tutorial/pages/02_filling_out_a_template.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -284,9 +284,9 @@ This terminology describes the _intended use_ of the module and doesn't imply an
In other words: just by looking at Pkl code, you can't tell whether it is a template or a "normal" module.

[source,{pkl}]
.acmecicd.pkl
.AcmeCICD.pkl
----
module acmecicd
module AcmeCICD

class Pipeline {
name: String(nameRequiresBranchName)?
Expand Down Expand Up @@ -316,7 +316,7 @@ Next, add a time-out of one minute for your job.
[source,{pkl}]
.cicd.pkl
----
amends "acmecicd.pkl"
amends "AcmeCICD.pkl"

timeout = 1
----
Expand All @@ -329,7 +329,7 @@ Value: 1 // <3>

225 | timeout: Int(this >= 3)? // <4>
^^^^^^^^^
at acmecicd#timeout (file:///Users/me/tutorial/acmecicd.pkl, line 8)
at AcmeCICD#timeout (file:///Users/me/tutorial/AcmeCICD.pkl, line 8)

3 | timeout = 1 // <5>
^
Expand Down Expand Up @@ -369,7 +369,7 @@ Start off by specifying the name of the pipeline and nothing else.
[source,{pkl}]
.cicd.pkl
----
amends "acmecicd.pkl"
amends "AcmeCICD.pkl"

timeout = 3
pipelines {
Expand Down Expand Up @@ -403,7 +403,7 @@ Pipelines that set a 'name' must also set a 'branchName'.

8 | throw("Pipelines that set a 'name' must also set a 'branchName'.")
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
at acmecicd#Pipeline.nameRequiresBranchName.<function#1> (file:///Users/me/tutorial/acmecicd.pkl, line 8)
at AcmeCICD#Pipeline.nameRequiresBranchName.<function#1> (file:///Users/me/tutorial/AcmeCICD.pkl, line 8)

6 | name = "prb"
^^^^^
Expand All @@ -424,7 +424,7 @@ The message is quite instructive, so you can fix the error by adding a `branchNa
[source,{pkl}]
.cicd.pkl
----
amends "acmecicd.pkl"
amends "AcmeCICD.pkl"

timeout = 3
pipelines {
Expand Down
4 changes: 2 additions & 2 deletions docs/modules/language-tutorial/pages/03_writing_a_template.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ include::ROOT:partial$component-attributes.adoc[]

In parts xref:01_basic_config.adoc[one] and xref:02_filling_out_a_template.adoc[two], you saw that Pkl provides _validation_ of our configurations.
It checks syntax, types and constraints.
As you saw in the `acmecicd` example xref:02_filling_out_a_template.adoc#amending-templates[here], the template can provide informative error messages when an amending module violates a type constraint.
As you saw in the `AcmeCICD` example xref:02_filling_out_a_template.adoc#amending-templates[here], the template can provide informative error messages when an amending module violates a type constraint.

In this final part, you will see some of Pkl's techniques that are particularly relevant for writing a template.

Expand Down Expand Up @@ -256,7 +256,7 @@ By "precisely" we mean, that amending an object also can't "turn it into" an ins
== A new template

Now that you know about types, you can start writing your first template.
So far, you've written configurations with Pkl, either without a template, or using the `acmecicd` template from xref:02_filling_out_a_template.adoc#amending-templates[Amending templates].
So far, you've written configurations with Pkl, either without a template, or using the `AcmeCICD` template from xref:02_filling_out_a_template.adoc#amending-templates[Amending templates].
It is often easiest to first write a (typical) configuration for which you want to create a template.
Suppose you want to define what a live workshop for this tutorial looks like.
Consider this example:
Expand Down