Skip to content
Snippets Groups Projects
Commit a475795c authored by Niklas Schrötler's avatar Niklas Schrötler
Browse files

Added basic outline

Inspired by the Keycloak, HA-Proxy and Zammad roles
(Hopefully) Resolves #1
parents
No related branches found
No related tags found
No related merge requests found
Pipeline #234075 passed
skip_list:
- role-name
.idea
---
stages:
- linting
cache:
paths:
- .cache
ansible-lint:
stage: linting
image:
name: registry.gitlab.fachschaften.org/fsi-ansible/ci-docker-image:latest
entrypoint: [""]
script:
- ansible-lint -v --offline
---
extends: default
LICENSE 0 → 100644
MIT License
Copyright (c) 2023 $YOUR_NAME
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
$ROLE_NAME
========
Describe what this role does.
Role Variables
--------------
Please list what variables your roles accepts, which are necessary and which optional, and what they do.
| Name | Required | Description | Default Value |
|-------------|----------|------------------------------|---------------|
| `var_name` | ✅ / ❌ | This variable does something | `True` |
License
-------
MIT License
Author Information
------------------
[$YOUR_NAME](https://gitlab.fachschaften.org/$YOUR_USERNAME)
---
## How to use this template
1. Fill out this `README.md`
2. Replace $YOUR_NAME with your name in `LICENSE`
3. Update the `meta/main.yml`
1. Replace $YOUR_NAME with your name
2. Replace `$ROLE_NAME` with the name of your role. If you are deploying Keycloak for example, please call it `keycloak`. Please be careful to replace it in the `issue_tracker_url` too!
3. Update the `platforms` accordingly
4. Add your variable defaults into `defaults/main.yml`
5. Now start developing your role. Get started in `tasks/main.yml`
6. Before publishing, remove this section
---
# key: value
---
---
galaxy_info:
author: $YOUR_NAME
description: Describe what this role does.
role_name: $ROLE_NAME
namespace: fsi_ansible
# If the issue tracker for your role is not on github, uncomment the
# next line and provide a value
issue_tracker_url: https://gitlab.fachschaften.org/fsi-ansible/$ROLE_NAME/issues
# Choose a valid license ID from https://spdx.org - some suggested licenses:
# - BSD-3-Clause (default)
# - MIT
# - GPL-2.0-or-later
# - GPL-3.0-only
# - Apache-2.0
# - CC-BY-4.0
license: MIT
min_ansible_version: "2.4"
# If this a Container Enabled role, provide the minimum Ansible Container version.
# min_ansible_container_version:
#
# Provide a list of supported platforms, and for each platform a list of versions.
# If you don't wish to enumerate all versions for a particular platform, use 'all'.
# To view available platforms and versions (or releases), visit:
# https://galaxy.ansible.com/api/v1/platforms/
#
platforms:
- name: Ubuntu
versions:
- all
galaxy_tags: []
# List tags for your role here, one per line. A tag is a keyword that describes
# and categorizes the role. Users find roles by searching for tags. Be sure to
# remove the '[]' above, if you add tags to this list.
#
# NOTE: A tag is limited to a single word comprised of alphanumeric characters.
# Maximum 20 tags per role.
dependencies: []
# List your role dependencies here, one per line. Be sure to remove the '[]' above,
# if you add dependencies to this list.
{
"$schema": "https://docs.renovatebot.com/renovate-schema.json",
"extends": [
"config:base"
],
"regexManagers": [
{
"fileMatch": [".*ya?ml$"],
"matchStrings": [
"datasource=(?<datasource>.*?) depName=(?<depName>.*?)( versioning=(?<versioning>.*?))?\\s\\w+?_version:\\s?(?<currentValue>[^'\\s]+)"
],
"versioningTemplate": "{{#if versioning}}{{{versioning}}}{{else}}semver{{/if}}"
}
]
}
---
- name: Demo
ansible.builtin.debug:
msg: Your role works!
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment