Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Modernize Antora Build #32863

Closed
wants to merge 1 commit into from

Conversation

rwinch
Copy link
Member

@rwinch rwinch commented May 22, 2024

  • Use package.json so dependabot can automatically update JS dependencies
  • Use @springio/antora-extensions (automatically apply default extensions in proper order)
  • Leverage set-algolia-env-extension to manage algolia env variables
  • Update to latest ui

- Use package.json so dependabot can automatically update JS dependencies
- Use @springio/antora-extensions (automatically apply default extensions
  in proper order)
- Leverage set-algolia-env-extension to manage algolia env variables
- Update to latest ui
@spring-projects-issues spring-projects-issues added the status: waiting-for-triage An issue we've not yet triaged or decided on label May 22, 2024
@sdeleuze sdeleuze self-assigned this May 22, 2024
@sdeleuze sdeleuze added type: documentation A documentation task and removed status: waiting-for-triage An issue we've not yet triaged or decided on labels May 22, 2024
@sdeleuze
Copy link
Contributor

I am not able to merge this one due to the following error:

[10:37:39.263] FATAL (antora) <git.readBlob>: Cannot read properties of null (reading 'slice') in https://github.com/spring-projects/spring-framework (tag: v6.0.10 | start path: framework-docs)
    Cause: TypeError
        at GitPackIndex.readSlice (/Users/sdeleuze/workspace/spring-framework-branches/docs-build/node_modules/@antora/content-aggregator/node_modules/isomorphic-git/index.cjs:2974:35)
        at async readObjectPacked (/Users/sdeleuze/workspace/spring-framework-branches/docs-build/node_modules/@antora/content-aggregator/node_modules/isomorphic-git/index.cjs:3091:22)
        at async _readObject (/Users/sdeleuze/workspace/spring-framework-branches/docs-build/node_modules/@antora/content-aggregator/node_modules/isomorphic-git/index.cjs:3133:14)
        at async resolveBlob (/Users/sdeleuze/workspace/spring-framework-branches/docs-build/node_modules/@antora/content-aggregator/node_modules/isomorphic-git/index.cjs:12507:28)
        at async _readBlob (/Users/sdeleuze/workspace/spring-framework-branches/docs-build/node_modules/@antora/content-aggregator/node_modules/isomorphic-git/index.cjs:12550:16)
        at async Object.readBlob (/Users/sdeleuze/workspace/spring-framework-branches/docs-build/node_modules/@antora/content-aggregator/node_modules/isomorphic-git/index.cjs:12609:12)
        at async Promise.allSettled (index 2)
        at async Promise.allSettled (index 0)
        at async Promise.allSettled (index 2)

I am wondering if it is required I wait for our new releases with #32864 merged, and fine tune the branches in this PR to use minimum tags 6.0.21 and 6.1.8 in order to avoid such breakage.

I am also wondering if we can now remove lib/antora/templates/per-branch-antora-playbook.yml.

@sdeleuze sdeleuze added the status: waiting-for-internal-feedback An issue that needs input from a member or another Spring Team label May 22, 2024
sdeleuze pushed a commit to sdeleuze/spring-framework that referenced this pull request May 22, 2024
- Use package.json so dependabot can automatically update JS dependencies
- Use @springio/antora-extensions (automatically apply default extensions
  in proper order)
- Leverage set-algolia-env-extension to manage algolia env variables
- Update to latest ui

Closes spring-projectsgh-32863
@sdeleuze sdeleuze removed the status: waiting-for-internal-feedback An issue that needs input from a member or another Spring Team label May 22, 2024
@sdeleuze
Copy link
Contributor

Merged. The error was due to a corrupted local Antora cache. I have removed per-branch-antora-playbook.yml after discussing with Rob.

@sdeleuze sdeleuze closed this May 22, 2024
@jhoeller jhoeller added this to the 6.1.8 milestone May 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: documentation A documentation task
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants