mirror of
https://github.com/thegeeklab/ansible-doctor.git
synced 2024-11-21 12:20:40 +00:00
migrate to thegeeklab namespace
This commit is contained in:
parent
abf49fad9b
commit
131c2f0c1a
@ -169,7 +169,7 @@ local PipelineBuildContainer(arch='amd64') = {
|
||||
settings: {
|
||||
dry_run: true,
|
||||
dockerfile: 'docker/Dockerfile',
|
||||
repo: 'xoxys/${DRONE_REPO_NAME}',
|
||||
repo: 'thegeeklab/${DRONE_REPO_NAME}',
|
||||
username: { from_secret: 'docker_username' },
|
||||
password: { from_secret: 'docker_password' },
|
||||
},
|
||||
@ -185,7 +185,7 @@ local PipelineBuildContainer(arch='amd64') = {
|
||||
auto_tag: true,
|
||||
auto_tag_suffix: arch,
|
||||
dockerfile: 'docker/Dockerfile',
|
||||
repo: 'xoxys/${DRONE_REPO_NAME}',
|
||||
repo: 'thegeeklab/${DRONE_REPO_NAME}',
|
||||
username: { from_secret: 'docker_username' },
|
||||
password: { from_secret: 'docker_password' },
|
||||
},
|
||||
@ -272,7 +272,7 @@ local PipelineDocs = {
|
||||
},
|
||||
{
|
||||
name: 'link-validation',
|
||||
image: 'xoxys/link-validator',
|
||||
image: 'thegeeklab/link-validator',
|
||||
commands: [
|
||||
'link-validator -ro',
|
||||
],
|
||||
@ -374,8 +374,8 @@ local PipelineNotifications = {
|
||||
from_secret: 'docker_username',
|
||||
},
|
||||
PUSHRM_FILE: 'README.md',
|
||||
PUSHRM_SHORT: 'ansible-doctor - Simple annotation based documentation for your roles',
|
||||
PUSHRM_TARGET: 'xoxys/${DRONE_REPO_NAME}',
|
||||
PUSHRM_SHORT: 'Annotation based documentation for your Ansible roles',
|
||||
PUSHRM_TARGET: 'thegeeklab/${DRONE_REPO_NAME}',
|
||||
},
|
||||
when: {
|
||||
status: ['success'],
|
||||
|
20
.drone.yml
20
.drone.yml
@ -188,7 +188,7 @@ steps:
|
||||
dry_run: true
|
||||
password:
|
||||
from_secret: docker_password
|
||||
repo: xoxys/${DRONE_REPO_NAME}
|
||||
repo: thegeeklab/${DRONE_REPO_NAME}
|
||||
username:
|
||||
from_secret: docker_username
|
||||
when:
|
||||
@ -205,7 +205,7 @@ steps:
|
||||
dockerfile: docker/Dockerfile
|
||||
password:
|
||||
from_secret: docker_password
|
||||
repo: xoxys/${DRONE_REPO_NAME}
|
||||
repo: thegeeklab/${DRONE_REPO_NAME}
|
||||
username:
|
||||
from_secret: docker_username
|
||||
when:
|
||||
@ -264,7 +264,7 @@ steps:
|
||||
dry_run: true
|
||||
password:
|
||||
from_secret: docker_password
|
||||
repo: xoxys/${DRONE_REPO_NAME}
|
||||
repo: thegeeklab/${DRONE_REPO_NAME}
|
||||
username:
|
||||
from_secret: docker_username
|
||||
when:
|
||||
@ -281,7 +281,7 @@ steps:
|
||||
dockerfile: docker/Dockerfile
|
||||
password:
|
||||
from_secret: docker_password
|
||||
repo: xoxys/${DRONE_REPO_NAME}
|
||||
repo: thegeeklab/${DRONE_REPO_NAME}
|
||||
username:
|
||||
from_secret: docker_username
|
||||
when:
|
||||
@ -340,7 +340,7 @@ steps:
|
||||
dry_run: true
|
||||
password:
|
||||
from_secret: docker_password
|
||||
repo: xoxys/${DRONE_REPO_NAME}
|
||||
repo: thegeeklab/${DRONE_REPO_NAME}
|
||||
username:
|
||||
from_secret: docker_username
|
||||
when:
|
||||
@ -357,7 +357,7 @@ steps:
|
||||
dockerfile: docker/Dockerfile
|
||||
password:
|
||||
from_secret: docker_password
|
||||
repo: xoxys/${DRONE_REPO_NAME}
|
||||
repo: thegeeklab/${DRONE_REPO_NAME}
|
||||
username:
|
||||
from_secret: docker_username
|
||||
when:
|
||||
@ -437,7 +437,7 @@ steps:
|
||||
- hugo-official -s docs/ -b http://localhost/
|
||||
|
||||
- name: link-validation
|
||||
image: xoxys/link-validator
|
||||
image: thegeeklab/link-validator
|
||||
commands:
|
||||
- link-validator -ro
|
||||
environment:
|
||||
@ -529,8 +529,8 @@ steps:
|
||||
DOCKER_USER:
|
||||
from_secret: docker_username
|
||||
PUSHRM_FILE: README.md
|
||||
PUSHRM_SHORT: ansible-doctor - Simple annotation based documentation for your roles
|
||||
PUSHRM_TARGET: xoxys/${DRONE_REPO_NAME}
|
||||
PUSHRM_SHORT: Annotation based documentation for your Ansible roles
|
||||
PUSHRM_TARGET: thegeeklab/${DRONE_REPO_NAME}
|
||||
when:
|
||||
status:
|
||||
- success
|
||||
@ -577,6 +577,6 @@ depends_on:
|
||||
|
||||
---
|
||||
kind: signature
|
||||
hmac: 44a9e95a43eeabae35a5ba7f8740758703a564e9d8ac1e22c731b3b7a29f1a22
|
||||
hmac: 557a0e342d2dd525444b187e7c544105ea30e15857c98e90bb554060ebf4ae01
|
||||
|
||||
...
|
||||
|
2
.github/settings.yml
vendored
2
.github/settings.yml
vendored
@ -1,7 +1,7 @@
|
||||
---
|
||||
repository:
|
||||
name: ansible-doctor
|
||||
description: Simple annotation based documentation for your roles
|
||||
description: Annotation based documentation for your Ansible roles
|
||||
homepage: https://ansible-doctor.geekdocs.de
|
||||
topics: ansible, documentation, automation, python
|
||||
|
||||
|
@ -1,2 +1,2 @@
|
||||
- INTERNAL
|
||||
- publish to dockerhub and quay.io
|
||||
- migrate to thegeeklab namespace
|
||||
|
2
LICENSE
2
LICENSE
@ -1,7 +1,7 @@
|
||||
GNU GENERAL PUBLIC LICENSE
|
||||
Version 3, 29 June 2007
|
||||
|
||||
Copyright (C) 2020 Robert Kaussow <mail@geeklabor.de>
|
||||
Copyright (C) 2020 Robert Kaussow <mail@thegeeklab.de>
|
||||
Everyone is permitted to copy and distribute verbatim copies
|
||||
of this license document, but changing it is not allowed.
|
||||
|
||||
|
23
README.md
23
README.md
@ -1,28 +1,29 @@
|
||||
# ansible-doctor
|
||||
|
||||
ansible-doctor - Simple annotation based documentation for your roles
|
||||
Annotation based documentation for your Ansible roles
|
||||
|
||||
[![Build Status](https://img.shields.io/drone/build/xoxys/ansible-doctor?logo=drone)](https://cloud.drone.io/xoxys/ansible-doctor)
|
||||
[![Docker Hub](https://img.shields.io/badge/dockerhub-latest-blue.svg?logo=docker&logoColor=white)](https://hub.docker.com/r/xoxys/ansible-doctor)
|
||||
[![Build Status](https://img.shields.io/drone/build/thegeeklab/ansible-doctor?logo=drone)](https://cloud.drone.io/thegeeklab/ansible-doctor)
|
||||
[![Docker Hub](https://img.shields.io/badge/dockerhub-latest-blue.svg?logo=docker&logoColor=white)](https://hub.docker.com/r/thegeeklab/ansible-doctor)
|
||||
[![Quay.io](https://img.shields.io/badge/quay-latest-blue.svg?logo=docker&logoColor=white)](https://quay.io/repository/thegeeklab/ansible-doctor)
|
||||
[![Python Version](https://img.shields.io/pypi/pyversions/ansible-doctor.svg)](https://pypi.org/project/ansible-doctor/)
|
||||
[![PyPI Status](https://img.shields.io/pypi/status/ansible-doctor.svg)](https://pypi.org/project/ansible-doctor/)
|
||||
[![PyPI Release](https://img.shields.io/pypi/v/ansible-doctor.svg)](https://pypi.org/project/ansible-doctor/)
|
||||
[![Source: GitHub](https://img.shields.io/badge/source-github-blue.svg?logo=github&logoColor=white)](https://github.com/xoxys/ansible-doctor)
|
||||
[![License: MIT](https://img.shields.io/github/license/xoxys/ansible-doctor)](LICENSE)
|
||||
[![Source: GitHub](https://img.shields.io/badge/source-github-blue.svg?logo=github&logoColor=white)](https://github.com/thegeeklab/ansible-doctor)
|
||||
[![GitHub contributors](https://img.shields.io/github/contributors/thegeeklab/ansible-doctor)](https://github.com/thegeeklab/ansible-doctor/graphs/contributors)
|
||||
[![License: GPL-3.0](https://img.shields.io/github/license/thegeeklab/ansible-doctor)](https://github.com/thegeeklab/ansible-doctor/blob/master/LICENSE)
|
||||
|
||||
This project is based on the idea (and at some parts on the code) of [ansible-autodoc](https://github.com/AndresBott/ansible-autodoc) by Andres Bott so credits goes to him for his work.
|
||||
|
||||
_ansible-doctor_ is a simple annotation like documentation generator based on Jinja2 templates. While _ansible-doctor_ comes with a default template called `readme`, it is also possible to write your own templates. This gives you the ability to customize the output and render the data to every format you like (e.g. HTML or XML).
|
||||
|
||||
_ansible-doctor_ is designed to work within your CI pipeline to complete your testing and deployment workflow. Releases are available as Python Packages on [GitHub](https://github.com/xoxys/ansible-doctor/releases) or [PyPI](https://pypi.org/project/ansible-doctor/) and as Docker Image on [Docker Hub](https://hub.docker.com/r/xoxys/ansible-doctor).
|
||||
_ansible-doctor_ is designed to work within your CI pipeline to complete your testing and deployment workflow. Releases are available as Python Packages on [GitHub](https://github.com/thegeeklab/ansible-doctor/releases) or [PyPI](https://pypi.org/project/ansible-doctor/) and as Docker Image on [Docker Hub](https://hub.docker.com/r/thegeeklab/ansible-doctor).
|
||||
|
||||
You can find the full documentation at [https://ansible-doctor.geekdocs.de](https://ansible-doctor.geekdocs.de/).
|
||||
|
||||
## Contributors
|
||||
|
||||
Special thanks goes to all [contributors](https://github.com/thegeeklab/ansible-doctor/graphs/contributors).
|
||||
|
||||
## License
|
||||
|
||||
This project is licensed under the GNU v3.0 - see the [LICENSE](https://github.com/xoxys/ansible-doctor/blob/master/LICENSE) file for details.
|
||||
|
||||
## Maintainers and Contributors
|
||||
|
||||
[Robert Kaussow](https://github.com/xoxys)
|
||||
This project is licensed under the GPL-3.0 License - see the [LICENSE](https://github.com/thegeeklab/ansible-doctor/blob/master/LICENSE) file for details.
|
||||
|
@ -2,8 +2,8 @@
|
||||
|
||||
__author__ = "Robert Kaussow"
|
||||
__project__ = "ansible-doctor"
|
||||
__version__ = "0.1.6"
|
||||
__version__ = "0.1.7"
|
||||
__license__ = "GPL-3.0"
|
||||
__maintainer__ = "Robert Kaussow"
|
||||
__email__ = "mail@geeklabor.de"
|
||||
__url__ = "https://github.com/xoxys/ansible-doctor"
|
||||
__email__ = "mail@thegeeklab.de"
|
||||
__url__ = "https://github.com/thegeeklab/ansible-doctor"
|
||||
|
@ -1,8 +1,8 @@
|
||||
FROM python:3.7-alpine
|
||||
|
||||
LABEL maintainer="Robert Kaussow <mail@geeklabor.de>" \
|
||||
LABEL maintainer="Robert Kaussow <mail@thegeeklab.de>" \
|
||||
org.label-schema.name="ansible-doctor" \
|
||||
org.label-schema.vcs-url="https://github.com/xoxys/ansible-doctor" \
|
||||
org.label-schema.vcs-url="https://github.com/thegeeklab/ansible-doctor" \
|
||||
org.label-schema.vendor="Robert Kaussow" \
|
||||
org.label-schema.schema-version="1.0"
|
||||
|
||||
|
@ -1,4 +1,4 @@
|
||||
image: xoxys/ansible-doctor:{{#if build.tag}}{{trimPrefix "v" build.tag}}{{else}}latest{{/if}}
|
||||
image: thegeeklab/ansible-doctor:{{#if build.tag}}{{trimPrefix "v" build.tag}}{{else}}latest{{/if}}
|
||||
{{#if build.tags}}
|
||||
tags:
|
||||
{{#each build.tags}}
|
||||
@ -6,18 +6,18 @@ tags:
|
||||
{{/each}}
|
||||
{{/if}}
|
||||
manifests:
|
||||
- image: xoxys/ansible-doctor:{{#if build.tag}}{{trimPrefix "v" build.tag}}-{{/if}}amd64
|
||||
- image: thegeeklab/ansible-doctor:{{#if build.tag}}{{trimPrefix "v" build.tag}}-{{/if}}amd64
|
||||
platform:
|
||||
architecture: amd64
|
||||
os: linux
|
||||
|
||||
- image: xoxys/ansible-doctor:{{#if build.tag}}{{trimPrefix "v" build.tag}}-{{/if}}arm64
|
||||
- image: thegeeklab/ansible-doctor:{{#if build.tag}}{{trimPrefix "v" build.tag}}-{{/if}}arm64
|
||||
platform:
|
||||
architecture: arm64
|
||||
os: linux
|
||||
variant: v8
|
||||
|
||||
- image: xoxys/ansible-doctor:{{#if build.tag}}{{trimPrefix "v" build.tag}}-{{/if}}arm
|
||||
- image: thegeeklab/ansible-doctor:{{#if build.tag}}{{trimPrefix "v" build.tag}}-{{/if}}arm
|
||||
platform:
|
||||
architecture: arm
|
||||
os: linux
|
||||
|
@ -21,7 +21,7 @@ params:
|
||||
geekdocMenuBundle: true
|
||||
geekdocToC: 3
|
||||
|
||||
geekdocRepo: https://github.com/xoxys/ansible-doctor
|
||||
geekdocRepo: https://github.com/thegeeklab/ansible-doctor
|
||||
geekdocEditPath: edit/master/docs/content
|
||||
|
||||
geekdocDateFormat: "Jan 2, 2006"
|
||||
|
@ -2,15 +2,18 @@
|
||||
title: Documentation
|
||||
---
|
||||
|
||||
[![Build Status](https://img.shields.io/drone/build/xoxys/ansible-doctor?logo=drone)](https://cloud.drone.io/xoxys/ansible-doctor/)
|
||||
[![Docker Hub](https://img.shields.io/badge/docker-latest-blue.svg?logo=docker&logoColor=white)](https://hub.docker.com/r/xoxys/ansible-doctor/)
|
||||
[![Build Status](https://img.shields.io/drone/build/thegeeklab/ansible-doctor?logo=drone)](https://cloud.drone.io/thegeeklab/ansible-doctor)
|
||||
[![Docker Hub](https://img.shields.io/badge/dockerhub-latest-blue.svg?logo=docker&logoColor=white)](https://hub.docker.com/r/thegeeklab/ansible-doctor)
|
||||
[![Quay.io](https://img.shields.io/badge/quay-latest-blue.svg?logo=docker&logoColor=white)](https://quay.io/repository/thegeeklab/ansible-doctor)
|
||||
[![Python Version](https://img.shields.io/pypi/pyversions/ansible-doctor.svg)](https://pypi.org/project/ansible-doctor/)
|
||||
[![PyPI Status](https://img.shields.io/pypi/status/ansible-doctor.svg)](https://pypi.org/project/ansible-doctor/)
|
||||
[![PyPI Release](https://img.shields.io/pypi/v/ansible-doctor.svg)](https://pypi.org/project/ansible-doctor/)
|
||||
[![License: MIT](https://img.shields.io/github/license/xoxys/ansible-doctor)](https://github.com/xoxys/ansible-doctor/blob/master/LICENSE)
|
||||
[![Source: GitHub](https://img.shields.io/badge/source-github-blue.svg?logo=github&logoColor=white)](https://github.com/thegeeklab/ansible-doctor)
|
||||
[![GitHub contributors](https://img.shields.io/github/contributors/thegeeklab/ansible-doctor)](https://github.com/thegeeklab/ansible-doctor/graphs/contributors)
|
||||
[![License: GPL-3.0](https://img.shields.io/github/license/thegeeklab/ansible-doctor)](https://github.com/thegeeklab/ansible-doctor/blob/master/LICENSE)
|
||||
|
||||
This project is based on the idea (and at some parts on the code) of [ansible-autodoc](https://github.com/AndresBott/ansible-autodoc) by Andres Bott so credits goes to him for his work.
|
||||
|
||||
_ansible-doctor_ is a simple annotation like documentation generator based on Jinja2 templates. While _ansible-doctor_ comes with a default template called `readme`, it is also possible to write your own templates. This gives you the ability to customize the output and render the data to every format you like (e.g. HTML or XML).
|
||||
|
||||
_ansible-doctor_ is designed to work within your CI pipeline to complete your testing and deployment workflow. Releases are available as Python Packages at [GitHub](https://github.com/xoxys/ansible-doctor/releases) or [PyPI](https://pypi.org/project/ansible-doctor/) and as Docker Image at [Docker Hub](https://hub.docker.com/r/xoxys/ansible-doctor).
|
||||
_ansible-doctor_ is designed to work within your CI pipeline to complete your testing and deployment workflow. Releases are available as Python Packages at [GitHub](https://github.com/thegeeklab/ansible-doctor/releases) or [PyPI](https://pypi.org/project/ansible-doctor/) and as Docker Image at [Docker Hub](https://hub.docker.com/r/thegeeklab/ansible-doctor).
|
||||
|
@ -14,7 +14,7 @@ docker run \
|
||||
-e PY_COLORS=1 \
|
||||
-v $(pwd):/doctor \
|
||||
-w /doctor \
|
||||
xoxys/ansible-doctor
|
||||
thegeeklab/ansible-doctor
|
||||
{{< /highlight >}}
|
||||
<!-- spellchecker-enable -->
|
||||
<!-- prettier-ignore-end -->
|
||||
|
@ -13,7 +13,7 @@ $ pip install ansible-doctor --user
|
||||
$ sudo pip install ansible-doctor
|
||||
|
||||
# From Wheel file
|
||||
$ pip install https://github.com/xoxys/ansible-doctor/releases/download/v0.1.1/ansible_doctor-0.1.1-py2.py3-none-any.whl
|
||||
$ pip install https://github.com/thegeeklab/ansible-doctor/releases/download/v0.1.1/ansible_doctor-0.1.1-py2.py3-none-any.whl
|
||||
{{< /highlight >}}
|
||||
<!-- spellchecker-enable -->
|
||||
<!-- markdownlint-restore -->
|
||||
|
@ -1,10 +1,10 @@
|
||||
---
|
||||
more:
|
||||
- name: Releases
|
||||
ref: "https://github.com/xoxys/ansible-doctor/releases"
|
||||
ref: "https://github.com/thegeeklab/ansible-doctor/releases"
|
||||
external: true
|
||||
icon: "download"
|
||||
- name: "View Source"
|
||||
ref: "https://github.com/xoxys/ansible-doctor"
|
||||
ref: "https://github.com/thegeeklab/ansible-doctor"
|
||||
external: true
|
||||
icon: "github"
|
||||
|
@ -1,7 +1,7 @@
|
||||
# demo-role-custom-header
|
||||
|
||||
[![Build Status](https://cloud.drone.io/api/badges/xoxys/ansible-doctor/status.svg)](https://cloud.drone.io/xoxys/ansible-doctor)
|
||||
![License](https://img.shields.io/github/license/xoxys/ansible-doctor)
|
||||
[![Build Status](https://cloud.drone.io/api/badges/thegeeklab/ansible-doctor/status.svg)](https://cloud.drone.io/thegeeklab/ansible-doctor)
|
||||
![License](https://img.shields.io/github/license/thegeeklab/ansible-doctor)
|
||||
|
||||
Role to demonstrate ansible-doctor. It is also possible to overwrite the default description with an annotation.
|
||||
|
||||
|
@ -1,4 +1,4 @@
|
||||
# demo-role-custom-header
|
||||
|
||||
[![Build Status](https://cloud.drone.io/api/badges/xoxys/ansible-doctor/status.svg)](https://cloud.drone.io/xoxys/ansible-doctor)
|
||||
![License](https://img.shields.io/github/license/xoxys/ansible-doctor)
|
||||
[![Build Status](https://cloud.drone.io/api/badges/thegeeklab/ansible-doctor/status.svg)](https://cloud.drone.io/thegeeklab/ansible-doctor)
|
||||
![License](https://img.shields.io/github/license/thegeeklab/ansible-doctor)
|
||||
|
Loading…
Reference in New Issue
Block a user