Skip to content

Commit 8378458

Browse files
clebergnuclebergnu
committed
Merge remote-tracking branch 'richtja/autils_meta'
Signed-off-by: Cleber Rosa <[email protected]>
2 parents ec93362 + 388cc13 commit 8378458

File tree

6 files changed

+185
-0
lines changed

6 files changed

+185
-0
lines changed

‎.github/workflows/jekyll-gh-pages.yml

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
# Sample workflow for building and deploying a Jekyll site to GitHub Pages
2+
name: Deploy Jekyll with GitHub Pages dependencies preinstalled
3+
4+
on:
5+
# Runs on pushes targeting the default branch
6+
push:
7+
branches: ["master"]
8+
9+
# Allows you to run this workflow manually from the Actions tab
10+
workflow_dispatch:
11+
12+
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
13+
permissions:
14+
contents: read
15+
pages: write
16+
id-token: write
17+
18+
# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
19+
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
20+
concurrency:
21+
group: "pages"
22+
cancel-in-progress: false
23+
24+
jobs:
25+
# Build job
26+
build:
27+
runs-on: ubuntu-latest
28+
steps:
29+
- name: Checkout
30+
uses: actions/checkout@v3
31+
with:
32+
path: main
33+
- name: Clone autils repo
34+
uses: actions/checkout@v3
35+
with:
36+
repository: avocado-framework/autils
37+
path: resources/autils
38+
ref: main
39+
- name: Copy autils metadate to _data dir
40+
run: cp -r resources/autils/metadata/autils/* main/_data/autils/
41+
- name: Setup Pages
42+
uses: actions/configure-pages@v3
43+
- name: Build with Jekyll
44+
uses: actions/jekyll-build-pages@v1
45+
with:
46+
source: main/
47+
destination: main/_site
48+
- name: Upload artifact
49+
uses: actions/upload-pages-artifact@v1
50+
with:
51+
path: main/_site/
52+
53+
# Deployment job
54+
deploy:
55+
environment:
56+
name: github-pages
57+
url: ${{ steps.deployment.outputs.page_url }}
58+
runs-on: ubuntu-latest
59+
needs: build
60+
steps:
61+
- name: Deploy to GitHub Pages
62+
id: deployment
63+
uses: actions/deploy-pages@v2

‎.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
_site
2+
_data/autils/

‎_data/autils/.gitkeep

Whitespace-only changes.

‎_includes/sidebar.html

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
<h3><a href="installation.html">Installation</a></h3>
22
<h3><a href="quickguide.html">Quick Guide</a></h3>
3+
<h3><a href="utils.html">Utility Libraries</a></h3>
34

45

56
<br/>

‎_layouts/utils.html

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
<!DOCTYPE html>
2+
<html lang="{{ site.lang | default: "en-US" }}">
3+
<head>
4+
<meta charset='utf-8'>
5+
<meta http-equiv="X-UA-Compatible" content="IE=edge">
6+
<meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1">
7+
<link rel="stylesheet" href="{{ '/assets/css/style.css?v=' | append: site.github.build_revision | relative_url }}" media="screen" type="text/css">
8+
<link rel="stylesheet" href="{{ '/assets/css/print.css' | relative_url }}" media="print" type="text/css">
9+
<link rel="stylesheet" href="https://cdn.datatables.net/1.12.1/css/jquery.dataTables.css" type="text/css">
10+
11+
<!--[if lt IE 9]>
12+
<script src="https://oss.maxcdn.com/html5shiv/3.7.3/html5shiv.min.js"></script>
13+
<![endif]-->
14+
15+
16+
</head>
17+
18+
<body>
19+
<header>
20+
<div class="inner">
21+
<a href="{{ '/' | absolute_url }}">
22+
<h1>{{ site.title | default: site.github.repository_name }}</h1>
23+
</a>
24+
<h2>{{ site.description | default: site.github.project_tagline }}</h2>
25+
<a href="{{ site.github.repository_url }}" class="button"><small>View project on</small> GitHub</a>
26+
</div>
27+
</header>
28+
29+
<div id="content-wrapper">
30+
<div class="inner clearfix">
31+
<section id="main-content">
32+
{{ content }}
33+
</section>
34+
35+
</div>
36+
</div>
37+
38+
<footer>
39+
{% if site.github.is_project_page %}
40+
<p class="repo-owner"><a href="{{ site.github.repository_url }}">{{ site.github.repository_name }}</a> is maintained by <a href="{{ site.github.owner_url }}">{{ site.github.owner_name }}</a>.</p>
41+
{% endif %}
42+
43+
<p>Copyright © 2014-2022 Red Hat Inc. and Avocado Community Contributors<br />
44+
Background <a href="https://www.flickr.com/photos/sara_joachim/2473587957">Avocado Tree Picture</a> by Joachim Huber, CC BY-SA 2.0.</p>
45+
</footer>
46+
47+
<script type="text/javascript" src="https://ajax.googleapis.com/ajax/libs/jquery/3.6.0/jquery.min.js"></script>
48+
<script type="text/javascript" charset="utf8" src="https://cdn.datatables.net/1.12.1/js/jquery.dataTables.js"></script>
49+
<script>
50+
$(document).ready(function () {
51+
$("#utils-table").DataTable();
52+
});
53+
</script>
54+
</body>
55+
</html>

‎utils.md

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
---
2+
layout: utils
3+
---
4+
5+
# Utility Libraries
6+
7+
<table id="utils-table">
8+
<thead>
9+
<tr class="header">
10+
<th>Name/Description</th>
11+
<th>Category</th>
12+
<th>Maintainer</th>
13+
<th>Supported Platforms</th>
14+
<th>tests</th>
15+
<th>remote</th>
16+
</tr>
17+
</thead>
18+
19+
<tbody>
20+
{% for util_dir_hash in site.data.autils %}
21+
{% assign util_dir = util_dir_hash[1] %}
22+
{% for util_hash in util_dir %}
23+
{% assign util = util_hash[1] %}
24+
<tr>
25+
<td>
26+
<strong markdown="spawn">{{util.name}}</strong>
27+
<p markdown="spawn">{{util.description}}</p>
28+
</td>
29+
<td>
30+
<ul>
31+
{% for category in util.categories %}
32+
<li markdown="span">{{category}}</li>
33+
{% endfor %}
34+
</ul>
35+
</td>
36+
<td>
37+
<ul>
38+
{% for maintainer in util.maintainers %}
39+
<li markdown="span">{{maintainer["name"]}}, {{maintainer["email"]}}</li>
40+
{% endfor %}
41+
</ul>
42+
</td>
43+
<td>
44+
<ul>
45+
{% for platform in util.supported_platforms %}
46+
<li markdown="span">{{platform}}</li>
47+
{% endfor %}
48+
</ul>
49+
</td>
50+
<td>
51+
<ul>
52+
{% for test in util.tests %}
53+
<li markdown="span">{{test}}</li>
54+
{% endfor %}
55+
</ul>
56+
</td>
57+
<td markdown="span">{{util.remote}}</td>
58+
</tr>
59+
{% endfor %}
60+
{% endfor %}
61+
</tbody>
62+
</table>
63+
64+

0 commit comments

Comments
 (0)