Skip to content

Commit 1dfda50

Browse files
authored
feat(meta): Add further repository scaffolding
Merge pull request #3 from NucciTheBoss/repo-scaffolding
2 parents 97019fe + a8fb138 commit 1dfda50

File tree

6 files changed

+94
-12
lines changed

6 files changed

+94
-12
lines changed
Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
name: Bug Report
2+
description: File a bug report
3+
labels: ["Type: Bug", "Status: Triage"]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: >
8+
Thanks for taking the time to fill out this bug report! Before submitting your issue, please make
9+
sure you are using the latest version of the OCI image. If not, please switch to the
10+
latest version of this OCI image before posting your report to make sure it's not already solved.
11+
- type: textarea
12+
id: bug-description
13+
attributes:
14+
label: Bug Description
15+
description: >
16+
Provide a description of the issue you are facing. If applicable, add screenshots to help explain the problem.
17+
validations:
18+
required: true
19+
- type: textarea
20+
id: reproduction
21+
attributes:
22+
label: To Reproduce
23+
description: >
24+
Please provide a step-by-step instruction of how to reproduce the behavior.
25+
placeholder: |
26+
1. `sarus pull ...`
27+
2. `sarus run ...`
28+
3. `See error...`
29+
validations:
30+
required: true
31+
- type: textarea
32+
id: environment
33+
attributes:
34+
label: Environment
35+
description: >
36+
We need to know a bit more about the context in which you run the OCI image.
37+
- Are you running the image locally, on an HPC cluster, or on some other platform?
38+
- What version of the OCI image are you using?
39+
- Version of any applicable components, like MPI implementation, host operating system version, container runtime, etc.
40+
validations:
41+
required: true
42+
- type: textarea
43+
id: logs
44+
attributes:
45+
label: Relevant log output
46+
description: >
47+
Please copy and paste any relevant log output. This will be
48+
automatically formatted into code, so no need for backticks.
49+
render: shell
50+
validations:
51+
required: true
52+
- type: textarea
53+
id: additional-context
54+
attributes:
55+
label: Additional context

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
## Description
2+
3+
> Provide a description of the purpose of this pull request, as well as its
4+
motivation and context. Is it a new feature? A bug fix? Does it address an existing issue?
5+
6+
## How was the code tested?
7+
8+
> Describe the conditions under which the code has been tested.
9+
> * What tests did you run?
10+
> * Did you write new tests? Where are they located in the repository?
11+
> * Where did you run the tests? LXD, vSphere, AWS, etc.
12+
> * What operating system did you test the charms on? Ubuntu 22.04, Ubuntu 20.04, CentOS 7, etc.
13+
14+
## Related issues and/or tasks
15+
16+
> Link any related issues or project board tasks to this pull request.
17+
18+
## Checklist
19+
20+
- [ ] I am the author of these changes, or I have the rights to submit them.
21+
- [ ] I have added the relevant changes to the README and/or documentation.
22+
- [ ] I have self reviewed my own code.
23+
- [ ] All requested changes and/or review comments have been resolved.

.github/workflows/ci.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
# See the License for the specific language governing permissions and
1313
# limitations under the License.
1414

15-
name: HPL ROCK tests
15+
name: hpl-rock tests
1616
on:
1717
workflow_call:
1818
pull_request:

.github/workflows/cla-check.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
# See the License for the specific language governing permissions and
1313
# limitations under the License.
1414

15-
name: cla-check
15+
name: CLA check
1616
on:
1717
workflow_call:
1818
pull_request:

.github/workflows/release.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
# See the License for the specific language governing permissions and
1313
# limitations under the License.
1414

15-
name: Release HPL ROCK to ghcr
15+
name: Release to ghcr
1616
on:
1717
workflow_call:
1818
push:

README.md

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,27 @@
11
<div align="center">
22

3-
# High-Peformance Linpack (HPL) ROCK
3+
# High-Performance Linpack (HPL) ROCK
44

5-
An Ubuntu 22.04 LTS-based [ROCK](https://canonical-rockcraft.readthedocs-hosted.com/en/latest/explanation/rocks/#rocks-explanation)
6-
image for running HPL, a portable implementation of the High-Performance Linpack
7-
Benchmark for Distributed-Memory Computers. HPL is used to benchmark the [Top 500 supercomputers](https://www.top500.org).
5+
An Ubuntu 22.04 LTS-based OCI image for running HPL, a portable implementation of the High-Performance Linpack Benchmark for Distributed-Memory Computers. HPL is used to
6+
benchmark the [Top 500 supercomputers](https://www.top500.org).
87

8+
9+
[![CI](https://github.com/canonical/hpl-rock/actions/workflows/ci.yaml/badge.svg)](https://github.com/canonical/hpl-rock/actions/workflows/ci.yaml/badge.svg)
10+
[![Release](https://github.com/canonical/hpl-rock/actions/workflows/release.yaml/badge.svg)](https://github.com/canonical/hpl-rock/actions/workflows/release.yaml/badge.svg)
911
[![Matrix](https://img.shields.io/matrix/ubuntu-hpc%3Amatrix.org?logo=matrix&label=ubuntu-hpc)](https://matrix.to/#/#ubuntu-hpc:matrix.org)
1012

1113
</div>
1214

1315
## Features
1416

15-
The High-Performance Linpack (HPL) ROCK provides a containerised `xhpl` binary that can be used to run the Linpack benchmark on your distributed-memory system. OpenBLAS, ATLAS,
17+
The High-Performance Linpack (HPL) OCI image provides a containerised `xhpl` binary that
18+
can be used to run the Linpack benchmark on your distributed-memory system. OpenBLAS, ATLAS,
1619
mpich, and libfabric are installed inside this image to support the `xhpl` binary.
1720

1821
## Usage
1922

2023
This short usage how-to section assumes that you have [Sarus](https://sarus.readthedocs.io/en/stable/quickstart/quickstart.html)
21-
installed on your distributed-memory system, however, this ROCK should work with any
24+
installed on your distributed-memory system, however, this image should work with any
2225
OCI-compliant container runtime.
2326

2427
### With a single node
@@ -138,9 +141,9 @@ mpirun -np 64 sarus run \
138141
139142
## Project & Community
140143

141-
The HPL ROCK is a project of the [Ubuntu HPC](https://discourse.ubuntu.com/t/high-performance-computing-team/35988)
144+
The HPL OCI image is a project of the [Ubuntu HPC](https://discourse.ubuntu.com/t/high-performance-computing-team/35988)
142145
community. It is an open source project that is welcome to community involvement, contributions, suggestions, fixes, and
143-
constructive feedback. Interested in being involved with the development of the HPL ROCK? Check out these links below:
146+
constructive feedback. Interested in being involved with the development of hpl-rock? Check out these links below:
144147

145148
* [Join our online chat](https://matrix.to/#/#ubuntu-hpc:matrix.org)
146149
* [Contributing guidelines](./CONTRIBUTING.md)
@@ -150,4 +153,5 @@ constructive feedback. Interested in being involved with the development of the
150153

151154
## License
152155

153-
The HPL ROCK is free software, distributed under the Apache Software License, version 2.0. See the [LICENSE](./LICENSE) file for more information.
156+
This HPL OCI image is free software, distributed under the Apache Software License,
157+
version 2.0. See the [LICENSE](./LICENSE) file for more information.

0 commit comments

Comments
 (0)