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

Added jenkins CI file guide #6

Merged
merged 2 commits into from
Sep 10, 2024
Merged

Added jenkins CI file guide #6

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
9914a77
Added jenkins CI file integration
alitariq4589 Sep 9, 2024
4df9f20
Built the docs
alitariq4589 Sep 9, 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
Binary file modified docs/doctrees/environment.pickle
View file
Open in desktop
Binary file not shown.
Binary file modified docs/doctrees/index.doctree
View file
Open in desktop
Binary file not shown.
2 changes: 1 addition & 1 deletion docs/html/.buildinfo
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: 79308397ec0026139f761d4fe37320f4
config: 1e1fa9dffe0ce62d769806e304ef907b
tags: 645f666f9bcd5a90fca523b33c5a78b7
7 changes: 4 additions & 3 deletions docs/html/_static/searchtools.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -178,7 +178,7 @@ const Search = {

htmlToText: (htmlString, anchor) => {
const htmlElement = new DOMParser().parseFromString(htmlString, 'text/html');
for (const removalQuery of [".headerlinks", "script", "style"]) {
for (const removalQuery of [".headerlink", "script", "style"]) {
htmlElement.querySelectorAll(removalQuery).forEach((el) => { el.remove() });
}
if (anchor) {
Expand Down Expand Up @@ -328,13 +328,14 @@ const Search = {
for (const [title, foundTitles] of Object.entries(allTitles)) {
if (title.toLowerCase().trim().includes(queryLower) && (queryLower.length >= title.length/2)) {
for (const [file, id] of foundTitles) {
let score = Math.round(100 * queryLower.length / title.length)
const score = Math.round(Scorer.title * queryLower.length / title.length);
const boost = titles[file] === title ? 1 : 0; // add a boost for document titles
normalResults.push([
docNames[file],
titles[file] !== title ? `${titles[file]} > ${title}` : title,
id !== null ? "#" + id : "",
null,
score,
score + boost,
filenames[file],
]);
}
Expand Down
4 changes: 2 additions & 2 deletions docs/html/genindex.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,8 +48,8 @@
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<ul>
<li class="toctree-l1"><a class="reference internal" href="becoming_lab_partner.html">Becoming an RISC-V Ecosystem Labs Partner</a></li>
<li class="toctree-l1"><a class="reference internal" href="ci_hosting.html">Hosting a Continuous Integration (CI) Project at a Lab</a></li>
<li class="toctree-l1"><a class="reference internal" href="becoming_eco_lab_partner.html">Becoming an RISC-V Ecosystem Labs Partner</a></li>
<li class="toctree-l1"><a class="reference internal" href="ci_hosting.html">Hosting Continuous Integration (CI) for RISC-V</a></li>
</ul>

</div>
Expand Down
20 changes: 14 additions & 6 deletions docs/html/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Becoming an RISC-V Ecosystem Labs Partner" href="becoming_lab_partner.html" />
<link rel="next" title="Becoming an RISC-V Ecosystem Labs Partner" href="becoming_eco_lab_partner.html" />
</head>

<body class="wy-body-for-nav">
Expand All @@ -50,8 +50,8 @@
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<ul>
<li class="toctree-l1"><a class="reference internal" href="becoming_lab_partner.html">Becoming an RISC-V Ecosystem Labs Partner</a></li>
<li class="toctree-l1"><a class="reference internal" href="ci_hosting.html">Hosting a Continuous Integration (CI) Project at a Lab</a></li>
<li class="toctree-l1"><a class="reference internal" href="becoming_eco_lab_partner.html">Becoming an RISC-V Ecosystem Labs Partner</a></li>
<li class="toctree-l1"><a class="reference internal" href="ci_hosting.html">Hosting Continuous Integration (CI) for RISC-V</a></li>
</ul>

</div>
Expand Down Expand Up @@ -84,8 +84,16 @@ <h1>RISC-V Labs Best Practices Documentation<a class="headerlink" href="#risc-v-
<p>Documents</p>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="becoming_lab_partner.html">Becoming an RISC-V Ecosystem Labs Partner</a></li>
<li class="toctree-l1"><a class="reference internal" href="ci_hosting.html">Hosting a Continuous Integration (CI) Project at a Lab</a><ul>
<li class="toctree-l1"><a class="reference internal" href="becoming_eco_lab_partner.html">Becoming an RISC-V Ecosystem Labs Partner</a><ul>
<li class="toctree-l2"><a class="reference internal" href="becoming_eco_lab_partner.html#overview">Overview</a></li>
<li class="toctree-l2"><a class="reference internal" href="becoming_eco_lab_partner.html#membership">Membership</a></li>
<li class="toctree-l2"><a class="reference internal" href="becoming_eco_lab_partner.html#community">Community</a></li>
<li class="toctree-l2"><a class="reference internal" href="becoming_eco_lab_partner.html#meetings">Meetings</a></li>
<li class="toctree-l2"><a class="reference internal" href="becoming_eco_lab_partner.html#becoming-and-ecosystem-lab-partner">Becoming and Ecosystem Lab Partner</a></li>
<li class="toctree-l2"><a class="reference internal" href="becoming_eco_lab_partner.html#questions">Questions</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="ci_hosting.html">Hosting Continuous Integration (CI) for RISC-V</a><ul>
<li class="toctree-l2"><a class="reference internal" href="hosting_jenkins.html">Hosting RISC-V CI through Jenkins</a></li>
</ul>
</li>
Expand All @@ -97,7 +105,7 @@ <h1>RISC-V Labs Best Practices Documentation<a class="headerlink" href="#risc-v-
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="becoming_lab_partner.html" class="btn btn-neutral float-right" title="Becoming an RISC-V Ecosystem Labs Partner" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
<a href="becoming_eco_lab_partner.html" class="btn btn-neutral float-right" title="Becoming an RISC-V Ecosystem Labs Partner" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>

<hr/>
Expand Down
Binary file modified docs/html/objects.inv
View file
Open in desktop
Binary file not shown.
4 changes: 2 additions & 2 deletions docs/html/search.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,8 +51,8 @@
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<ul>
<li class="toctree-l1"><a class="reference internal" href="becoming_lab_partner.html">Becoming an RISC-V Ecosystem Labs Partner</a></li>
<li class="toctree-l1"><a class="reference internal" href="ci_hosting.html">Hosting a Continuous Integration (CI) Project at a Lab</a></li>
<li class="toctree-l1"><a class="reference internal" href="becoming_eco_lab_partner.html">Becoming an RISC-V Ecosystem Labs Partner</a></li>
<li class="toctree-l1"><a class="reference internal" href="ci_hosting.html">Hosting Continuous Integration (CI) for RISC-V</a></li>
</ul>

</div>
Expand Down
2 changes: 1 addition & 1 deletion docs/html/searchindex.js
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions source/ci_hosting.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
======================================================
Hosting a Continuous Integration (CI) Project at a Lab
Hosting Continuous Integration (CI) for RISC-V
======================================================

Hosting a continuous integration project at a lab means providing RISC-V hardware or emulated compute instances as CI runners/agents for public use. CI compute instances can be integrated with version control systems such as GitHub, GitLab, etc. and can automate the build process of the source code for developers.

Following version control systems currently support RISC-V CI:
Following platforms currently support RISC-V CI:

#. Jenkins
#. GitLab
Expand Down
Loading
Loading