Merge pull request #1 from essentialkaos/develop

Version 1.0.0

.codebeatsettings

@@ -0,0 +1,11 @@
+{
+ "GOLANG": {
+ "ABC": [15, 25, 50, 70],
+ "LOC": [30, 45, 70, 100],
+ "BLOCK_NESTING": [4, 6, 8, 10],
+ "TOO_MANY_IVARS": [50, 75, 100, 150],
+ "TOO_MANY_FUNCTIONS": [64, 128, 256, 512],
+ "TOTAL_LOC": [1500, 3000, 5000, 10000],
+ "TOTAL_COMPLEXITY": [350, 600, 900, 1200]
+ }
+}

.github/CODE_OF_CONDUCT.md

@@ -0,0 +1,42 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+ addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at `conduct@essentialkaos.com`. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.

.github/CONTRIBUTING.md

@@ -0,0 +1,19 @@
+# Contributing Guidelines
+
+**IMPORTANT! Contribute your code only if you have an excellent understanding of project idea and all existing code base. Otherwise, a nicely formatted issue will be more helpful to us.**
+
+### Issues
+
+1. Provide product version where the problem was found;
+2. Provide info about your environment;
+3. Provide detailed info about your problem;
+4. Provide steps to reproduce the problem;
+5. Provide actual and expected results.
+
+### Code
+
+1. Check your code **before** creating pull request;
+2. If tests are present in a project, add tests for your code;
+3. Add inline documentation for your code;
+4. Apply code style used throughout the project;
+5. Create your pull request to `develop` branch (_pull requests to other branches are not allowed_).

.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,53 @@
+_Before opening an issue, search for similar bug reports or feature requests on GitHub Issues. If yes, please add a_ 👍 _reaction to the existing issue. If no similar issue can be found, fill out either the "Bug Report" or the "Feature Request" section below. Erase the other section and everything on and above this line._
+
+### Bug report
+
+**System info:**
+
+* **Version used (`updown-badge-server --version`):** 
+* **OS (e.g. from `/etc/*-release`):** 
+* **Kernel (`uname -a`):** 
+* **Install tools:** 
+
+**Steps to reproduce:**
+
+1. [First Step]
+2. [Second Step]
+3. [and so on...]
+
+**Expected behavior:**
+
+[What you expected to happen]
+
+**Actual behavior:**
+
+[What actually happened]
+
+**Additional info:**
+
+[Include gist of relevant config, logs, etc.]
+
+Please run those if possible and link them from a [gist](http://gist.github.com).
+
+---
+
+### Feature Request
+
+Opening a feature request kicks off a discussion. Requests may be closed if we're not actively planning to work on them.
+
+**Proposal:**
+
+[Description of the feature]
+
+**Current behavior:**
+
+[What currently happens]
+
+**Desired behavior:**
+
+[What you would like to happen]
+
+**Use case:**
+
+[Why is this important (helps with prioritizing requests)]
+

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,24 @@
+### What did you implement:
+
+Closes #XXXXX
+
+### How did you implement it:
+
+...
+
+### How can we verify it:
+
+...
+
+### TODO's:
+
+- [ ] Write tests
+- [ ] Write documentation
+- [ ] Check that there aren't other open pull requests for the same issue/feature
+- [ ] Format your source code by `make fmt`
+- [ ] Provide verification config / commands
+- [ ] Enable "Allow edits from maintainers" for this PR
+- [ ] Update the messages below
+
+**Is this ready for review?:** No
+**Is it a breaking change?:** No

.github/workflows/ci.yml

@@ -0,0 +1,92 @@
+name: CI
+
+on:
+ push:
+ branches: [master, develop]
+ pull_request:
+ branches: [master]
+
+jobs:
+ Go:
+ name: Go
+ runs-on: ubuntu-latest
+
+ env:
+ SRC_DIR: src/github.com/${{ github.repository }}
+ GO111MODULE: auto
+
+ strategy:
+ matrix:
+ go: [ '1.16.x', '1.17.x' ]
+
+ steps:
+ - name: Set up Go
+ uses: actions/setup-go@v2
+ with:
+ go-version: ${{ matrix.go }}
+ id: go
+
+ - name: Setup PATH
+ run: |
+ echo "GOPATH=${{ github.workspace }}" >> "$GITHUB_ENV"
+ echo "GOBIN=${{ github.workspace }}/bin" >> "$GITHUB_ENV"
+ echo "${{ github.workspace }}/bin" >> "$GITHUB_PATH"
+
+ - name: Checkout
+ uses: actions/checkout@v2
+ with:
+ path: ${{env.SRC_DIR}}
+
+ - name: Download dependencies
+ working-directory: ${{env.SRC_DIR}}
+ run: make deps
+
+ - name: Run tests
+ working-directory: ${{env.SRC_DIR}}
+ run: make all
+
+ Aligo:
+ name: Aligo
+ runs-on: ubuntu-latest
+
+ needs: Go
+
+ env:
+ SRC_DIR: src/github.com/${{ github.repository }}
+ GO111MODULE: auto
+
+ steps:
+ - name: Set up Go
+ uses: actions/setup-go@v2
+ with:
+ go-version: '1.16.x'
+ id: go
+
+ - name: Setup PATH
+ run: |
+ echo "GOPATH=${{ github.workspace }}" >> "$GITHUB_ENV"
+ echo "GOBIN=${{ github.workspace }}/bin" >> "$GITHUB_ENV"
+ echo "${{ github.workspace }}/bin" >> "$GITHUB_PATH"
+
+ - name: Checkout
+ uses: actions/checkout@v2
+ with:
+ path: ${{env.SRC_DIR}}
+
+ - name: Download dependencies
+ working-directory: ${{env.SRC_DIR}}
+ run: make deps
+
+ - name: Install Aligo
+ working-directory: ${{env.SRC_DIR}}
+ run: |
+ wget https://apps.kaos.st/aligo/latest/linux/x86_64/aligo
+ chmod +x aligo
+
+ - name: Print Aligo version info
+ working-directory: ${{env.SRC_DIR}}
+ run: ./aligo --version
+
+ - name: Check Go structs alignment info
+ working-directory: ${{env.SRC_DIR}}
+ run: ./aligo check ./...

.github/workflows/codeql.yml

@@ -0,0 +1,28 @@
+name: "CodeQL"
+
+on:
+ push:
+ branches: [master, develop]
+ pull_request:
+ branches: [master]
+ schedule:
+ - cron: '0 17 * * 1,3,5'
+
+jobs:
+ analyse:
+ name: Analyse
+ runs-on: ubuntu-latest
+
+ steps:
+ - name: Checkout repository
+ uses: actions/checkout@v2
+ with:
+ fetch-depth: 2
+
+ - name: Initialize CodeQL
+ uses: github/codeql-action/init@v1
+ with:
+ languages: go
+
+ - name: Perform CodeQL Analysis
+ uses: github/codeql-action/analyze@v1