Skip to content

Commit

Permalink
CI: Move the documentation check to a separate job
Browse files Browse the repository at this point in the history
  • Loading branch information
lslezak committed Aug 9, 2023
1 parent e9bff87 commit a6cfbdb
Show file tree
Hide file tree
Showing 2 changed files with 67 additions and 38 deletions.
67 changes: 67 additions & 0 deletions .github/workflows/ci-yardoc.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
name: "CI - Documentation Check"

on:
push:
paths:
# NOTE: GitHub Actions do not allow using YAML references, the same path
# list is used below for the pull request event. Keep both lists in sync!!

# this file as well
- .github/workflows/ci-yardoc.yml
# all Ruby files
- service/Gemfile*
- service/*.gemspec
- service/**.rb
# the D-Bus introspection files
- doc/dbus/**.xml

pull_request:
paths:
# NOTE: GitHub Actions do not allow using YAML references, the same path
# list is used above for the push event. Keep both lists in sync!!

# this file as well
- .github/workflows/ci-yardoc.yml
# all Ruby files
- service/Gemfile*
- service/*.gemspec
- service/**.rb
# the D-Bus introspection files
- doc/dbus/**.xml

jobs:
ruby_doc:
runs-on: ubuntu-latest

defaults:
run:
working-directory: ./service

strategy:
fail-fast: false
matrix:
distro: [ "tumbleweed" ]

container:
image: registry.opensuse.org/yast/head/containers_${{matrix.distro}}/yast-ruby

steps:

- name: Configure and refresh repositories
# disable unused repositories to have faster refresh
run: zypper modifyrepo -d repo-non-oss repo-openh264 repo-update && zypper ref

- name: Install Ruby development files and XML tooling
run: zypper --non-interactive install git gcc gcc-c++ make openssl-devel ruby-devel augeas-devel xmlstarlet

- name: Git Checkout
uses: actions/checkout@v3

- name: Install RubyGems dependencies
run: bundle config set --local with 'development' && bundle install && bundle info yardoc

- name: Generate doc
run: bundle exec yardoc --fail-on-warning

- name: Check that introspected API and its docs have not diverged
run: make -C ../doc check
38 changes: 0 additions & 38 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -98,44 +98,6 @@ jobs:
flag-name: backend
parallel: true

ruby_doc:
runs-on: ubuntu-latest
env:
COVERAGE: 1

defaults:
run:
working-directory: ./service

strategy:
fail-fast: false
matrix:
distro: [ "tumbleweed" ]

container:
image: registry.opensuse.org/yast/head/containers_${{matrix.distro}}/yast-ruby

steps:

- name: Git Checkout
uses: actions/checkout@v3

- name: Configure and refresh repositories
# disable unused repositories to have faster refresh
run: zypper modifyrepo -d repo-non-oss repo-openh264 repo-update && ( zypper ref || zypper ref || zypper ref )

- name: Install Ruby development files and XML tooling
run: zypper --non-interactive install gcc gcc-c++ make openssl-devel ruby-devel npm augeas-devel xmlstarlet

- name: Install RubyGems dependencies
run: bundle config set --local with 'development' && bundle install

- name: Generate doc
run: bundle exec yardoc --fail-on-warning

- name: Check that introspected API and its docs have not diverged
run: make -C ../doc check

rust_ci:
runs-on: ubuntu-latest
env:
Expand Down

0 comments on commit a6cfbdb

Please sign in to comment.