generated from the-liberated-edge/wikijs
i-1 Introduces an Ansible playbook for linux-container with SSH access #2
16
README.md
16
README.md
@ -102,18 +102,18 @@ rule in our source control system.
|
||||
2. All commits as part of a feature branch have been squashed into a single
|
||||
commit that has been merged in the `main` branch.
|
||||
3. Every git pull request has been linked to exactly one project issue. The
|
||||
issue number prefixes the pull request title, e.g. `i-1 <issue title>`.
|
||||
issue number prefixes the pull request title, e.g. `i-1 <pull request title>`.
|
||||
4. The change has been thoroughly reviewed and all discovered issues have
|
||||
been resolved. Merging without a code review approval is only acceptable
|
||||
when reviewers are not available.
|
||||
5. The change has been tested by Ansible Molecule scenarios. Our team adopted
|
||||
an approach resembling Test Driven Development for the sake of automated
|
||||
regression testing and avoidance.
|
||||
regression testing.
|
||||
6. All automated tests have been passing successfully consistently. We have
|
||||
zero tolerance on test flakiness.
|
||||
7. Source code has been linted with `yamllint` and `ansible-lint`. Any issues
|
||||
have been resolved.
|
||||
8. YAML documents have been formated with `yamlfix`.
|
||||
7. Source code has been linted with `yamllint` and `ansible-lint`. Any errors
|
||||
have been fixed.
|
||||
8. All YAML documents have been formated with `yamlfix`.
|
||||
9. User facing changes have been documented appropriately.
|
||||
|
||||
## Development environment setup
|
||||
@ -158,7 +158,7 @@ pipenv install --dev
|
||||
pipenv shell
|
||||
```
|
||||
|
||||
### Lint Ansible artifacts
|
||||
## Lint Ansible artifacts
|
||||
|
||||
Navigate to the root folder of the local copy of this git repository.
|
||||
|
||||
@ -178,7 +178,7 @@ Use `ansible-lint` to verify good practices relevant to Ansible.
|
||||
LC_ALL=C.UTF-8 ansible-lint .
|
||||
```
|
||||
|
||||
### YAML code formatting
|
||||
## YAML code formatting
|
||||
|
||||
Navigate to the root folder of the local copy of this git repository.
|
||||
|
||||
@ -192,7 +192,7 @@ Format all YAML documents.
|
||||
yamlfix .
|
||||
```
|
||||
|
||||
### Execute Ansible Molecule scenarios
|
||||
## Execute Ansible Molecule scenarios
|
||||
|
||||
In order to run all existing Ansible Molecule scenarios, one needs to
|
||||
follow the steps below.
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user