Skip to content

Comments

Fail docs build on AsciiDoc warnings#1572

Merged
tomazfernandes merged 1 commit intoawspring:mainfrom
tomazfernandes:GH-1571
Feb 4, 2026
Merged

Fail docs build on AsciiDoc warnings#1572
tomazfernandes merged 1 commit intoawspring:mainfrom
tomazfernandes:GH-1571

Conversation

@tomazfernandes
Copy link
Contributor

What

  • Configure asciidoctor-maven-plugin to treat warnings as errors (for example, unterminated blocks)
  • Fix duplicate section ID warning in kinesis-stream-binder.adoc
  • Convert "encryption types" in s3.adoc from a numbered list to subsections to avoid list-continuity warnings

Why

  • This prevents formatting regressions from being merged by failing the docs build on warnings.

Fixes #1571

Note: the first build is expected to fail until #1570 is merged.

@github-actions github-actions bot added the type: documentation Documentation or Samples related issue label Feb 3, 2026
@github-actions github-actions bot added the type: maintenance Repository maintenance not affecting production files label Feb 3, 2026
@tomazfernandes tomazfernandes force-pushed the GH-1571 branch 5 times, most recently from e42545f to 1c57e2f Compare February 3, 2026 03:04
@tomazfernandes
Copy link
Contributor Author

CI failed with the expected error in the Validate Docs task:

https://github.com/awspring/spring-cloud-aws/actions/runs/21615244279/job/62292443937?pr=1572
Error: asciidoctor: WARN: sqs.adoc: line 2521: unterminated listing block

Screenshot 2026-02-03 at 00 13 12

@tomazfernandes tomazfernandes mentioned this pull request Feb 3, 2026
9 tasks
- Configure asciidoctor-maven-plugin to treat warnings as errors (for example, unterminated blocks)
- Add docs validation job to CI workflow
- Fix duplicate section ID warning in kinesis-stream-binder.adoc
- Restructure the "encryption types" section in s3.adoc to avoid list-continuity warnings

Fixes awspring#1571
@tomazfernandes
Copy link
Contributor Author

tomazfernandes commented Feb 3, 2026

After a rebase from main with the merged fix from #1570, docs build passes as expected:
https://github.com/awspring/spring-cloud-aws/actions/runs/21615730551/job/62293965720?pr=1572

Screenshot 2026-02-03 at 00 34 48

@tomazfernandes tomazfernandes merged commit 9280d38 into awspring:main Feb 4, 2026
6 checks passed
@tomazfernandes tomazfernandes deleted the GH-1571 branch February 4, 2026 23:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

type: documentation Documentation or Samples related issue type: maintenance Repository maintenance not affecting production files

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Fail docs build on warnings

2 participants