Skip to content

Commit

Permalink
Merge branch 'release-1.12'
Browse files Browse the repository at this point in the history
  • Loading branch information
alexanderkress committed Jul 11, 2020
2 parents 1462dfa + 98f751c commit 340675a
Show file tree
Hide file tree
Showing 60 changed files with 1,845 additions and 639 deletions.
8 changes: 8 additions & 0 deletions .flake8
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
[flake8]
ignore = E265, E266, E402, E501, E722, C901, N806
max-line-length = 127
max-complexity = 10
count = True
statistics = True
show-source = True
exclude = .git,build,dist,tests
8 changes: 8 additions & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# Set the default behavior, in case people don't have core.autocrlf set.
* text=auto

# Declare files that will always have LF line endings on checkout.
debian-startscript text eol=lf
systemd-spunkybot.service text eol=lf
debian/* text eol=lf
setup.* text eol=lf
6 changes: 6 additions & 0 deletions .github/CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# Spunky Bot CODE OWNERS

# See https://help.github.com/articles/about-codeowners/ for more info about the CODEOWNERS file
# Each line is a file pattern followed by one or more owners.

* @alexanderkress
File renamed without changes.
15 changes: 5 additions & 10 deletions CONTRIBUTING.md → .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,7 @@

If you want to get involved, whether in terms of asking a question, helping other users, introducing new people to Spunky Bot, or helping with the software or documentation, we appreciate your contributions to the project.


# Contributing Code (Features or Bugfixes)
## Contributing Code (Features or Bugfixes)

The Spunky Bot project keeps its source on GitHub at [github.com/SpunkyBot/spunkybot](https://github.com/SpunkyBot/spunkybot).

Expand All @@ -15,7 +14,6 @@ We will then review your contributions and discuss issues with you.

Be patient, your request might not get merged right away, we also try to keep the development branch more or less usable, so we like to examine pull requests carefully, which takes time.


Patches should always be made against the 'develop' branch.

Keep in mind that small and focused requests are easier to check and accept, having example cases also help us understand the utility of a bug fix or a new feature.
Expand All @@ -24,19 +22,16 @@ Contributions can be for new features like modules, or to fix bugs you or others

We like simple, readable code and consistent, conservatively extending, backwards-compatible improvements. The code developed for Spunky Bot must support Python 2.6+. Please also use a 4-space indent and no tabs. We do not enforce 80 characters lines, we are fine with 120-160.


# Mailing List Information
## Mailing List Information

The Spunky Bot [Mailing List](https://groups.google.com/group/spunkybot) is for sharing tips, answering questions, and general user discussions.


# Community Code of Conduct
## Community Code of Conduct

The Spunky Bot community welcomes users of all types, backgrounds, and skill levels. Please treat others in the way you expect to be treated, keep discussions positive and avoid discrimination of any kinds, profanity, or engaging in controversial debates.

Posts to mailing lists should remain focused on Spunky Bot and game server administration. Abuse of these community guidelines is not tolerated and may result in banning from community resources.

## Contributors License Agreement

# Contributors License Agreement

By contributing you agree that these contributions are your own, and you grant a full, complete, irrevocable copyright license to all users and developers of the project, present and future, pursuant to the [license](https://github.com/SpunkyBot/spunkybot/blob/master/LICENSE) of the project.
By contributing you agree that these contributions are your own, and you grant a full, complete, irrevocable copyright license to all users and developers of the project, present and future, pursuant to the [license](https://github.com/SpunkyBot/spunkybot/blob/develop/LICENSE) of the project.
1 change: 1 addition & 0 deletions .github/FUNDING.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
github: alexanderkress
30 changes: 30 additions & 0 deletions .github/ISSUE_TEMPLATE/bug-report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
---
name: "\U0001F41B Bug report"
about: Create a report to help us improve
title: ''
labels: bug
assignees: ''

---

**Summary**
Please describe the bug or the wrong behavior.

**Steps to reproduce**
1.
2.

**Expected behavior**
Please describe what you expected to happen.

**Runtime Environment**
* Spunky Bot version:
* Python version:
* Operating system:
* How you installed Spunky Bot (DEB/PPA, pip, source):

**Log file / Screenshots / Console output**
If applicable, add the devel.log file from your Spunky Bot installation folder, add screenshots or console output to help explain your problem.

**Additional context**
Add any other context about the problem here.
10 changes: 10 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# https://help.github.com/en/github/building-a-strong-community/configuring-issue-templates-for-your-repository

blank_issues_enabled: true
contact_links:
- name: 📝 Spunky Bot Code of Conduct
url: https://github.com/SpunkyBot/spunkybot/blob/develop/.github/CODE_OF_CONDUCT.md
about: Be nice to other members of the community
- name: 💬 Spunky Bot Mailing List / Users Forum
url: https://groups.google.com/forum/#!forum/spunkybot
about: Ask and discuss questions with community members
16 changes: 16 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
name: "\U0001F4DA Documentation"
about: Improvements or additions to documentation
title: ''
labels: documentation
assignees: ''

---

For typos and documentation fixes, please go ahead and:

* create an issue
* fix the typo
* submit a pull request

Thank you!
17 changes: 17 additions & 0 deletions .github/ISSUE_TEMPLATE/feature-request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
name: "\U0001F680 Feature request"
about: Suggest an idea for this project
title: 'Feature Request: '
labels: feature request
assignees: ''

---

**Summary**
Please describe what the problem is.

**Motivation**
Please describe the solution and what you want to happen.

**Additional context**
Add any other context or screenshots about the feature request here.
33 changes: 33 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
Thank you for contributing a Pull Request!

## Please follow the checklist:

- Put an x into all the boxes [ ] relevant to your *pull request* (like that [x])
- [Search](https://github.com/SpunkyBot/spunkybot/search?q=is%3Apr&state=open&type=Issues) the issue tracker for similar pull requests
- Check the code with [flake8](https://pypi.org/project/flake8/)
- If an enhancement *pull request* please create some documentation and at best an example
- Make a descriptive *pull request* text (it will be used for the changelog)
- Use *Preview* tab to see how your *pull request* will actually look like

---

## What is the purpose of your *pull request*:

- [ ] Bug fix
- [ ] Improvement
- [ ] New Feature
- [ ] Documentation


## Description:

```
Please make sure the description explains the purpose and effect of the pull request
```

Explanation of your *pull request* in arbitrary form goes here.

```
If you are fixing an existing issue, please include "Fixed #nn: <Summary>" in
your commit message and your description which explains what the change does.
```
50 changes: 50 additions & 0 deletions .github/SECURITY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
# Security Policy

## Reporting a Vulnerability

If you discover a security issue in Spunky Bot, please report it by sending an email to security@spunkybot.de

This will allow us to assess the risk, and make a fix available before we add a bug report to the GitHub repository.

Thanks for helping make Spunky Bot safe for everyone.

We recommend to use PGP for these kind of communications, the fingerprint is
`06BF 8E04 B244 4ED7 A3D8 9FB3 7EC0 1A25 9051 4A31`.

<details>
<summary>PGP Key</summary>

```
-----BEGIN PGP PUBLIC KEY BLOCK-----
Version: GnuPG v2
mQENBFk8/fsBCADejWQoEY3PLgSr0BbShZUUjz4iTr6UYCVj5au/q758eQwMeVF5
0IpeVViDtGzYZVOxQQqz7kfFqWvIx9qanU1v35HTDq3ztAFQHjijlyW9vwGbmF5t
Nc9lJwXsO2qCkhz8+2cgAAfVhqEqdHWei5o8TV5sfyxkXO4HeYsjLBneSMD1fYdb
Cow31fLdm6sspJNeWvkDc3y1WLkwk77DtLSJM/L42W5sUSuah9Vxq2OUa0rEwPjT
PXveTtONWd/m/30gGN1xzGuo60eDZWOvIfIIyHTNbOjDQk0C5yDXmy2BjOrksG3J
0KAOQJyzetpCRkyRoLQxrIx91bil4WOQopzjABEBAAG0K1NwdW5reSBCb3QgU2Vj
dXJpdHkgPHNlY3VyaXR5QHNwdW5reWJvdC5kZT6JATkEEwEIACMFAlk8/fsCGwMH
CwkIBwMCAQYVCAIJCgsEFgIDAQIeAQIXgAAKCRB+wBolkFFKMSxUB/oDU/hT75Ly
LKIO/SzIPgmKjCca4GK5L0DPz8X75ZlKYo3M5C4ZzxPDzgSP/SOzeEJ6RsBve/Jc
jPPXY5CmY6i73V8vcPMiXTe6lfad1+hwU7fu0YFoDat4Gw/qbLA4QfgeqTGa/3wE
AiL3+EFvWJA+kBDNmVi6MWXq6pZC3dSG6rg6crDRwaa+/Yv7hp2VXviAPvA6CCgr
xCxp4e1lOS2x40S7fIhqF8Ki94i9zwl0ALYVBBMARWqEQmujLQSReJjv5ctkh7R+
45qsOMbcimKq0Gsy6+luQ/PkR2wYHfSt9VeMJCYHXYrt+2uTjH2FuXOeHaDfF08j
PqyZqmG1JPC7uQENBFk8/fsBCACeosYbgCq7xRmzuCgka03Pok5OtO0sYdUWrUZa
Timu0v+Di6jRQNVIZSa74H7qH24sELzEagVYUKgfewAxy2zgDE1DwRz2PHKfGPMI
fjr8DtLNCALblDXy6RbFP67pBXcmOqE2+7CkbrqILQUmQ+ordP1wxg3Vv4IBWEcJ
V2j9rztD7ACim1NRDInoFL0ZgqhTimKfJqMFr2rN3BGnxAwQMjBiRZz3NGyRSZ+L
S6iNwVBan+SBmlE6zBQoe3DohI6+ADYidwrOHUAv6iNRfOEbdAog8qWTOZBAQqlX
H1/pYoBxTuUwL3hwpInKJWNFAvDXOPFbJlFigDRmW09Os8W3ABEBAAGJAR8EGAEI
AAkFAlk8/fsCGwwACgkQfsAaJZBRSjF1ewgA0xExnBhUkE8pek4Z2bv6CZ9ExHNi
DWU75vtZS9Evjqj+m5xjdarRwJyqNjF2ST+EVvgH2IcEFfg+rVPBTsxdiUZWSE0y
Vcg4/D1XIPK8kfI+T20YxY4tuGeUHxUmSL4aaWjW3e0/NMWDysCANuBiP8mhYLA4
IhEWWcY/LAGR7m7FBnmo778MBhThcB11cjkAc8Pm0Xb3TIEV/zvoGtYV9uxvFV+r
VpvaXwBI9pmZGzHxt5QeXwW6sbYDlsjFulLRklxCPJvN2Vwqjh85QjxCbOMdibXf
q0T2HaN0Jt4POCiF42VM1a8HjER01piqBAiwNj/JWCv3YQknHiwA4sYzcg==
=wrwK
-----END PGP PUBLIC KEY BLOCK-----
```

</details>
16 changes: 16 additions & 0 deletions .github/SUPPORT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Support

## Bug reports

See the [contributing guidelines](CONTRIBUTING.md) for sharing bug reports.

## How-to

For general troubleshooting or help getting started:

* Join the [mailing list](https://groups.google.com/group/spunkybot)
* Explore the [documentation](https://docs.spunkybot.de)

## Security issues

If you discover a security vulnerability in this project, please see [SECURITY.md](SECURITY.md) for information on how to report it privately.
8 changes: 8 additions & 0 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# dependabot.yml file with updates

version: 2
updates:
- package-ecosystem: "github-actions"
directory: "/"
schedule:
interval: daily
124 changes: 124 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,124 @@
name: CI

on: [push, pull_request]

jobs:

lint:
name: Check lint
runs-on: ubuntu-latest
steps:
# Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
- name: Checkout
uses: actions/checkout@v2
- name: Set up Python 2.7
uses: actions/setup-python@v2
with:
python-version: 2.7

- name: Install dependencies
run: |
python -m pip install --upgrade pip
if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
- name: Lint with flake8
run: |
# stop the build if there are Python syntax errors or undefined names
flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics --exclude=tests
flake8 . --count --max-complexity=10 --max-line-length=127 --statistics --exclude=tests
- name: Test spunky.py with Pylint
run: |
pip install pylint
pylint spunky.py --disable=C0103,C0111,C0301,C0302,W0703,R0101,R0201,R0902,R0903,R0904,R0912,R0913,R0914,R0915,R0916
# make sure that the README is formatted properly
- name: Lint format in setup.py
run: python setup.py check --restructuredtext --strict --metadata

- name: Lint with RST reStructuredText
run: rst-lint README.md CHANGELOG.md LICENSE doc/Commands.md .github/CONTRIBUTING.md .github/CODE_OF_CONDUCT.md .github/SUPPORT.md

markdown-lint:
name: Check Markdown
runs-on: ubuntu-latest
steps:
# Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
- name: Checkout
uses: actions/checkout@v2
- uses: actions/setup-node@v2.1.0
with:
node-version: '12.x'

- run: npm install -g markdown-link-check
- run: markdown-link-check ./README.md
- run: markdown-link-check ./CHANGELOG.md
- run: markdown-link-check ./.github/CONTRIBUTING.md
- run: markdown-link-check ./.github/SECURITY.md
- run: markdown-link-check ./.github/CODE_OF_CONDUCT.md
- run: markdown-link-check ./.github/SUPPORT.md
# https://github.com/igorshubovych/markdownlint-cli
- run: npm install -g markdownlint-cli
- name: Run markdownlint '**/*.md'
run: |
touch .markdownlint.yaml && cat >> .markdownlint.yaml <<'EOF'
MD013: false
MD024: false
MD026: false
MD040: false
MD041: false
EOF
markdownlint '**/*.md' --config .markdownlint.yaml
pytest:
name: Run pytest
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v2
- name: Set up Python 2.7
uses: actions/setup-python@v2
with:
python-version: 2.7

- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install pytest
- name: Run pytest
run: |
pytest
setup:
name: Check setup
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v2
- name: Set up Python 2.7
uses: actions/setup-python@v2
with:
python-version: 2.7

- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install setuptools wheel twine check-manifest
- name: Show versions
run: |
python --version
pip --version
twine --version
wheel version
- name: Build and check with twine
run: |
check-manifest
python setup.py check --metadata --strict
python setup.py build
python setup.py test
python setup.py sdist bdist_wheel
twine check dist/*
Loading

0 comments on commit 340675a

Please sign in to comment.