github.com/oam-dev/kubevela@v1.9.11/.github/workflows/definition-lint.yml (about)

     1  name: Definition-Lint
     2  
     3  on:
     4    push:
     5      branches:
     6        - master
     7        - release-*
     8    workflow_dispatch: {}
     9    pull_request:
    10      branches:
    11        - master
    12        - release-*
    13  
    14  permissions:
    15    contents: read
    16  
    17  env:
    18    # Common versions
    19    GO_VERSION: '1.19'
    20  
    21  jobs:
    22    definition-doc:
    23      runs-on: ubuntu-22.04
    24      steps:
    25        - name: Setup Go
    26          uses: actions/setup-go@0c52d547c9bc32b1aa3301fd7a9cb496313a4491
    27          with:
    28            go-version: ${{ env.GO_VERSION }}
    29  
    30        - name: Checkout
    31          uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608
    32          with:
    33            submodules: true
    34  
    35        - name: Setup KinD
    36          run: |
    37            go install sigs.k8s.io/kind@v0.19.0
    38            kind create cluster
    39  
    40        - name: Definition Doc generate check
    41          run: |
    42            go build -o docgen hack/docgen/def/gen.go
    43            ./docgen --type=comp --force-example-doc --path=./comp-def-check.md
    44            ./docgen --type=trait --force-example-doc --path=./trait-def-check.md
    45            ./docgen --type=wf --force-example-doc --path=./wf-def-check.md --def-dir=./vela-templates/definitions/internal/workflowstep/
    46            ./docgen --type=policy --force-example-doc --path=./policy-def-check.md