diff options
| author | Nobuyoshi Nakada <nobu@ruby-lang.org> | 2026-02-03 15:07:48 +0900 |
|---|---|---|
| committer | Nobuyoshi Nakada <nobu@ruby-lang.org> | 2026-02-06 16:26:30 +0900 |
| commit | fa9e63ada9c5e3ede4cf7eca15de5b5967247df7 (patch) | |
| tree | 6c66a8e6967a27a7acfc249325a399fbfffe80e3 | |
| parent | 08652f825410d0690831151decd2d84ea207f976 (diff) | |
[DOC] Run make for rdoc-coverage and generating html
| -rw-r--r-- | .github/workflows/check_misc.yml | 16 | ||||
| -rw-r--r-- | common.mk | 9 |
2 files changed, 17 insertions, 8 deletions
diff --git a/.github/workflows/check_misc.yml b/.github/workflows/check_misc.yml index 35bad2724e..ac74ae1daa 100644 --- a/.github/workflows/check_misc.yml +++ b/.github/workflows/check_misc.yml @@ -28,6 +28,15 @@ jobs: # Skip overwriting MATZBOT_AUTO_UPDATE_TOKEN checkout: '' # false (ref: https://github.com/actions/runner/issues/2238) + - name: Re-generate Makefiles + run: | + # config.status needs to run as a shell script + { echo ':&&exit'; cat tool/prereq.status; } > config.status + : # same as actions/setup/directories/action.yml + for mk in Makefile GNUmakefile; do + sed -f tool/prereq.status template/$mk.in > $mk + done + - name: Check for code styles run: | set -x @@ -74,7 +83,6 @@ jobs: run: | set -- $(sed 's/#.*//;/^rdoc /!d' gems/bundled_gems) { echo version=$2; echo ref=$4; } >> $GITHUB_OUTPUT - echo RDOC='ruby -W0 --disable-gems tool/rdoc-srcdir -q' >> $GITHUB_ENV - name: Checkout rdoc uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 @@ -84,7 +92,7 @@ jobs: path: .bundle/gems/rdoc-${{ steps.rdoc.outputs.version }} if: ${{ steps.rdoc.outputs.ref != '' }} - - name: Generate rdoc + - name: Generate rdoc scripts run: | set -x gempath=$(ruby -e 'print Gem.user_dir, "/bin"') @@ -98,12 +106,12 @@ jobs: - name: Core docs coverage run: | - $RDOC -C -x ^ext -x ^lib . + make XRUBY=ruby RDOC_DEPENDS= RBCONFIG=update-rbconfig rdoc-coverage - name: Generate docs id: docs run: | - $RDOC --op html . + make XRUBY=ruby RDOC_DEPENDS= RBCONFIG=update-rbconfig html echo htmlout=ruby-html-${GITHUB_SHA:0:10} >> $GITHUB_OUTPUT # Generate only when document commit/PR if: >- @@ -608,11 +608,12 @@ post-install-dbg:: srcs-doc: prepare-gems -rdoc: PHONY main srcs-doc +RDOC_DEPENDS = main srcs-doc +rdoc: PHONY $(RDOC_DEPENDS) $(RBCONFIG) @echo Generating RDoc documentation $(Q) $(RDOC) --ri --op "$(RDOCOUT)" $(RDOC_GEN_OPTS) $(RDOCFLAGS) . -html: PHONY main srcs-doc +html: PHONY $(RDOC_DEPENDS) $(RBCONFIG) @echo Generating RDoc HTML files $(Q) $(RDOC) --op "$(HTMLOUT)" $(RDOC_GEN_OPTS) $(RDOCFLAGS) . @@ -620,11 +621,11 @@ RDOC_COVERAGE_EXCLUDES = -x ^ext/json -x ^ext/openssl -x ^ext/psych \ -x ^lib/bundler -x ^lib/rubygems \ -x ^lib/did_you_mean -x ^lib/error_highlight -x ^lib/syntax_suggest -rdoc-coverage: PHONY main srcs-doc +rdoc-coverage: PHONY $(RDOC_DEPENDS) $(RBCONFIG) @echo Generating RDoc coverage report $(Q) $(RDOC) --quiet -C $(RDOCFLAGS) $(RDOC_COVERAGE_EXCLUDES) . -undocumented: PHONY main srcs-doc +undocumented: PHONY $(RDOC_DEPENDS) $(RBCONFIG) $(Q) $(RDOC) --quiet -C $(RDOCFLAGS) $(RDOC_COVERAGE_EXCLUDES) . | \ sed -n \ -e '/^ *# in file /{' -e 's///;N;s/\n/: /p' -e '}' \ |