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

feat: Change catalog to produce asciidoc #537

Merged
merged 3 commits into from
Jul 24, 2023
Merged

Conversation

bjchambers
Copy link
Collaborator

No description provided.

@bjchambers bjchambers requested a review from therapon July 19, 2023 23:54
@cla-bot cla-bot bot added the cla-signed Set when all authors of a PR have signed our CLA label Jul 19, 2023
@github-actions github-actions bot added enhancement New feature or request sparrow labels Jul 19, 2023
@bjchambers
Copy link
Collaborator Author

This is part of #352. This produces separate AsciiDoc pages for each catalog entry. Let's discuss steps for connecting it. I think I see:

  1. Run the existing binary built in the main CI to produce a zip that we archive. We can then use https://gitlab.com/antora/antora-collector-extension to download the zip and extract it. This potentially has issues with versioning.
  2. Use https://gitlab.com/antora/antora-collector-extension with a script that builds the catalog binary and uses it. This will currently be slow. We could improve it by creating a version of the catalog binary that doesn't include sparrow (eg., a "generate-only" binary). That would have far fewer dependencies and be much faster to build.
  3. Some other approach, possibly having the binary push the generated stuff to a separate "kaskada-catalog" repo, keeping a main branch in sync, as well as tagged branches for each release.

One benefit of that last option is that it makes it possible to manually edit old catalogs.

@bjchambers bjchambers added this pull request to the merge queue Jul 24, 2023
Merged via the queue into main with commit 968dbc6 Jul 24, 2023
32 checks passed
@bjchambers bjchambers deleted the ben/asciidoc-catalog branch July 24, 2023 23:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cla-signed Set when all authors of a PR have signed our CLA enhancement New feature or request sparrow
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants