From 1bf266fe665f1115f1213eb99f724207f21e242d Mon Sep 17 00:00:00 2001 From: vsoch Date: Sat, 4 May 2024 00:19:40 -0600 Subject: [PATCH] ci: add contributor and spell check Problem: we want to keep track of contributors (visually) along with check spelling as we add content. Solution: add CI for contributors and spell check Signed-off-by: vsoch --- .all-contributorsrc | 26 ++++++++ .github/workflows/main.yml | 17 ++++++ .github/workflows/update-contributors.yaml | 71 ++++++++++++++++++++++ README.md | 48 ++++++++++++++- pages/about.md | 16 +---- 5 files changed, 161 insertions(+), 17 deletions(-) create mode 100644 .all-contributorsrc create mode 100644 .github/workflows/main.yml create mode 100644 .github/workflows/update-contributors.yaml diff --git a/.all-contributorsrc b/.all-contributorsrc new file mode 100644 index 0000000..1a38bfc --- /dev/null +++ b/.all-contributorsrc @@ -0,0 +1,26 @@ +{ + "projectName": "converged-computing.github.io", + "projectOwner": "converged-computing", + "repoType": "github", + "repoHost": "https://github.com", + "files": [ + "README.md" + ], + "imageSize": 100, + "commit": true, + "commitConvention": "none", + "contributors": [ + { + "login": "vsoch", + "name": "Vanessasaurus", + "contributions": [ + "code" + ], + "profile": "https://vsoch.github.io", + "avatar_url": [ + "https://avatars.githubusercontent.com/u/814322?v=4" + ] + } + ], + "contributorsPerLine": 7 +} diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml new file mode 100644 index 0000000..29b8c75 --- /dev/null +++ b/.github/workflows/main.yml @@ -0,0 +1,17 @@ +name: converged-computing linting + +on: + push: + branches-ignore: + - main + - gh-pages + +jobs: + formatting: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - name: Check Spelling + uses: crate-ci/typos@7ad296c72fa8265059cc03d1eda562fbdfcd6df2 # v1.9.0 + with: + files: ./_docs/*.md ./docs/*.md ./README.md ./pages/*.md diff --git a/.github/workflows/update-contributors.yaml b/.github/workflows/update-contributors.yaml new file mode 100644 index 0000000..b31aae9 --- /dev/null +++ b/.github/workflows/update-contributors.yaml @@ -0,0 +1,71 @@ +name: converged-computing contributors + +on: + push: + branches: + - main + +jobs: + Update: + name: Generate + runs-on: ubuntu-latest + steps: + - name: Checkout Repository + uses: actions/checkout@v4 + - name: Tributors Update + uses: con/tributors@master + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + with: + parsers: unset + update_lookup: github + log_level: DEBUG + force: true + threshold: 1 + run_twice: true + + - name: Checkout New Branch + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + BRANCH_AGAINST: main + run: | + printf "GitHub Actor: ${GITHUB_ACTOR}\n" + export BRANCH_FROM="contributors/update-$(date '+%Y-%m-%d')" + git remote set-url origin "https://x-access-token:${GITHUB_TOKEN}@github.com/${GITHUB_REPOSITORY}.git" + + BRANCH_EXISTS=$(git ls-remote --heads origin ${BRANCH_FROM}) + if [[ -z ${BRANCH_EXISTS} ]]; then + printf "Branch does not exist in remote.\n" + else + printf "Branch already exists in remote.\n" + exit 1 + fi + git branch + git checkout -b "${BRANCH_FROM}" || git checkout "${BRANCH_FROM}" + git branch + + git config --global user.name "github-actions" + git config --global user.email "github-actions@users.noreply.github.com" + git status + + if git diff-index --quiet HEAD --; then + export OPEN_PULL_REQUEST=0 + printf "No changes\n" + else + export OPEN_PULL_REQUEST=1 + printf "Changes\n" + git commit -a -m "Automated deployment to update contributors $(date '+%Y-%m-%d')" + git push origin "${BRANCH_FROM}" + fi + + echo "OPEN_PULL_REQUEST=${OPEN_PULL_REQUEST}" >> $GITHUB_ENV + echo "PULL_REQUEST_FROM_BRANCH=${BRANCH_FROM}" >> $GITHUB_ENV + echo "PULL_REQUEST_TITLE=[tributors] ${BRANCH_FROM}" >> $GITHUB_ENV + echo "PULL_REQUEST_BODY=Tributors update automated pull request." >> $GITHUB_ENV + + - name: Open Pull Request + uses: vsoch/pull-request-action@master + if: ${{ env.OPEN_PULL_REQUEST == '1' }} + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + PULL_REQUEST_BRANCH: main diff --git a/README.md b/README.md index 39ed31d..20ed324 100644 --- a/README.md +++ b/README.md @@ -2,17 +2,23 @@ [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.7697548.svg)](https://doi.org/10.5281/zenodo.7697548) + +[![All Contributors](https://img.shields.io/badge/all_contributors-1-orange.svg?style=flat-square)](#contributors-) + + > A Best-of-Both-Worlds of HPC and Cloud This is the Converged Computing working space. It includes definitions, projects, and eventually will also include a [CiSE Special Issue](https://www.authorea.com/users/34995/articles/430859-cise-guest-editors-guide) on converged computing. ## Overview -> Special Issue Anticipated for mid 2024 +### Special Issue + +> Anticipated for mid 2024 Major trends have brought the cloud and high performance computing (HPC) communities closer together: the maturation of cloud technologies has shifted focus toward running workloads efficiently, and composite scientific workflows and resource heterogeneity and dynamism have revealed the limitations of traditional HPC resource and workflow management. It has become clear that the initially disparate communities have much to benefit in working together. This special issue aims to bridge the gap between HPC and cloud to discuss work in converged computing – the collaborative space between these traditionally separate communities – to develop novel technologies and applications. These hybrid technologies might span the gamut from automation, workflows, containerization, to software development and deployment and testing. This is a timely topic as collaborative work is happening to a greater degree that combines approaches from high performance computing with cloud-native computing. -## Guest Editors +### Guest Editors - Vanessa Sochat, Lawrence Livermore National Laboratory - Daniel Milroy, Lawrence Livermore National Laboratory @@ -21,6 +27,44 @@ Major trends have brought the cloud and high performance computing (HPC) communi - Evan Bollig, Amazon Web Services - Bill Magro, Google + +## Terms + +The original definitions were written by: + +- Vanessa Sochat, LLNL +- Daniel Milroy, LLNL +- Tapasya Patki, LLNL +- Claudia Misale (IBM Research) +- Jay Lofstead, Sandia National Laboratories +- Paula Olaya (University of Tennessee) +- Michela Taufer (University of Tennessee) +- Jakob Luettgau (previously University of Tennessee) + +And after this set, discussion moved into a Google Document that was open for community contribution, and discussion and work on the terms will continue on this site, with commit history much better representing contribution. I ([@vsoch](https://github.com/vsoch)) started the document and definitions realizing that the two communities were not communicating well, and hoping to work on that. If you'd like to further work on the terms or site content we welcome your contribution! + + +## 😁️ Contributors 😁️ + +We use the [all-contributors](https://github.com/all-contributors/all-contributors) +tool to generate a contributors graphic below. + + + + + + + + + + +
Vanessasaurus
Vanessasaurus
💻
+ + + + + + ## Thank you This site is based on [this template](https://bootstrapemail.com/) that is covered under the MIT license. The license is included [here](.github/LICENSE-BOOTSTRAP.md). diff --git a/pages/about.md b/pages/about.md index e33fd8a..057ec79 100644 --- a/pages/about.md +++ b/pages/about.md @@ -11,18 +11,4 @@ Major trends have brought the cloud and high performance computing (HPC) communi This documentation site aims to bridge the gap between HPC and cloud to discuss terms for converged computing – the collaborative space between these traditionally separate communities – to develop novel technologies and applications. These hybrid technologies might span the gamut from automation, workflows, containerization, to software development and deployment and testing. This is a timely topic as collaborative work is happening to a greater degree that combines approaches from high performance computing with cloud-native computing. Being able to communicate effectively is essential. -### Authors - -The original definitions were written by: - -- Vanessa Sochat, LLNL -- Daniel Milroy, LLNL -- Tapasya Patki, LLNL -- Claudia Misale (IBM Research) -- Jay Lofstead, Sandia National Laboratories -- Paula Olaya (University of Tennessee) -- Michela Taufer (University of Tennessee) -- Jakob Luettgau (previously University of Tennessee) - -And after this set, discussion moved into a Google Document that was open for community contribution, and discussion and work on the terms will continue on this site, with commit history much better representing contribution. I ([@vsoch](https://github.com/vsoch)) started the document and definitions realizing that the two communities were not communicating well, and hoping to work on that. If you'd like to further work on the terms or site content we welcome your contribution! - +You can read the [project README](https://github.com/converged-computing/converged-computing.github.io?tab=readme-ov-file#terms) to see the original authors of the terms that are not represented in the GitHub commits here.