Skip to content
This repository has been archived by the owner on Oct 2, 2022. It is now read-only.

Commit

Permalink
Initial commit
Browse files Browse the repository at this point in the history
  • Loading branch information
Janos Pasztor committed Nov 17, 2020
0 parents commit c59388e
Show file tree
Hide file tree
Showing 15 changed files with 308 additions and 0 deletions.
34 changes: 34 additions & 0 deletions .github-template/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
---
name: Bug report
about: Create a report to help us improve
title: ''
labels: bug
assignees: janoszen

---

<details>
<summary><h2>Describe the bug</h2></summary>
A clear and concise description of what the bug is.
</details>

<details>
<summary><h2>To Reproduce</h2></summary>
1. Run containerssh with these parameters
2. Do something else...
3. ...
</details>

<details>
<summary><h2>Expected behavior</h2></summary>
A clear and concise description of what you expected to happen.
</details>

<details>
<summary><h2>Version</h2></summary>
Please insert the output of `go version` here:
```
$ go version
...
```
</details>
17 changes: 17 additions & 0 deletions .github-template/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
name: Feature request
about: Suggest an idea for this project
title: ''
labels: feature
assignees: janoszen

---

## Please describe what you would like to see in ContainerSSH
A clear and concise description of what you would like to see improved.

## Please describe the solution you'd like
A clear and concise description of what you want to happen.

## Please describe your use case
A clear and concise description of how you would use this feature.
20 changes: 20 additions & 0 deletions .github-template/ISSUE_TEMPLATE/support.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
name: Support request
about: If you need help using ContainerSSH
title: ''
labels: support
assignees: janoszen

---

## Please describe what you need help with

...

## Have you read the readme in its entirety?

...

## What have you tried to resolve this problem?

...
20 changes: 20 additions & 0 deletions .github-template/PULL_REQUEST_TEMPLATE/bug_fix.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
name: Bug fix
about: Fix a bug
title: ''
labels: bug
assignees: janoszen

---

## Please describe the bug you have fixed

...

## Are you the owner of the code you are sending in, or do you have permission of the owner?

...

## The code will be published under the MIT license. Have you read and understood this license?

...
20 changes: 20 additions & 0 deletions .github-template/PULL_REQUEST_TEMPLATE/cleanup.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
name: Cleanup
about: Make the code more beautiful or add a build tool
title: ''
labels: cleanup
assignees: janoszen

---

## Please describe what your cleanup is all about

...

## Are you the owner of the code you are sending in, or do you have permission of the owner?

...

## The code will be published under the MIT license. Have you read and understood this license?

...
20 changes: 20 additions & 0 deletions .github-template/PULL_REQUEST_TEMPLATE/feature.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
name: Feature
about: Add a new feature
title: ''
labels: enhancement
assignees: janoszen

---

## Please describe the feature you are adding

...

## Are you the owner of the code you are sending in, or do you have permission of the owner?

...

## The code will be published under the MIT license. Have you read and understood this license?

...
6 changes: 6 additions & 0 deletions .github-template/dependabot.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
version: 2
updates:
- package-ecosystem: "gomod"
directory: "/"
schedule:
interval: "daily"
71 changes: 71 additions & 0 deletions .github-template/workflows/codeql-analysis.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
# For most projects, this workflow file will not need changing; you simply need
# to commit it to your repository.
#
# You may wish to alter this file to override the set of languages analyzed,
# or to provide custom queries or build logic.
name: "CodeQL"

on:
push:
branches: [ main ]
pull_request:
# The branches below must be a subset of the branches above
branches: [ main ]
schedule:
- cron: '0 17 * * 2'

jobs:
analyze:
name: Analyze
runs-on: ubuntu-latest

strategy:
fail-fast: false
matrix:
# Override automatic language detection by changing the below list
# Supported options are ['csharp', 'cpp', 'go', 'java', 'javascript', 'python']
language: [ 'go' ]
# Learn more...
# https://docs.github.com/en/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning#overriding-automatic-language-detection

steps:
- name: Checkout repository
uses: actions/checkout@v2
with:
# We must fetch at least the immediate parents so that if this is
# a pull request then we can checkout the head.
fetch-depth: 2

# If this run was triggered by a pull request event, then checkout
# the head of the pull request instead of the merge commit.
- run: git checkout HEAD^2
if: ${{ github.event_name == 'pull_request' }}

# Initializes the CodeQL tools for scanning.
- name: Initialize CodeQL
uses: github/codeql-action/init@v1
with:
languages: ${{ matrix.language }}
# If you wish to specify custom queries, you can do so here or in a config file.
# By default, queries listed here will override any specified in a config file.
# Prefix the list here with "+" to use these queries and those in the config file.
# queries: ./path/to/local/query, your-org/your-repo/queries@main

# Autobuild attempts to build any compiled languages (C/C++, C#, or Java).
# If this step fails, then you should remove it and run the build manually (see below)
- name: Autobuild
uses: github/codeql-action/autobuild@v1

# ℹ️ Command-line programs to run using the OS shell.
# 📚 https://git.io/JvXDl

# ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
# and modify them (or add more) to build your code if your project
# uses a compiled language

#- run: |
# make bootstrap
# make release

- name: Perform CodeQL Analysis
uses: github/codeql-action/analyze@v1
21 changes: 21 additions & 0 deletions .github-template/workflows/lint.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
name: Lint
on:
push:
pull_request:
jobs:
test:
name: Run lint
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v2
- name: Set up Go
uses: actions/setup-go@v2
with:
go-version: 1.14
- name: Run golangci-lint
uses: golangci/golangci-lint-action@v2
with:
version: v1.32.2
args: --out-format=colored-line-number -E asciicheck -E bodyclose -E dupl -E errorlint -E exportloopref -E funlen

17 changes: 17 additions & 0 deletions .github-template/workflows/tests.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
name: Tests
on:
push:
pull_request:
jobs:
test:
name: Run tests
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v2
- name: Set up Go
uses: actions/setup-go@v2
with:
go-version: 1.14
- name: Run go tests
run: go test -cover -p 1 -v ./...
25 changes: 25 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
build/
cover.out
config.yaml
ssh_host_rsa_key
vendor
NOTICE.md

*.iml
.idea
target
build
dest
site
test.yml
.flattened-pom.xml
*.tfvars
terraform.tfstate
terraform.tfstate.backup
.terraform
__pycache__
*.pyc
containerssh-authconfig-openapi.json
docs/api/authconfig/containerssh-authconfig.json
venv
var
5 changes: 5 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Code of Conduct

1. Be nice to each other.
2. Assume good intentions.
3. Attack the idea not the person.
7 changes: 7 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Contributing to ContainerSSH

Welcome! And a big thank you for wanting to contribute!

Let's get you started. First of all, this project is licensed under the [MIT license](LICENSE.md). This means that the code you submit will be usable for anyone for any purpose free of charge. Please submit code that you personally own or have permission to submit under this license, and only if you are ok with that.

That's out of the way, let's focus on making your contribution happen. For the coding aspects we recommend reading the [development guide](https://containerssh.github.io/developing/). It runs you through the nitty-gritty details of setting up the development environment.
10 changes: 10 additions & 0 deletions LICENSE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
The MIT License (MIT)

Copyright (c) 2020 ContainerSSH contributors

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
15 changes: 15 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
[![ContainerSSH - Launch Containers on Demand](https://containerssh.github.io/images/logo-for-embedding.svg)](https://containerssh.github.io/)

<!--suppress HtmlDeprecatedAttribute -->
<h1 align="center">ContainerSSH SSH ****** Library</h1>

[![Go Report Card](https://goreportcard.com/badge/github.com/containerssh/library-template?style=for-the-badge)](https://goreportcard.com/report/github.com/containerssh/library-template)
[![LGTM Alerts](https://img.shields.io/lgtm/alerts/github/ContainerSSH/library-template?style=for-the-badge)](https://lgtm.com/projects/g/ContainerSSH/library-template/)

Add a description here.

<p align="center"><strong>Note: This is a developer documentation.</strong><br />The user documentation for ContainerSSH is located at <a href="https://containerssh.github.io">containerssh.github.io</a>.</p>

## Todo

Once you have this repository forked you should [enable the LGTM integration](https://lgtm.com/dashboard).

0 comments on commit c59388e

Please sign in to comment.