Skip to content

Commit fe115de

Browse files
committed
feat: 🎉 initial commit
0 parents  commit fe115de

File tree

19 files changed

+895
-0
lines changed

19 files changed

+895
-0
lines changed

.config/.ansible-lint

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
warn_list: # or 'skip_list' to silence them completely
2+
- no-changed-when # Commands should not change things if nothing needs do
Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
title: "[BUG]"
5+
labels: bug
6+
assignees: konykon, oyale
7+
8+
---
9+
10+
**Describe the bug**
11+
A clear and concise description of what the bug is.
12+
13+
**To Reproduce**
14+
Steps to reproduce the behaviour. Tell us about:
15+
- Python version
16+
- Use of virtual environments
17+
- Any other information of interest.
18+
19+
**Logs**
20+
```bash
21+
Properly redacted if needed, please paste here the output of the execution.
22+
```
23+
**Environment (please complete the following information):**
24+
- OS: [e.g. Arch]
25+
- Shell [e.g. bash, zshi]
26+
27+
**Additional context**
28+
Add any other context about the problem here.
Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
title: "[FEATURE]"
5+
labels: enhancement
6+
assignees: konykon, oyale
7+
8+
---
9+
10+
**Is your feature request related to a problem? Please describe.**
11+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
12+
13+
**Describe the solution you'd like**
14+
A clear and concise description of what you want to happen.
15+
16+
**Describe alternatives you've considered**
17+
A clear and concise description of any alternative solutions or features you've considered.
18+
19+
**Additional context**
20+
Add any other context or screenshots about the feature request here.

.github/dependabot.yml

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# To get started with Dependabot version updates, you'll need to specify which
2+
# package ecosystems to update and where the package manifests are located.
3+
# Please see the documentation for all configuration options:
4+
# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
5+
6+
version: 2
7+
updates:
8+
- package-ecosystem: "pip" # See documentation for possible values
9+
directory: "/" # Location of package manifests
10+
schedule:
11+
interval: "weekly"

.github/workflows/ansible_lint.yml

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
name: Ansible Lint
2+
on: [push, pull_request]
3+
4+
jobs:
5+
build:
6+
runs-on: ubuntu-latest
7+
8+
steps:
9+
- uses: actions/checkout@v2
10+
11+
- name: Run ansible-lint
12+
uses: ansible-community/ansible-lint-action@main

.pre-commit-config.yaml

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
---
2+
repos:
3+
- repo: https://github.com/ansible-community/ansible-lint
4+
rev: v5.4.0
5+
hooks:
6+
- id: ansible-lint
7+
8+
- repo: https://github.com/pre-commit/pre-commit-hooks
9+
rev: v3.2.0
10+
hooks:
11+
- id: trailing-whitespace
12+
exclude: /README\.rst$|\.pot?$
13+
14+
- repo: https://github.com/adrienverge/yamllint
15+
rev: v1.26.3
16+
hooks:
17+
- id: yamllint

CONTRIBUTING.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# Development setup
2+
3+
### Configure python environment
4+
5+
In order to assure that the files contained here are linted the same way, we are using [`pyenv`](https://github.com/pyenv/pyenv).
6+
7+
Follow [Installing and using pyenv](https://github.com/coopdevs/handbook/wiki/Installing-and-using-pyenv), or, in short:
8+
9+
```sh
10+
pyenv install 3.8.12
11+
pyenv virtualenv 3.8.12 role-name
12+
```
13+
14+
### Configure ansible environment
15+
16+
You will need Ansible on your machine to run the playbooks, follow the steps below to install it.
17+
18+
```sh
19+
pyenv exec pip install -r requirements.txt
20+
ansible-galaxy install -r requirements.yml -f
21+
```
22+
23+
### Install pre-commit hooks
24+
25+
We use [pre-commit framework](https://pre-commit.com/) to assure quality code.
26+
27+
```sh
28+
pre-commit install
29+
```

0 commit comments

Comments
 (0)