Skip to content

Commit fa9e63a

Browse files
committed
[DOC] Run make for rdoc-coverage and generating html
1 parent 08652f8 commit fa9e63a

File tree

2 files changed

+17
-8
lines changed

2 files changed

+17
-8
lines changed

.github/workflows/check_misc.yml

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,15 @@ jobs:
2828
# Skip overwriting MATZBOT_AUTO_UPDATE_TOKEN
2929
checkout: '' # false (ref: https://github.com/actions/runner/issues/2238)
3030

31+
- name: Re-generate Makefiles
32+
run: |
33+
# config.status needs to run as a shell script
34+
{ echo ':&&exit'; cat tool/prereq.status; } > config.status
35+
: # same as actions/setup/directories/action.yml
36+
for mk in Makefile GNUmakefile; do
37+
sed -f tool/prereq.status template/$mk.in > $mk
38+
done
39+
3140
- name: Check for code styles
3241
run: |
3342
set -x
@@ -74,7 +83,6 @@ jobs:
7483
run: |
7584
set -- $(sed 's/#.*//;/^rdoc /!d' gems/bundled_gems)
7685
{ echo version=$2; echo ref=$4; } >> $GITHUB_OUTPUT
77-
echo RDOC='ruby -W0 --disable-gems tool/rdoc-srcdir -q' >> $GITHUB_ENV
7886
7987
- name: Checkout rdoc
8088
uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
@@ -84,7 +92,7 @@ jobs:
8492
path: .bundle/gems/rdoc-${{ steps.rdoc.outputs.version }}
8593
if: ${{ steps.rdoc.outputs.ref != '' }}
8694

87-
- name: Generate rdoc
95+
- name: Generate rdoc scripts
8896
run: |
8997
set -x
9098
gempath=$(ruby -e 'print Gem.user_dir, "/bin"')
@@ -98,12 +106,12 @@ jobs:
98106

99107
- name: Core docs coverage
100108
run: |
101-
$RDOC -C -x ^ext -x ^lib .
109+
make XRUBY=ruby RDOC_DEPENDS= RBCONFIG=update-rbconfig rdoc-coverage
102110
103111
- name: Generate docs
104112
id: docs
105113
run: |
106-
$RDOC --op html .
114+
make XRUBY=ruby RDOC_DEPENDS= RBCONFIG=update-rbconfig html
107115
echo htmlout=ruby-html-${GITHUB_SHA:0:10} >> $GITHUB_OUTPUT
108116
# Generate only when document commit/PR
109117
if: >-

common.mk

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -608,23 +608,24 @@ post-install-dbg::
608608

609609
srcs-doc: prepare-gems
610610

611-
rdoc: PHONY main srcs-doc
611+
RDOC_DEPENDS = main srcs-doc
612+
rdoc: PHONY $(RDOC_DEPENDS) $(RBCONFIG)
612613
@echo Generating RDoc documentation
613614
$(Q) $(RDOC) --ri --op "$(RDOCOUT)" $(RDOC_GEN_OPTS) $(RDOCFLAGS) .
614615

615-
html: PHONY main srcs-doc
616+
html: PHONY $(RDOC_DEPENDS) $(RBCONFIG)
616617
@echo Generating RDoc HTML files
617618
$(Q) $(RDOC) --op "$(HTMLOUT)" $(RDOC_GEN_OPTS) $(RDOCFLAGS) .
618619

619620
RDOC_COVERAGE_EXCLUDES = -x ^ext/json -x ^ext/openssl -x ^ext/psych \
620621
-x ^lib/bundler -x ^lib/rubygems \
621622
-x ^lib/did_you_mean -x ^lib/error_highlight -x ^lib/syntax_suggest
622623

623-
rdoc-coverage: PHONY main srcs-doc
624+
rdoc-coverage: PHONY $(RDOC_DEPENDS) $(RBCONFIG)
624625
@echo Generating RDoc coverage report
625626
$(Q) $(RDOC) --quiet -C $(RDOCFLAGS) $(RDOC_COVERAGE_EXCLUDES) .
626627

627-
undocumented: PHONY main srcs-doc
628+
undocumented: PHONY $(RDOC_DEPENDS) $(RBCONFIG)
628629
$(Q) $(RDOC) --quiet -C $(RDOCFLAGS) $(RDOC_COVERAGE_EXCLUDES) . | \
629630
sed -n \
630631
-e '/^ *# in file /{' -e 's///;N;s/\n/: /p' -e '}' \

0 commit comments

Comments
 (0)