devfile.yaml

---
#
# Copyright (c) 2021-2022 Red Hat, Inc.
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
# Project definition.
#
apiVersion: 1.0.0
metadata:
  generateName: antora-docs-

components:
  - alias: antora-docs
    type: dockerimage
    image: "quay.io/eclipse/che-docs:latest"
    memoryLimit: 512M
    mountSources: true
    command:
      - tail
    args:
      - "-f"
      - /dev/null
    endpoints:
      - name: Open-Livereload
        port: 35729
      - name: Open-Preview-server
        port: 4000
        attributes:
          path: /docs/end-user-guide/introduction/
  - alias: vale
    type: chePlugin
    preferences:
      vale.core.useCLI: true
    reference: https://che-plugin-registry-main.surge.sh/v3/plugins/errata-ai/vale-server/latest/meta.yaml
  - alias: github
    type: chePlugin
    id: ms-vscode/vscode-github-pullrequest/latest
  - alias: asciidoctor
    type: chePlugin
    reference: https://che-plugin-registry-main.surge.sh/v3/plugins/joaompinto/asciidoctor-vscode/latest/meta.yaml
  - alias: shellcheck
    type: chePlugin
    reference: https://che-plugin-registry-main.surge.sh/v3/plugins/timonwong/shellcheck/latest/meta.yaml
  - alias: yaml
    type: chePlugin
    id: redhat/vscode-yaml/latest

commands:
  - name: Start preview server
    actions:
      - type: exec
        component: che-docs
        workdir: /projects/antora-docs
        command: sh tools/preview.sh
  - name: Validate links
    actions:
      - type: exec
        component: che-docs
        workdir: /projects/antora-docs
        command: htmltest