Skip to content

Commit

Permalink
Deploy ec1cde1e289c14bd4e276cb85e9a2814367a1e41
Browse files Browse the repository at this point in the history
  • Loading branch information
Tarides Pipeline committed Jun 22, 2023
1 parent ea42256 commit 06d5740
Show file tree
Hide file tree
Showing 26 changed files with 122 additions and 118 deletions.
4 changes: 2 additions & 2 deletions docs/docker-base-images/index.xml
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,11 @@
<description>Recent content in Docker Base Images on OCurrent</description>
<generator>Hugo -- gohugo.io</generator>
<language>en-us</language>
<lastBuildDate>Thu, 30 Mar 2023 00:00:00 +0000</lastBuildDate><atom:link href="https://www.ocurrent.org/docs/docker-base-images/index.xml" rel="self" type="application/rss+xml" />
<lastBuildDate>Thu, 22 Jun 2023 00:00:00 +0000</lastBuildDate><atom:link href="https://www.ocurrent.org/docs/docker-base-images/index.xml" rel="self" type="application/rss+xml" />
<item>
<title>Readme</title>
<link>https://www.ocurrent.org/docs/docker-base-images/readme/</link>
<pubDate>Thu, 30 Mar 2023 00:00:00 +0000</pubDate>
<pubDate>Thu, 22 Jun 2023 00:00:00 +0000</pubDate>

<guid>https://www.ocurrent.org/docs/docker-base-images/readme/</guid>
<description>Readme</description>
Expand Down
4 changes: 2 additions & 2 deletions docs/docker-base-images/readme/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@
<meta property="og:description" content="Readme" />
<meta property="og:type" content="article" />
<meta property="og:url" content="https://www.ocurrent.org/docs/docker-base-images/readme/" /><meta property="article:section" content="docs" />
<meta property="article:published_time" content="2023-03-30T00:00:00+00:00" />
<meta property="article:modified_time" content="2023-03-30T00:00:00+00:00" />
<meta property="article:published_time" content="2023-06-22T00:00:00+00:00" />
<meta property="article:modified_time" content="2023-06-22T00:00:00+00:00" />

<link
rel="stylesheet"
Expand Down
28 changes: 14 additions & 14 deletions docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -158,7 +158,7 @@ <h2>Opam Repo CI</h2>

</div>
<div class="metadata">
by The OCurrent Team on March 30, 2023
by The OCurrent Team on June 22, 2023
</div>
<div class="summary">Readme</div>
</div>
Expand All @@ -177,7 +177,7 @@ <h2>Opam Health Check</h2>

</div>
<div class="metadata">
by The OCurrent Team on March 30, 2023
by The OCurrent Team on June 22, 2023
</div>
<div class="summary">Readme</div>
</div>
Expand All @@ -196,7 +196,7 @@ <h2>OCurrent Deployer</h2>

</div>
<div class="metadata">
by The OCurrent Team on March 30, 2023
by The OCurrent Team on June 22, 2023
</div>
<div class="summary">VM Host Machine</div>
</div>
Expand All @@ -208,7 +208,7 @@ <h2>OCurrent Deployer</h2>

</div>
<div class="metadata">
by The OCurrent Team on March 30, 2023
by The OCurrent Team on June 22, 2023
</div>
<div class="summary">Readme</div>
</div>
Expand All @@ -227,7 +227,7 @@ <h2>OCurrent</h2>

</div>
<div class="metadata">
by The OCurrent Team on March 30, 2023
by The OCurrent Team on June 22, 2023
</div>
<div class="summary">Write your own plugin</div>
</div>
Expand All @@ -239,7 +239,7 @@ <h2>OCurrent</h2>

</div>
<div class="metadata">
by The OCurrent Team on March 30, 2023
by The OCurrent Team on June 22, 2023
</div>
<div class="summary">The build cache</div>
</div>
Expand All @@ -251,7 +251,7 @@ <h2>OCurrent</h2>

</div>
<div class="metadata">
by The OCurrent Team on March 30, 2023
by The OCurrent Team on June 22, 2023
</div>
<div class="summary">Internal overview</div>
</div>
Expand All @@ -263,7 +263,7 @@ <h2>OCurrent</h2>

</div>
<div class="metadata">
by The OCurrent Team on March 30, 2023
by The OCurrent Team on June 22, 2023
</div>
<div class="summary">Example pipelines</div>
</div>
Expand All @@ -282,7 +282,7 @@ <h2>OCaml Multicore CI</h2>

</div>
<div class="metadata">
by The OCurrent Team on March 30, 2023
by The OCurrent Team on June 22, 2023
</div>
<div class="summary">Readme</div>
</div>
Expand All @@ -301,7 +301,7 @@ <h2>OCaml Docs CI</h2>

</div>
<div class="metadata">
by The OCurrent Team on March 30, 2023
by The OCurrent Team on June 22, 2023
</div>
<div class="summary">Readme</div>
</div>
Expand All @@ -320,7 +320,7 @@ <h2>OCaml CI</h2>

</div>
<div class="metadata">
by The OCurrent Team on March 30, 2023
by The OCurrent Team on June 22, 2023
</div>
<div class="summary">Readme</div>
</div>
Expand All @@ -332,7 +332,7 @@ <h2>OCaml CI</h2>

</div>
<div class="metadata">
by The OCurrent Team on March 30, 2023
by The OCurrent Team on June 22, 2023
</div>
<div class="summary">Development notes</div>
</div>
Expand All @@ -344,7 +344,7 @@ <h2>OCaml CI</h2>

</div>
<div class="metadata">
by The OCurrent Team on March 30, 2023
by The OCurrent Team on June 22, 2023
</div>
<div class="summary">Deploy on Docker</div>
</div>
Expand All @@ -363,7 +363,7 @@ <h2>Docker Base Images</h2>

</div>
<div class="metadata">
by The OCurrent Team on March 30, 2023
by The OCurrent Team on June 22, 2023
</div>
<div class="summary">Readme</div>
</div>
Expand Down
2 changes: 1 addition & 1 deletion docs/index.xml
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,6 @@
<description>Recent content in OCurrent Docs on OCurrent</description>
<generator>Hugo -- gohugo.io</generator>
<language>en-us</language>
<lastBuildDate>Thu, 30 Mar 2023 00:00:00 +0000</lastBuildDate><atom:link href="https://www.ocurrent.org/docs/index.xml" rel="self" type="application/rss+xml" />
<lastBuildDate>Thu, 22 Jun 2023 00:00:00 +0000</lastBuildDate><atom:link href="https://www.ocurrent.org/docs/index.xml" rel="self" type="application/rss+xml" />
</channel>
</rss>
4 changes: 2 additions & 2 deletions docs/ocaml-ci/dev/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@
<meta property="og:description" content="Development notes" />
<meta property="og:type" content="article" />
<meta property="og:url" content="https://www.ocurrent.org/docs/ocaml-ci/dev/" /><meta property="article:section" content="docs" />
<meta property="article:published_time" content="2023-03-30T00:00:00+00:00" />
<meta property="article:modified_time" content="2023-03-30T00:00:00+00:00" />
<meta property="article:published_time" content="2023-06-22T00:00:00+00:00" />
<meta property="article:modified_time" content="2023-06-22T00:00:00+00:00" />

<link
rel="stylesheet"
Expand Down
4 changes: 2 additions & 2 deletions docs/ocaml-ci/docker-deployment/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@
<meta property="og:description" content="Deploy on Docker" />
<meta property="og:type" content="article" />
<meta property="og:url" content="https://www.ocurrent.org/docs/ocaml-ci/docker-deployment/" /><meta property="article:section" content="docs" />
<meta property="article:published_time" content="2023-03-30T00:00:00+00:00" />
<meta property="article:modified_time" content="2023-03-30T00:00:00+00:00" />
<meta property="article:published_time" content="2023-06-22T00:00:00+00:00" />
<meta property="article:modified_time" content="2023-06-22T00:00:00+00:00" />

<link
rel="stylesheet"
Expand Down
8 changes: 4 additions & 4 deletions docs/ocaml-ci/index.xml
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,11 @@
<description>Recent content in OCaml CI on OCurrent</description>
<generator>Hugo -- gohugo.io</generator>
<language>en-us</language>
<lastBuildDate>Thu, 30 Mar 2023 00:00:00 +0000</lastBuildDate><atom:link href="https://www.ocurrent.org/docs/ocaml-ci/index.xml" rel="self" type="application/rss+xml" />
<lastBuildDate>Thu, 22 Jun 2023 00:00:00 +0000</lastBuildDate><atom:link href="https://www.ocurrent.org/docs/ocaml-ci/index.xml" rel="self" type="application/rss+xml" />
<item>
<title>Deploy on Docker</title>
<link>https://www.ocurrent.org/docs/ocaml-ci/docker-deployment/</link>
<pubDate>Thu, 30 Mar 2023 00:00:00 +0000</pubDate>
<pubDate>Thu, 22 Jun 2023 00:00:00 +0000</pubDate>

<guid>https://www.ocurrent.org/docs/ocaml-ci/docker-deployment/</guid>
<description>Deploy on Docker</description>
Expand All @@ -19,7 +19,7 @@
<item>
<title>Development notes</title>
<link>https://www.ocurrent.org/docs/ocaml-ci/dev/</link>
<pubDate>Thu, 30 Mar 2023 00:00:00 +0000</pubDate>
<pubDate>Thu, 22 Jun 2023 00:00:00 +0000</pubDate>

<guid>https://www.ocurrent.org/docs/ocaml-ci/dev/</guid>
<description>Development notes</description>
Expand All @@ -28,7 +28,7 @@
<item>
<title>Readme</title>
<link>https://www.ocurrent.org/docs/ocaml-ci/readme/</link>
<pubDate>Thu, 30 Mar 2023 00:00:00 +0000</pubDate>
<pubDate>Thu, 22 Jun 2023 00:00:00 +0000</pubDate>

<guid>https://www.ocurrent.org/docs/ocaml-ci/readme/</guid>
<description>Readme</description>
Expand Down
20 changes: 12 additions & 8 deletions docs/ocaml-ci/readme/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@
<meta property="og:description" content="Readme" />
<meta property="og:type" content="article" />
<meta property="og:url" content="https://www.ocurrent.org/docs/ocaml-ci/readme/" /><meta property="article:section" content="docs" />
<meta property="article:published_time" content="2023-03-30T00:00:00+00:00" />
<meta property="article:modified_time" content="2023-03-30T00:00:00+00:00" />
<meta property="article:published_time" content="2023-06-22T00:00:00+00:00" />
<meta property="article:modified_time" content="2023-06-22T00:00:00+00:00" />

<link
rel="stylesheet"
Expand Down Expand Up @@ -85,7 +85,7 @@ <h1>Readme</h1>


<h1 id="ocaml-ci">OCaml-CI</h1>
<p><a href="https://ci.ocamllabs.io/github/ocurrent/ocaml-ci"><img src="https://img.shields.io/endpoint?url=https%3A%2F%2Fci.ocamllabs.io%2Fbadge%2Focurrent%2Focaml-ci%2Fmaster&amp;logo=ocaml" alt="OCaml-CI Build Status"></a></p>
<p><a href="https://ocaml.ci.dev/github/ocurrent/ocaml-ci"><img src="https://img.shields.io/endpoint?url=https%3A%2F%2Focaml.ci.dev%2Fbadge%2Focurrent%2Focaml-ci%2Fmaster&amp;logo=ocaml" alt="OCaml-CI Build Status"></a></p>
<p>This is an <a href="https://github.com/ocurrent/ocurrent">OCurrent</a> pipeline that provides CI for OCaml projects hosted on GitHub.
It uses metadata from the project’s opam and dune files to work out what to build,
and uses caching to make builds fast. It automatically tests projects against
Expand All @@ -108,15 +108,15 @@ <h1 id="ocaml-ci">OCaml-CI</h1>
<li>Ask us to add you to the alpha-testers list by submitting a PR against this
repository adding yourself to <code>--github-account-allowlist</code> in <code>stack.yml</code>. eg <a href="https://github.com/ocurrent/ocaml-ci/pull/346">https://github.com/ocurrent/ocaml-ci/pull/346</a>. Additionally, please add yourself to <code>deploy-data/github-organisations.txt</code>.</li>
<li>Add a status badge from the OCaml-CI endpoint with:
<pre tabindex="0"><code>[![OCaml-CI Build Status](https://img.shields.io/endpoint?url=https://ci.ocamllabs.io/badge/&lt;user&gt;/&lt;repo&gt;/&lt;branch&gt;&amp;logo=ocaml)](https://ci.ocamllabs.io/github/&lt;user&gt;/&lt;repo&gt;)
<pre tabindex="0"><code>[![OCaml-CI Build Status](https://img.shields.io/endpoint?url=https://ocaml.ci.dev/badge/&lt;user&gt;/&lt;repo&gt;/&lt;branch&gt;&amp;logo=ocaml)](https://ocaml.ci.dev/github/&lt;user&gt;/&lt;repo&gt;)
</code></pre></li>
<li>Report bugs :-)</li>
</ol>
<h2 id="installation">Installation</h2>
<p>Get the code with:</p>
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-sh" data-lang="sh"><span class="line"><span class="cl">git clone --recursive https://github.com/ocurrent/ocaml-ci.git
</span></span><span class="line"><span class="cl"><span class="nb">cd</span> ocaml-ci
</span></span><span class="line"><span class="cl">opam install --deps-only ./ocaml-version ./ocaml-dockerfile ./ocluster ./ocurrent .
</span></span><span class="line"><span class="cl">opam install --deps-only ./ocaml-dockerfile ./ocluster ./ocurrent ./solver-service .
</span></span></code></pre></div><p>Note: you need to clone with <code>--recursive</code> because this project uses submodules
(it depends on some packages that aren&rsquo;t released yet).
If you forget, <code>git submodule update --init</code> will fetch them.</p>
Expand Down Expand Up @@ -181,7 +181,7 @@ <h2 id="remote-api">Remote API</h2>
</span></span></code></pre></div><h2 id="deployment">Deployment</h2>
<p><code>ocaml-ci</code> is deployed as three docker images built from <code>Dockerfile</code>, <code>Dockerfile.gitlab</code> and <code>Dockerfile.web</code>, with
the live service following <code>live-engine</code> for the backend and <code>live-www</code> for the frontend.
An ocurrent-deployer <a href="deploy.ci3.ocamllabs.io">pipeline</a> watches these branches, performing a docker build
An ocurrent-deployer <a href="deploy.ci.dev">pipeline</a> watches these branches, performing a docker build
and deploy whenever it sees a new commit. The live branches should typically contain commits from <code>master</code> plus potentially
short lived commits for testing changes that are later merged into <code>master</code>.</p>
<p>To deploy code changes either from <code>master</code> or a branch:</p>
Expand All @@ -191,8 +191,12 @@ <h2 id="remote-api">Remote API</h2>
<li>git push -u upstream HEAD:live-www</li>
</ul>
<p>To deploy changes to <code>stack.yml</code> run (assuming a docker context with sufficient access):</p>
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"><span class="line"><span class="cl">docker -c ci.ocamllabs.io stack deploy -c stack.yml ocaml-ci
</span></span></code></pre></div><h2 id="local-development">Local development</h2>
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-bash" data-lang="bash"><span class="line"><span class="cl">docker -c ocaml.ci.dev stack deploy -c stack.yml ocaml-ci
</span></span></code></pre></div><h2 id="opam-repository-updates">Opam repository updates</h2>
<p>When it is updated <a href="https://github.com/ocaml/opam-repository"><code>opam-repository</code></a> sends a webhook to <code>Ocaml-ci</code> triggering its pipelines.
This mechanism allows builds to remain up to date with changes in the opam package ecosystem. For further details of this webhook,
please contact a maintainer of <code>opam-repository</code>.</p>
<h2 id="local-development">Local development</h2>
<p>See <a href="doc/dev.md">this document</a> for set up and running the server and web components locally.</p>


Expand Down
4 changes: 2 additions & 2 deletions docs/ocaml-docs-ci/index.xml
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,11 @@
<description>Recent content in OCaml Docs CI on OCurrent</description>
<generator>Hugo -- gohugo.io</generator>
<language>en-us</language>
<lastBuildDate>Thu, 30 Mar 2023 00:00:00 +0000</lastBuildDate><atom:link href="https://www.ocurrent.org/docs/ocaml-docs-ci/index.xml" rel="self" type="application/rss+xml" />
<lastBuildDate>Thu, 22 Jun 2023 00:00:00 +0000</lastBuildDate><atom:link href="https://www.ocurrent.org/docs/ocaml-docs-ci/index.xml" rel="self" type="application/rss+xml" />
<item>
<title>Readme</title>
<link>https://www.ocurrent.org/docs/ocaml-docs-ci/readme/</link>
<pubDate>Thu, 30 Mar 2023 00:00:00 +0000</pubDate>
<pubDate>Thu, 22 Jun 2023 00:00:00 +0000</pubDate>

<guid>https://www.ocurrent.org/docs/ocaml-docs-ci/readme/</guid>
<description>Readme</description>
Expand Down
20 changes: 10 additions & 10 deletions docs/ocaml-docs-ci/readme/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@
<meta property="og:description" content="Readme" />
<meta property="og:type" content="article" />
<meta property="og:url" content="https://www.ocurrent.org/docs/ocaml-docs-ci/readme/" /><meta property="article:section" content="docs" />
<meta property="article:published_time" content="2023-03-30T00:00:00+00:00" />
<meta property="article:modified_time" content="2023-03-30T00:00:00+00:00" />
<meta property="article:published_time" content="2023-06-22T00:00:00+00:00" />
<meta property="article:modified_time" content="2023-06-22T00:00:00+00:00" />

<link
rel="stylesheet"
Expand Down Expand Up @@ -85,7 +85,7 @@ <h1>Readme</h1>


<h1 id="docs-ci">Docs CI</h1>
<p><a href="https://ci.ocamllabs.io/github/ocurrent/ocaml-docs-ci"><img src="https://img.shields.io/endpoint?url=https%3A%2F%2Fci.ocamllabs.io%2Fbadge%2Focurrent%2Focaml-docs-ci%2Fmaster&amp;logo=ocaml" alt="OCaml-CI Build Status"></a></p>
<p><a href="https://ocaml.ci.dev/github/ocurrent/ocaml-docs-ci"><img src="https://img.shields.io/endpoint?url=https%3A%2F%2Focaml.ci.dev%2Fbadge%2Focurrent%2Focaml-docs-ci%2Fmain&amp;logo=ocaml" alt="OCaml-CI Build Status"></a></p>
<p>OCaml Docs CI (aka docs-ci) is an OCurrent pipeline used for building the documentation for ocaml.org website.
It uses the metadata from opam-repository to work out how to build documentation for individual
packages using <a href="">voodoo</a>, the OCaml package documentation generator, and generates a HTML output
Expand Down Expand Up @@ -129,21 +129,21 @@ <h2 id="deployment">Deployment</h2>
<td><a href="https://ocaml.org">https://ocaml.org</a></td>
<td><a href="https://docs.ci.ocaml.org">https://docs.ci.ocaml.org</a></td>
<td>live</td>
<td><a href="https://docs-data.ocaml.org/">https://docs-data.ocaml.org/</a></td>
<td><a href="http://docs-data.ocaml.org">http://docs-data.ocaml.org</a></td>
</tr>
<tr>
<td>Staging</td>
<td><a href="https://staging.ocaml.org">https://staging.ocaml.org</a></td>
<td><a href="https://docs-staging.sw.ocaml.org">https://docs-staging.sw.ocaml.org</a></td>
<td><a href="https://staging.docs.ci.ocaml.org">https://staging.docs.ci.ocaml.org</a></td>
<td>staging</td>
<td><a href="https://docs-data.ocamllabs.io/">https://docs-data.ocamllabs.io/</a></td>
<td><a href="http://staging.docs-data.ocaml.org">http://staging.docs-data.ocaml.org</a></td>
</tr>
</tbody>
</table>
<p>OAuth integration provided by GitHub OAuth Apps hosted under the OCurrent organisation.
See <a href="https://github.com/organizations/ocurrent/settings/applications">https://github.com/organizations/ocurrent/settings/applications</a></p>
<p>The infrastructure for <code>ocaml-docs-ci</code> is managed via Ansible.
Contact @tmcgilchrist or @mtelevers if you need access or have questions.</p>
Contact @tmcgilchrist or @mtelvers if you need access or have questions.</p>
<p>To deploy a new version of <code>docs-ci</code>:</p>
<ol>
<li>Create a PR and wait for the GH Checks to run (ocaml-ci compiles the code and ocurrent-deployer checks it can build the Dockerfiles for the project)</li>
Expand Down Expand Up @@ -175,9 +175,9 @@ <h2 id="local-development">Local Development</h2>
<li>nginx webserver for generated docs</li>
<li>docs-ci built from the local git checkout</li>
</ul>
<p>First we need to bootstrap an ocluster-worker</p>
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-shell" data-lang="shell"><span class="line"><span class="cl">docker build -t ocluster-worker -f vendor/ocluster/Dockerfile.worker.alpine vendor/ocluster
</span></span></code></pre></div><p>then create the environment using <code>docker-compose -f docker-compose.yml up</code></p>
<p>Run this command to create an environment:</p>
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-shell" data-lang="shell"><span class="line"><span class="cl">$ docker-compose -f docker-compose.yml up
</span></span></code></pre></div><p>You should then be able to watch the pipeline in action at <code>http://localhost:8080</code>.</p>


</main>
Expand Down
Loading

0 comments on commit 06d5740

Please sign in to comment.