Skip to content

Commit

Permalink
Merge pull request #9 from rse-ops/update/branding-rseops
Browse files Browse the repository at this point in the history
Updating branding to use rse-ops
  • Loading branch information
vsoch committed Oct 15, 2021
2 parents aeabbf1 + 02e59eb commit c3e2bfe
Show file tree
Hide file tree
Showing 12 changed files with 39 additions and 39 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/test-cmake.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -42,4 +42,4 @@ jobs:
name: "${{ matrix.result.description }}"
steps:
- name: Build and Test
uses: rse-radiuss/ci/cmake@main
uses: rse-ops/ci/cmake@main
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# RADIUSS CI
# RSE-ops CI

![img/radiuss-ci.png](img/radiuss-ci.png)
![img/rse-ops-ci.png](img/rse-ops-ci.png)

This is a set of example GitHub Actions that will get you started to build
testing containers for a build strategy of choice.
Expand All @@ -9,7 +9,7 @@ are optimal for that kind of test.

- [cmake](cmake): An example of a build matrix for a cmake project.

It is recommended to view the documentation in the [web interface](https://rse-radiuss.github.io/ci/).
It is recommended to view the documentation in the [web interface](https://rse-ops.github.io/ci/).
However, if you read it here in GitHub, you can safely remove occurrences of `{% raw %}` and `{% endraw %}`
that are only there to aid the site rendering.

Expand Down Expand Up @@ -45,7 +45,7 @@ For any GitHub variables in the format `${{ varname }}` You should surround with
( e.g., `{% raw %}${{ varname }}{% endraw %}` so it correctly renders with Jekyll.

To develop, meaning installing and running Jekyll locally, you can follow
the instructions [here](https://github.com/rse-radiuss/rse-radiuss.github.io#development).
the instructions [here](https://github.com/rse-ops/rse-ops.github.io#development).

License
-------
Expand Down
18 changes: 9 additions & 9 deletions _config.yml
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
title: RADIUSS CI
description: Continuous Integration Recipes for RADIUSS
title: RSE-ops CI
description: Continuous Integration Recipes for RSE-ops
# baseurl: The subpath of your site
# DO NOT EDIT this line number unless you change .circleci/circle_urls.sh
baseurl: "/ci"

nav_logo_file: assets/img/radius-text.png
footer_logo_file: assets/img/radius-circle.png
nav_logo_file: assets/img/rse-ops-text.png
footer_logo_file: assets/img/rse-ops-circle.png

# Info /message at the top
info_bar: true # Bar at the top of all pages. Delete this line or set to false for no info bar display.
info_bar_text: This site is currently under development for <a href="https://radiuss.llnl.gov" target="_blank" class="text-white text-underline">RADIUSS</a>
info_bar_text: This site is currently under development for <a href="https://rse-ops.github.io" target="_blank" class="text-white text-underline">RSE-ops</a>

footer_text: RADIUSS is an initiative started at <a href="https://radiuss.llnl.gov" class="text-white text-underline">Lawrence Livermore National Laboratory</a> in Livermore, CA USA.<br>&copy; Copyright 2021, under the terms of the <a href="https://github.com/rse-radiuss/rse-radiuss.github.io/blob/main/LICENSE" class="text-white text-underline">MIT License</a>.
footer_text: RSE-ops is a community that was founded by RADIUSS at <a href="https://radiuss.llnl.gov" class="text-white text-underline">Lawrence Livermore National Laboratory</a> in Livermore, CA USA.<br>&copy; Copyright 2021, under the terms of the <a href="https://github.com/rse-ops/rse-ops.github.io/blob/main/LICENSE" class="text-white text-underline">MIT License</a>.

permalink: pretty

Expand All @@ -27,15 +27,15 @@ github_link: true
github_pages_branch: main

# Social
github_username: rse-radiuss
github_username: rse-ops
linkedin_username: company/lawrence-livermore-national-laboratory
twitter_username: llnl_opensource
twitter_username: rseops

# Theme for docs
plugins:
- jekyll-remote-theme

remote_theme: rse-radiuss/radiuss-docs-jekyll
remote_theme: rse-ops/rseops-docs-jekyll

exclude:
- _assets
Expand Down
4 changes: 2 additions & 2 deletions cmake/CMakeLists.txt
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
cmake_minimum_required(VERSION 3.14)

project(rse-radiuss-cmake-ci)
project(rse-ops-cmake-ci)

option(ENABLE_TESTS "Enable tests" Off)

Expand All @@ -10,4 +10,4 @@ add_executable(test.exe test.cpp)

if (ENABLE_TESTS)
add_test(NAME test.exe COMMAND test.exe)
endif ()
endif ()
30 changes: 15 additions & 15 deletions cmake/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,9 @@ a CMake project. These steps generally include:
However the way that you create your build matrix will vary depending on your needs!
Keep reading for a detailed tutorial, or jump into the code examples provided:

- [GitHub Actions Basic (without helper actions)](https://github.com/rse-radiuss/ci/blob/main/cmake/examples/cmake-build-test-basic.yaml)
- [Automated Matrix Generation and Test/Build](https://github.com/rse-radiuss/ci/blob/main/cmake/examples/cmake-build-test-uptodate-full.yaml) using and [uptodate.yaml](https://github.com/rse-radiuss/ci/blob/main/cmake/uptodate.yaml) and matching [Dockerfile](https://github.com/rse-radiuss/ci/blob/main/cmake/Dockerfile)
- [Automated Matrix Generation and Manual Test/Build](https://github.com/rse-radiuss/ci/blob/main/cmake/examples/cmake-build-test-uptodate.yaml) with same [uptodate.yaml](https://github.com/rse-radiuss/ci/blob/main/cmake/uptodate.yaml) and [Dockerfile](https://github.com/rse-radiuss/ci/blob/main/cmake/Dockerfile)
- [GitHub Actions Basic (without helper actions)](https://github.com/rse-ops/ci/blob/main/cmake/examples/cmake-build-test-basic.yaml)
- [Automated Matrix Generation and Test/Build](https://github.com/rse-ops/ci/blob/main/cmake/examples/cmake-build-test-uptodate-full.yaml) using and [uptodate.yaml](https://github.com/rse-ops/ci/blob/main/cmake/uptodate.yaml) and matching [Dockerfile](https://github.com/rse-ops/ci/blob/main/cmake/Dockerfile)
- [Automated Matrix Generation and Manual Test/Build](https://github.com/rse-ops/ci/blob/main/cmake/examples/cmake-build-test-uptodate.yaml) with same [uptodate.yaml](https://github.com/rse-ops/ci/blob/main/cmake/uptodate.yaml) and [Dockerfile](https://github.com/rse-ops/ci/blob/main/cmake/Dockerfile)

We are hoping to have a tool to make these yaml recipes easier to generate, stay tuned!

Expand All @@ -33,7 +33,7 @@ We are hoping to have a tool to make these yaml recipes easier to generate, stay
You'll first want to create a Dockerfile. Typically this means something like the following:

```
ARG containerbase=ghcr.io/rse-radiuss/gcc-ubuntu-20.04:gcc-11.2.0
ARG containerbase=ghcr.io/rse-ops/gcc-ubuntu-20.04:gcc-11.2.0
FROM ${containerbase}
# Any extra flags you can provide as a build argument
Expand All @@ -57,12 +57,12 @@ RUN cd build && ctest -T test --output-on-failure

For the above, we have represented versions and anything we might want to treat as a variable as build arguments.
As an example, the first build argument, `containerbase` is how we will choose a base image. Since it's an argument,
we will be able to populate it using different base images. For the default value (`ghcr.io/rse-radiuss/gcc-ubuntu-20.04:gcc-11.2.0`) you should choose the one that you want the Dockerfile to build if no build argument
we will be able to populate it using different base images. For the default value (`ghcr.io/rse-ops/gcc-ubuntu-20.04:gcc-11.2.0`) you should choose the one that you want the Dockerfile to build if no build argument
is provided. This is true for any build argument (e.g., also flags).

### Choose Base Images

Speaking of base images, you can choose one or more base images from the [rse-radiuss](https://rse-radiuss.github.io/docker-images/) library.
Speaking of base images, you can choose one or more base images from the [rse-ops](https://rse-ops.github.io/docker-images/) library.
Each comes with spack pre-installed, along with a compiler/version of your choice.

## 3. Create GitHub Action
Expand Down Expand Up @@ -116,7 +116,7 @@ jobs:
cd cmake/
# It's useful to print the command first
command="docker build --build-arg containerbase=ghcr.io/rse-radiuss/{% raw %}${{ matrix.containerbase }}{% endraw %} --build-arg flags={% raw %}${{ matrix.flags }}{% endraw %} -t cmake-testing-container ."
command="docker build --build-arg containerbase=ghcr.io/rse-ops/{% raw %}${{ matrix.containerbase }}{% endraw %} --build-arg flags={% raw %}${{ matrix.flags }}{% endraw %} -t cmake-testing-container ."
printf "${command}\n"
${command}
```
Expand Down Expand Up @@ -147,8 +147,8 @@ This GitHub actions workflow is slightly longer because we will first need to ge
dockerbuild:
matrix:
containerbase:
- ghcr.io/rse-radiuss/gcc-ubuntu-20.04
- ghcr.io/rse-radiuss/clang-ubuntu-20.04
- ghcr.io/rse-ops/gcc-ubuntu-20.04
- ghcr.io/rse-ops/clang-ubuntu-20.04
containertag:
- gcc-8.1.0
- llvm-10.0.0
Expand Down Expand Up @@ -186,8 +186,8 @@ RUN cd build && ctest -T test --output-on-failure
Will generate the following two docker builds:

```bash
docker build -f Dockerfile --build-arg cxx_compiler=g++ --build-arg enable_tests=On --build-arg containerbase=ghcr.io/rse-radiuss/gcc-ubuntu-20.04 --build-arg containertag=gcc-8.1.0 cmake
docker build -f Dockerfile --build-arg cxx_compiler=clang++ --build-arg enable_tests=On --build-arg containerbase=ghcr.io/rse-radiuss/clang-ubuntu-20.04 --build-arg containertag=llvm-10.0.0 cmake
docker build -f Dockerfile --build-arg cxx_compiler=g++ --build-arg enable_tests=On --build-arg containerbase=ghcr.io/rse-ops/gcc-ubuntu-20.04 --build-arg containertag=gcc-8.1.0 cmake
docker build -f Dockerfile --build-arg cxx_compiler=clang++ --build-arg enable_tests=On --build-arg containerbase=ghcr.io/rse-ops/clang-ubuntu-20.04 --build-arg containertag=llvm-10.0.0 cmake
```

You can be creative about how you break apart your build args and map them to the Dockerfile - the example above might be a bit excessive for your use case. Logical steps to generating this are:
Expand Down Expand Up @@ -251,10 +251,10 @@ jobs:
steps:

- name: Build and Test
uses: rse-radiuss/ci/cmake@main
uses: rse-ops/ci/cmake@main
```

If you need to customize the specific build, you can expand the action to not use the `rse-radiuss/cmake` build steps, and
If you need to customize the specific build, you can expand the action to not use the `rse-ops/cmake` build steps, and
instead write your own!


Expand Down Expand Up @@ -343,5 +343,5 @@ to (usually) make enough additional room:

## 6. Example

For an example, see the [uptodate.yaml](https://github.com/rse-radiuss/ci/blob/main/cmake/uptodate.yaml) and matching [Dockerfile](https://github.com/rse-radiuss/ci/blob/main/cmake/Dockerfile)
in this directory, and the matching [test-cmake.yaml](https://github.com/rse-radiuss/ci/blob/main/.github/workflows/test-cmake.yaml).
For an example, see the [uptodate.yaml](https://github.com/rse-ops/ci/blob/main/cmake/uptodate.yaml) and matching [Dockerfile](https://github.com/rse-ops/ci/blob/main/cmake/Dockerfile)
in this directory, and the matching [test-cmake.yaml](https://github.com/rse-ops/ci/blob/main/.github/workflows/test-cmake.yaml).
2 changes: 1 addition & 1 deletion cmake/examples/cmake-build-test-basic.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,6 @@ jobs:
cd cmake/
# It's useful to print the command first
command="docker build --build-arg containerbase=ghcr.io/rse-radiuss/{% raw %}${{ matrix.containerbase }}{% endraw %} --build-arg flags={% raw %}${{ matrix.flags }}{% endraw %} -t cmake-testing-container ."
command="docker build --build-arg containerbase=ghcr.io/rse-ops/{% raw %}${{ matrix.containerbase }}{% endraw %} --build-arg flags={% raw %}${{ matrix.flags }}{% endraw %} -t cmake-testing-container ."
printf "${command}\n"
${command}
2 changes: 1 addition & 1 deletion cmake/examples/cmake-build-test-uptodate.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -37,5 +37,5 @@ jobs:
name: "${{ matrix.result.description }}"
steps:
- name: Build and Test
uses: rse-radiuss/ci/cmake@main
uses: rse-ops/ci/cmake@main

4 changes: 2 additions & 2 deletions cmake/test.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

int main(int argc, char* argv[])
{
std::cout << "Hello, from rse-radiuss CMake CI ✅" << std::endl;
std::cout << "Hello, from rse-ops CMake CI ✅" << std::endl;

return 0;
}
}
4 changes: 2 additions & 2 deletions cmake/uptodate.yaml
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
dockerbuild:
matrix:
containerbase:
- ghcr.io/rse-radiuss/gcc-ubuntu-20.04
- ghcr.io/rse-radiuss/clang-ubuntu-20.04
- ghcr.io/rse-ops/gcc-ubuntu-20.04
- ghcr.io/rse-ops/clang-ubuntu-20.04
containertag:
- gcc-8.1.0
- llvm-10.0.0
Expand Down
Binary file removed img/radiuss-ci.png
Binary file not shown.
Binary file added img/rse-ops-ci.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ sidebar: ci

{:.no_toc}

Welcome to the RADIUSS Continuous Integration (CI) set of instructions. RADIUSS provides this documentation that is rendered from <a href="https://github.com/rse-radiuss/ci" target="_blank">the matching GitHub repository</a> to help you to create CI pipelines for your projects.
Welcome to the RADIUSS Continuous Integration (CI) set of instructions. RADIUSS provides this documentation that is rendered from <a href="https://github.com/rse-ops/ci" target="_blank">the matching GitHub repository</a> to help you to create CI pipelines for your projects.
Explore the different build frameworks on the left to learn how to generate your
CI pipeline. If you have a framework that is not listed here, please <a href="https://github.com/rse-radiuss/ci/issues" target="_blank">let us know!</a>
CI pipeline. If you have a framework that is not listed here, please <a href="https://github.com/rse-ops/ci/issues" target="_blank">let us know!</a>

0 comments on commit c3e2bfe

Please sign in to comment.