spring-projects / spring-projects/spring-boot

Force specific hash when building a single docs branch

Open
#51,605 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

status: team-only type: task
Dominant language
Java
Stars
81.5k
Forks
42.7k
Avg merge
2d 4h
Merged PRs (30d)
65

Description

We tried this in #44204 but it doesn't seem to work.

The docs build was triggered for main and tried to reset to 57b44b05949404015d5935899cfd827665fdb093. Antora failed due to these warnings:

[09:05:32.609] WARN (asciidoctor): configuration property not found: server.tomcat.servlet.use-relative-redirects
    file: documentation/spring-boot-docs/src/docs/antora/modules/how-to/pages/webserver.adoc:565
    source: /home/runner/work/spring-boot/spring-boot/.git (branch: main | start path: documentation/spring-boot-docs/src/docs/antora)
[09:05:32.610] WARN (asciidoctor): configuration property not found: server.tomcat.servlet.redirect-context-root
    file: documentation/spring-boot-docs/src/docs/antora/modules/how-to/pages/webserver.adoc:565
    source: /home/runner/work/spring-boot/spring-boot/.git (branch: main | start path: documentation/spring-boot-docs/src/docs/antora)

The references to server.tomcat.servlet.use-relative-redirects and server.tomcat.servlet.redirect-context-root were not added until f50c8311b90b57e350e64f233c6a2daa72544a7c so it would appear that reseting to 57b44b05949404015d5935899cfd827665fdb093 did not work.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing issue #44204 and the two linked GitHub Actions runs to understand how the single-branch docs build selects its revision. Inspect the docs build configuration and the checkout/reset step, then verify that building at 57b44b05949404015d5935899cfd827665fdb093 does not read the later references from webserver.adoc:565.

Written by the indexing model from the issue text.

Assessment

Tech stack
git, github-actions
Domain
ci-cd, documentation
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Active
Clarity
Mostly clear
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.