Skip to content

Create super-linter.yml #67

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
nvkulkarni12 wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Create super-linter.yml #67

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
57a3471
Create super-linter.yml
nvkulkarni12 Feb 22, 2023
d0104c3
Update README.md
nvkulkarni12 Feb 22, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 29 additions & 0 deletions .github/workflows/super-linter.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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 }}
43 changes: 1 addition & 42 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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)