refactor docs

2020-01-22 22:08:44 +01:00 · 2020-01-22 22:08:44 +01:00 · 3224385ee0
commit 3224385ee0
parent 5317fe9a0d
3 changed files with 166 additions and 146 deletions
--- a/.drone.jsonnet
+++ b/.drone.jsonnet
@ -1,141 +1,155 @@
 local PipelineLinting = {
-    kind: "pipeline",
-    name: "linting",
+  kind: 'pipeline',
+  name: 'linting',
  platform: {
-        os: "linux",
-        arch: "amd64",
+    os: 'linux',
+    arch: 'amd64',
  },
  steps: [
    {
-            name: "ansible-later",
-            image: "xoxys/ansible-later:latest",
+      name: 'ansible-later',
+      image: 'xoxys/ansible-later:latest',
      commands: [
-                "ansible-later",
+        'ansible-later',
      ],
    },
  ],
  trigger: {
-        ref: ["refs/heads/master", "refs/tags/**", "refs/pull/**"],
+    ref: ['refs/heads/master', 'refs/tags/**', 'refs/pull/**'],
  },
 };

-local PipelineDeployment = {
-    kind: "pipeline",
-    name: "deployment",
+local PipelineDeployment(scenario='centos7') = {
+  kind: 'pipeline',
+  name: 'testing-' + scenario,
  platform: {
-        os: "linux",
-        arch: "amd64",
+    os: 'linux',
+    arch: 'amd64',
  },
  concurrency: {
-        limit: 1
+    limit: 1,
  },
  workspace: {
-        base: "/drone/src",
-        path: "xoxys.postfix_relay"
+    base: '/drone/src',
+    path: 'xoxys.postfix_relay',
  },
  steps: [
    {
-            name: "ansible-molecule",
-            image: "xoxys/molecule:latest",
+      name: 'ansible-molecule',
+      image: 'xoxys/molecule:latest',
      environment: {
-                DO_API_KEY: { "from_secret": "do_api_key" },
-                USER: "root",
-                MOLECULE_CUSTOM_MODULES_REPO: "https://gitea.rknet.org/ansible/custom_modules",
-                MOLECULE_CUSTOM_FILTERS_REPO: "https://gitea.rknet.org/ansible/custom_filters",
+        DO_API_KEY: { from_secret: 'do_api_key' },
+        USER: 'root',
+        MOLECULE_CUSTOM_MODULES_REPO: 'https://gitea.rknet.org/ansible/custom_modules',
+        MOLECULE_CUSTOM_FILTERS_REPO: 'https://gitea.rknet.org/ansible/custom_filters',
      },
      commands: [
-                "molecule test -s default",
+        'molecule test -s' + scenario,
      ],
    },
  ],
  depends_on: [
-        "linting",
+    'linting',
  ],
  trigger: {
-        ref: ["refs/heads/master", "refs/tags/**"],
+    ref: ['refs/heads/master', 'refs/tags/**'],
  },
 };

 local PipelineDocumentation = {
-    kind: "pipeline",
-    name: "documentation",
+  kind: 'pipeline',
+  name: 'documentation',
  platform: {
-        os: "linux",
-        arch: "amd64",
+    os: 'linux',
+    arch: 'amd64',
  },
  steps: [
    {
-            name: "ansible-doctor",
-            image: "xoxys/ansible-doctor:latest",
+      name: 'generate',
+      image: 'xoxys/ansible-doctor:latest',
      environment: {
-                ANSIBLE_DOCTOR_LOG_LEVEL: "INFO",
+        ANSIBLE_DOCTOR_LOG_LEVEL: 'INFO',
        ANSIBLE_DOCTOR_FORCE_OVERWRITE: true,
-                ANSIBLE_DOCTOR_EXCLUDE_FILES: "molecule/",
-                ANSIBLE_DOCTOR_CUSTOM_HEADER: "HEADER.md",
+        ANSIBLE_DOCTOR_EXCLUDE_FILES: 'molecule/',
+        ANSIBLE_DOCTOR_TEMPLATE: 'hugo-book',
+        ANSIBLE_DOCTOR_ROLE_NAME: '${DRONE_REPO_NAME#*.}',
+        ANSIBLE_DOCTOR_OUTPUT_DIR: '_docs/',
      },
    },
    {
-            name: "push-to-repo",
-            image: "plugins/git-action:latest",
+      name: 'publish',
+      image: 'plugins/gh-pages:latest',
      settings: {
-                actions: ["commit", "push"],
-                author_email: "shipper@rknet.org",
-                author_name: "DroneShipper",
-                branch: "master",
-                message: "[SKIP CI] update readme",
-                remote: "https://gitea.rknet.org/ansible/xoxys.postfix_relay",
-                netrc_machine: "gitea.rknet.org",
-                netrc_username: {"from_secret": "gitea_username"},
-                netrc_password: {"from_secret": "gitea_token"},
+        remote_url: 'https://gitea.rknet.org/ansible/xoxys.postfix_relay',
+        netrc_machine: 'gitea.rknet.org',
+        username: { from_secret: 'gitea_username' },
+        password: { from_secret: 'gitea_token' },
+        pages_directory: '_docs/',
+        target_branch: 'docs',
      },
      when: {
-                ref: ["refs/heads/master"],
+        ref: ['refs/heads/master'],
      },
    },
+    {
+      name: 'trigger',
+      image: 'plugins/downstream',
+      settings: {
+        server: 'https://drone.rknet.org',
+        token: { from_secret: 'drone_token' },
+        fork: true,
+        repositories: [
+          'ansible/ansible-galaxy',
        ],
-    depends_on: [
-        "deployment",
+      },
+      when: {
+        ref: ['refs/heads/master'],
+      },
+    },
  ],
  trigger: {
-        ref: ["refs/heads/master", "refs/tags/**", "refs/pull/**"],
+    ref: ['refs/heads/master', 'refs/tags/**', 'refs/pull/**'],
  },
+  depends_on: [
+    'testing-centos7',
+  ],
 };

 local PipelineNotification = {
-    kind: "pipeline",
-    name: "notification",
+  kind: 'pipeline',
+  name: 'notification',
  platform: {
-        os: "linux",
-        arch: "amd64",
+    os: 'linux',
+    arch: 'amd64',
  },
  clone: {
    disable: true,
  },
  steps: [
    {
-            name: "matrix",
-            image: "plugins/matrix",
+      name: 'matrix',
+      image: 'plugins/matrix',
      settings: {
-                homeserver: { "from_secret": "matrix_homeserver" },
-                roomid: { "from_secret": "matrix_roomid" },
-                template: "Status: **{{ build.status }}**<br/> Build: [{{ repo.Owner }}/{{ repo.Name }}]({{ build.link }}) ({{ build.branch }}) by {{ build.author }}<br/> Message: {{ build.message }}",
-                username: { "from_secret": "matrix_username" },
-                password: { "from_secret": "matrix_password" },
+        homeserver: { from_secret: 'matrix_homeserver' },
+        roomid: { from_secret: 'matrix_roomid' },
+        template: 'Status: **{{ build.status }}**<br/> Build: [{{ repo.Owner }}/{{ repo.Name }}]({{ build.link }}) ({{ build.branch }}) by {{ build.author }}<br/> Message: {{ build.message }}',
+        username: { from_secret: 'matrix_username' },
+        password: { from_secret: 'matrix_password' },
      },
    },
  ],
  depends_on: [
-        "documentation",
+    'documentation',
  ],
  trigger: {
-        status: [ "success", "failure" ],
-        ref: ["refs/heads/master", "refs/tags/**"],
+    status: ['success', 'failure'],
+    ref: ['refs/heads/master', 'refs/tags/**'],
  },
 };

 [
  PipelineLinting,
-    PipelineDeployment,
+  PipelineDeployment(scenario='centos7'),
  PipelineDocumentation,
  PipelineNotification,
 ]
--- a/.drone.yml
+++ b/.drone.yml
@ -20,7 +20,7 @@ trigger:

 ---
 kind: pipeline
-name: deployment
+name: testing-centos7

 platform:
  os: linux
@ -37,7 +37,7 @@ steps:
 - name: ansible-molecule
  image: xoxys/molecule:latest
  commands:
-  - molecule test -s default
+  - molecule test -scentos7
  environment:
    DO_API_KEY:
      from_secret: do_api_key
@ -62,30 +62,40 @@ platform:
  arch: amd64

 steps:
- name: ansible-doctor
+- name: generate
  image: xoxys/ansible-doctor:latest
  environment:
-    ANSIBLE_DOCTOR_CUSTOM_HEADER: HEADER.md
    ANSIBLE_DOCTOR_EXCLUDE_FILES: molecule/
    ANSIBLE_DOCTOR_FORCE_OVERWRITE: true
    ANSIBLE_DOCTOR_LOG_LEVEL: INFO
+    ANSIBLE_DOCTOR_OUTPUT_DIR: _docs/
+    ANSIBLE_DOCTOR_ROLE_NAME: ${DRONE_REPO_NAME#*.}
+    ANSIBLE_DOCTOR_TEMPLATE: hugo-book

- name: push-to-repo
-  image: plugins/git-action:latest
+- name: publish
+  image: plugins/gh-pages:latest
  settings:
-    actions:
-    - commit
-    - push
-    author_email: shipper@rknet.org
-    author_name: DroneShipper
-    branch: master
-    message: "[SKIP CI] update readme"
    netrc_machine: gitea.rknet.org
-    netrc_password:
+    pages_directory: _docs/
+    password:
      from_secret: gitea_token
-    netrc_username:
+    remote_url: https://gitea.rknet.org/ansible/xoxys.postfix_relay
+    target_branch: docs
+    username:
      from_secret: gitea_username
-    remote: https://gitea.rknet.org/ansible/xoxys.postfix_relay
+  when:
+    ref:
+    - refs/heads/master
+
+- name: trigger
+  image: plugins/downstream
+  settings:
+    fork: true
+    repositories:
+    - ansible/ansible-galaxy
+    server: https://drone.rknet.org
+    token:
+      from_secret: drone_token
  when:
    ref:
    - refs/heads/master
@ -97,7 +107,7 @@ trigger:
  - refs/pull/**

 depends_on:
- deployment
+- testing-centos7

 ---
 kind: pipeline
@ -137,6 +147,6 @@ depends_on:

 ---
 kind: signature
-hmac: 1342461b82f2a888e77c138777f8eeffbb2fec5f2454e94d9071c28e8ab76772
+hmac: 57a7c9ad4e5895afaa61a15ed89c08252c7e6f2d370b245380f68fb6dc46dfc6

 ...
--- a/HEADER.md
+++ b/HEADER.md
@ -1,4 +0,0 @@
-# xoxys.postfix_relay
-  
-[![Build Status](https://drone.rknet.org/api/badges/ansible/xoxys.postfix_relay/status.svg)](https://drone.rknet.org/ansible/xoxys.postfix_relay)
-