Skip to content

Commit

Permalink
deploy: d81f1b2
Browse files Browse the repository at this point in the history
  • Loading branch information
pnmadelaine committed Sep 24, 2023
1 parent 40b2a4c commit b193544
Show file tree
Hide file tree
Showing 5 changed files with 24 additions and 26 deletions.
13 changes: 7 additions & 6 deletions concepts.html
Original file line number Diff line number Diff line change
Expand Up @@ -175,8 +175,9 @@ <h2 id="projects"><a class="header" href="#projects">Projects</a></h2>
expose a <code>typhonProject</code> attribute defining the project settings.</p>
<p><code>typhonProject</code> contains two attributes: <code>meta</code> and <code>actions</code>. <code>meta</code> is an
attribute set which defines metadata about your project: a title, a description
and a homepage. <code>actions</code> is a derivation that builds actions for your project.
Actions are another core concept of Typhon and are introduced below.</p>
and a homepage. <code>actions</code> is an attribute set of derivations that build actions
for your project. Actions are another core concept of Typhon and are introduced
below.</p>
<h2 id="actions"><a class="header" href="#actions">Actions</a></h2>
<p>Actions are scripts called by Typhon for different purposes. At the moment there
are three actions a project can define.</p>
Expand All @@ -193,10 +194,10 @@ <h2 id="actions"><a class="header" href="#actions">Actions</a></h2>
can also be used for deployment.</p>
</li>
</ul>
<p>The <code>actions</code> attribute of <code>typhonProject</code> can also expose a <code>secrets</code> file.
This is an age encrypted JSON file that typically contains tokens for the
actions. It must be encrypted with the project's public key and is decrypted at
runtime and passed as input to the actions.</p>
<p>Actions can also expose a <code>secrets</code> file. This is an age encrypted JSON file
that typically contains tokens for the actions. It must be encrypted with the
project's public key and is decrypted at runtime and passed as input to the
actions.</p>
<h2 id="jobsets"><a class="header" href="#jobsets">Jobsets</a></h2>
<p>A Typhon jobset is a flake that exposes a <code>typhonJobs</code> attribute. <code>typhonJobs</code>
is an attribute set of derivations that are built by Typhon. Jobsets typically
Expand Down
23 changes: 11 additions & 12 deletions print.html
Original file line number Diff line number Diff line change
Expand Up @@ -185,8 +185,9 @@ <h2 id="projects"><a class="header" href="#projects">Projects</a></h2>
expose a <code>typhonProject</code> attribute defining the project settings.</p>
<p><code>typhonProject</code> contains two attributes: <code>meta</code> and <code>actions</code>. <code>meta</code> is an
attribute set which defines metadata about your project: a title, a description
and a homepage. <code>actions</code> is a derivation that builds actions for your project.
Actions are another core concept of Typhon and are introduced below.</p>
and a homepage. <code>actions</code> is an attribute set of derivations that build actions
for your project. Actions are another core concept of Typhon and are introduced
below.</p>
<h2 id="actions"><a class="header" href="#actions">Actions</a></h2>
<p>Actions are scripts called by Typhon for different purposes. At the moment there
are three actions a project can define.</p>
Expand All @@ -203,10 +204,10 @@ <h2 id="actions"><a class="header" href="#actions">Actions</a></h2>
can also be used for deployment.</p>
</li>
</ul>
<p>The <code>actions</code> attribute of <code>typhonProject</code> can also expose a <code>secrets</code> file.
This is an age encrypted JSON file that typically contains tokens for the
actions. It must be encrypted with the project's public key and is decrypted at
runtime and passed as input to the actions.</p>
<p>Actions can also expose a <code>secrets</code> file. This is an age encrypted JSON file
that typically contains tokens for the actions. It must be encrypted with the
project's public key and is decrypted at runtime and passed as input to the
actions.</p>
<h2 id="jobsets"><a class="header" href="#jobsets">Jobsets</a></h2>
<p>A Typhon jobset is a flake that exposes a <code>typhonJobs</code> attribute. <code>typhonJobs</code>
is an attribute set of derivations that are built by Typhon. Jobsets typically
Expand Down Expand Up @@ -304,9 +305,8 @@ <h2 id="declare-a-project"><a class="header" href="#declare-a-project">Declare a
inputs = { typhon.url = &quot;github:typhon-ci/typhon&quot;; };

outputs = { self, typhon }:
let libTyphon = typhon.actions.&quot;x86_64-linux&quot;;
in {
typhonProject = libTyphon.mkGithubProject {
{
typhonProject = typhon.lib.github.mkGithubProject {
owner = &quot;user&quot;;
repo = &quot;project&quot;;
secrets = ./secrets.age;
Expand All @@ -321,8 +321,7 @@ <h2 id="declare-a-project"><a class="header" href="#declare-a-project">Declare a
}
</code></pre>
<p>Encrypt the JSON file with <code>age</code>:</p>
<pre><code class="language-shell">nix shell nixpkgs#age
age --encrypt -r $public_key -o secrets.age secrets.json
<pre><code class="language-shell">nix run nixpkgs#age -- --encrypt -r $public_key -o secrets.age secrets.json
</code></pre>
<p>Finally, you need to commit the lock file of your flake.</p>
<h2 id="declare-jobs"><a class="header" href="#declare-jobs">Declare jobs</a></h2>
Expand All @@ -336,7 +335,7 @@ <h2 id="declare-jobs"><a class="header" href="#declare-jobs">Declare jobs</a></h
system = &quot;x86_64-linux&quot;;
pkgs = import nixpkgs { inherit system; };
in {
typhonJobs = {
typhonJobs.${system} = {
inherit (pkgs) hello;
};
};
Expand Down
2 changes: 1 addition & 1 deletion searchindex.js

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion searchindex.json

Large diffs are not rendered by default.

10 changes: 4 additions & 6 deletions usage.html
Original file line number Diff line number Diff line change
Expand Up @@ -187,9 +187,8 @@ <h2 id="declare-a-project"><a class="header" href="#declare-a-project">Declare a
inputs = { typhon.url = &quot;github:typhon-ci/typhon&quot;; };

outputs = { self, typhon }:
let libTyphon = typhon.actions.&quot;x86_64-linux&quot;;
in {
typhonProject = libTyphon.mkGithubProject {
{
typhonProject = typhon.lib.github.mkGithubProject {
owner = &quot;user&quot;;
repo = &quot;project&quot;;
secrets = ./secrets.age;
Expand All @@ -204,8 +203,7 @@ <h2 id="declare-a-project"><a class="header" href="#declare-a-project">Declare a
}
</code></pre>
<p>Encrypt the JSON file with <code>age</code>:</p>
<pre><code class="language-shell">nix shell nixpkgs#age
age --encrypt -r $public_key -o secrets.age secrets.json
<pre><code class="language-shell">nix run nixpkgs#age -- --encrypt -r $public_key -o secrets.age secrets.json
</code></pre>
<p>Finally, you need to commit the lock file of your flake.</p>
<h2 id="declare-jobs"><a class="header" href="#declare-jobs">Declare jobs</a></h2>
Expand All @@ -219,7 +217,7 @@ <h2 id="declare-jobs"><a class="header" href="#declare-jobs">Declare jobs</a></h
system = &quot;x86_64-linux&quot;;
pkgs = import nixpkgs { inherit system; };
in {
typhonJobs = {
typhonJobs.${system} = {
inherit (pkgs) hello;
};
};
Expand Down

0 comments on commit b193544

Please sign in to comment.