From 57a34718f2934789a1bc0256774f643b096c1249 Mon Sep 17 00:00:00 2001 From: nvkulkarni12 <113143510+nvkulkarni12@users.noreply.github.com> Date: Tue, 21 Feb 2023 22:03:00 -0800 Subject: [PATCH 1/2] Create super-linter.yml --- .github/workflows/super-linter.yml | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) create mode 100644 .github/workflows/super-linter.yml diff --git a/.github/workflows/super-linter.yml b/.github/workflows/super-linter.yml new file mode 100644 index 0000000..ca69cec --- /dev/null +++ b/.github/workflows/super-linter.yml @@ -0,0 +1,29 @@ +# This workflow executes several linters on changed files based on languages used in your code base whenever +# you push a code or open a pull request. +# +# You can adjust the behavior by modifying this file. +# For more information, see: +# https://github.com/github/super-linter +name: Lint Code Base + +on: + push: + branches: [ "main" ] + pull_request: + branches: [ "main" ] +jobs: + run-lint: + runs-on: ubuntu-latest + steps: + - name: Checkout code + uses: actions/checkout@v3 + with: + # Full git history is needed to get a proper list of changed files within `super-linter` + fetch-depth: 0 + + - name: Lint Code Base + uses: github/super-linter@v4 + env: + VALIDATE_ALL_CODEBASE: false + DEFAULT_BRANCH: "main" + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} From d0104c3bd8e97b420572db06f11924d7fa4a10f2 Mon Sep 17 00:00:00 2001 From: nvkulkarni12 <113143510+nvkulkarni12@users.noreply.github.com> Date: Tue, 21 Feb 2023 23:09:57 -0800 Subject: [PATCH 2/2] Update README.md --- README.md | 43 +------------------------------------------ 1 file changed, 1 insertion(+), 42 deletions(-) diff --git a/README.md b/README.md index d46f7c6..3ff3974 100644 --- a/README.md +++ b/README.md @@ -1,43 +1,2 @@ # Roller - -This repository provides a program that rolls a game die, such as the -six-sided dice used in traditional dice game. - -# Usage - -## Getting Started - -Build the image from `Dockerfile` with the command: - -`docker build -t cpp-container .` - -Once built, run the image: - -`docker run -it cpp-container` - -...or run it interactively in a shell: - -`docker run -it cpp-container sh` - -...or run it with a bind mount to the current source code: - -`docker run --mount type=bind,source="$(pwd)",target=/usr/src -it cpp-container` - -## Manually running the program - -Within docker's interactive shell (see above) first build the program: - -`make` - -Then run it, with an argument that provides the number of faces, such as: - -`./Roller 6` - -...for a six-sided die. - -## Manually checking C++ style - -To check for your program's adoption of the style guide, within the docker -container (see above), run **cpplint**: - -`cpplint *.cpp *.h` +[![Lint Code Base](https://github.com/nvkulkarni12/Roller/actions/workflows/super-linter.yml/badge.svg)](https://github.com/nvkulkarni12/Roller/actions/workflows/super-linter.yml)