openproject/.github/workflows/docs.yaml at dev · COSM-Lab/openproject · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
name: "Docs"

on:
  pull_request:
    branches:
      - dev
      - release/*
    paths:
      - 'docs/**'
      - 'config/static_links.yml'

permissions:
  contents: read

jobs:
  docs-links-check:
    name: Check internal links in documentation
    runs-on: [ubuntu-latest]
    steps:
      - uses: actions/checkout@v5
      - uses: ruby/setup-ruby@v1
        with:
          bundler-cache: true
      - run: bundle exec ./script/docs/check_links
  docs-readme-case-check:
    name: Check README.md case in documentation
    runs-on: [ubuntu-latest]
    steps:
      - uses: actions/checkout@v5
      - run: script/docs/check_readme_case
  docs-readme-yaml-header-syntax-check:
    name: Check README.md YAML header syntax in documentation
    runs-on: [ubuntu-latest]
    steps:
      - uses: actions/checkout@v5
      - uses: ruby/setup-ruby@v1
        with:
          bundler-cache: true
      - run: script/docs/check_readme_yaml_header_syntax