Merge pull request #2 from roles-ansible/docs

Update gitea role and improve docs

.github/workflows/ansible-linting-check.yml

@@ -16,8 +16,12 @@ jobs:
     steps:
       - name: 'checkout git repo'
         uses: actions/checkout@v3
+        with:
+          lfs: true
+          submodules: true
+          fetch-depth: 0
 
       - name: 'Lint Ansible Playbook'
         uses: ansible/ansible-lint-action@v6
         with:
-          targets: "."
+          path: "."

README.md

@@ -1,11 +1,15 @@
+[![collection l3d.git](https://ansible.l3d.space/svg/l3d.git_ansible-collection_collection.svg)](https://galaxy.ansible.com/l3d/git)
+[![Maintainance](https://ansible.l3d.space/svg/l3d.git_maintainance_collection.svg)](https://ansible.l3d.space/#l3d.git)
+[![License](https://ansible.l3d.space/svg/l3d.git_license_collection.svg)](LICENSE)
+
  Ansible Collection - l3d.git
 ============================
 
-This is the Ansible Collection l3d.git.
+This is the Ansible Collection ``l3d.git``.
 Here are all our ansible roles for installing git server.
 
-## Roles in l3d.git
+## Ansible Roles in l3d.git
-- [l3d.git.gitea](https://github.com/roles-ansible/ansible_role_gitea.git) - Ansible role to install gitea or forgejo git server
+- [![l3d.git.gitea](https://ansible.l3d.space/svg/l3d.git.gitea_ansible-role.svg)](https://github.com/roles-ansible/ansible_role_gitea.git) - Ansible role to install gitea or forgejo git server
 
 ## Using this Collection
 You can install the collection using ansible-galaxy by running:
@@ -13,13 +17,27 @@ You can install the collection using ansible-galaxy by running:
 ansible-galaxy collection install l3d.git
 ```
 
-Or you could clone this collection in your local ansible project as ``collections/ansible_collections/l3d/git/``.
+Or you could clone this collection in your local ansible project for example to ``collections/ansible_collections/l3d/git/``. Make sure you checkout [git submodules](https://git-scm.com/docs/git-submodule) too. Example:
+```
+# Clone git Repo with submodules to specified path
+git clone --recursive https://github.com/roles-ansible/ansible_collection_git.git collections/ansible_collections/l3d/git/
+
+# change directory
+cd collections/ansible_collections/l3d/git/
+
+# optionally init git submodules
+git submodule update --init --recursive
+
+# optionally install all requirements
+ansible-galaxy install -r requirements.yml
+```
 
 You can also list a collection in ``requirements.yml``:
 ```yaml
 ---
 collections:
   - name: l3d.git
+    version: ">=1.0.1"
 ```
 
 ## Include roles in your playbook

galaxy.yml

@@ -9,7 +9,7 @@ namespace: l3d
 name: git
 
 # The version of the collection. Must be compatible with semantic versioning
-version: 1.0.0
+version: 1.0.1
 
 # The path to the Markdown (.md) readme file. This path is relative to the root of the collection
 readme: README.md
@@ -47,7 +47,8 @@ tags:
 # collection label 'namespace.name'. The value is a version range
 # L(specifiers,https://python-semanticversion.readthedocs.io/en/latest/#requirement-specification). Multiple version
 # range specifiers can be set and are separated by ','
-dependencies: {}
+dependencies:
+  "community.general": ">=6.5.0"
 
 # The URL of the originating SCM repository
 repository: https://github.com/roles-ansible/ansible_collection_git.git

requirements.yml

@@ -0,0 +1,4 @@
+---
+collections:
+  - name: community.general
+    version: ">=6.5.0"

roles/gitea

@@ -1 +1 @@
-Subproject commit 0daa72de78b4fa96e1c1cfcd0a70bff826ec61e7
+Subproject commit bcd4987a516c77cc9e919a6a6a9bf7ff3f9fa1aa