upgrade(README): Improve README, clarify instructions and add documentation links
All checks were successful
Master branch: build & lint / build (push) Successful in 1m8s

This commit is contained in:
Thomas Maurice 2024-03-24 12:46:12 +01:00
parent 93bb0b0742
commit 4667b5de57
Signed by: thomas
GPG key ID: 1D577F50583032A6
4 changed files with 72 additions and 14 deletions

View file

@ -16,13 +16,18 @@ jobs:
python-version: '3.10.13' python-version: '3.10.13'
- name: "Creates virtual environment" - name: "Creates virtual environment"
run: make venv run: make venv
# Loads up the virtualenv
- name: Activate virtualenv - name: Activate virtualenv
run: | run: |
source venv/bin/activate source venv/bin/activate
echo PATH=$PATH >> $GITHUB_ENV echo PATH=$PATH >> $GITHUB_ENV
# Installs playbooks we are using
- name: Install galaxy requirements - name: Install galaxy requirements
run: ansible-galaxy install -r requirements.yml run: ansible-galaxy install -r requirements.yml
# Checks for yaml correctness
- name: "Run YAML linting" - name: "Run YAML linting"
run: yamllint -c .yamllint.yml . run: yamllint -c .yamllint.yml .
# Runs an *ansible specific* linter to check for mistakes
# and or/bad patterns
- name: "Run Ansible linting" - name: "Run Ansible linting"
run: ansible-lint run: ansible-lint

View file

@ -18,13 +18,18 @@ jobs:
python-version: '3.10.13' python-version: '3.10.13'
- name: "Creates virtual environment" - name: "Creates virtual environment"
run: make venv run: make venv
# Loads up the virtualenv
- name: Activate virtualenv - name: Activate virtualenv
run: | run: |
source venv/bin/activate source venv/bin/activate
echo PATH=$PATH >> $GITHUB_ENV echo PATH=$PATH >> $GITHUB_ENV
# Installs playbooks we are using
- name: Install galaxy requirements - name: Install galaxy requirements
run: ansible-galaxy install -r requirements.yml run: ansible-galaxy install -r requirements.yml
# Checks for yaml correctness
- name: "Run YAML linting" - name: "Run YAML linting"
run: yamllint -c .yamllint.yml . run: yamllint -c .yamllint.yml .
# Runs an *ansible specific* linter to check for mistakes
# and or/bad patterns
- name: "Run Ansible linting" - name: "Run Ansible linting"
run: ansible-lint run: ansible-lint

View file

@ -6,4 +6,4 @@ install:
ansible-galaxy install -r requirements.yml ansible-galaxy install -r requirements.yml
action: action:
act -W .gitea/workflows/on_pr.yml act -W .gitea/workflows/on_pr.yml

File diff suppressed because one or more lines are too long