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

Bug: fix beautify script #130

Merged
merged 3 commits into from
Jul 25, 2023
Merged

Bug: fix beautify script #130

merged 3 commits into from
Jul 25, 2023

Conversation

internetisaiah
Copy link
Contributor

@internetisaiah internetisaiah commented Jul 25, 2023

Summary

The beautify-logs.py script was slicing Antora's "pretty" logs with the assumption it knew where the maintainer was storing the git repository, so the links in the File column were breaking for some users.

The following changes have been made:

  1. Antora playbooks now output logs in JSON format. This makes string slicing easier/more accurate.
  2. The beautify script now creates the links in the File column by removing the text in "workspace": from "file":, then adds AsciiDoc xref syntax.

For example:

  • File key: `"file":{"path":"/Users/isaiah-robinson/docs/docs/modules/automation-testing/pages/index.adoc"}
  • Worktree key: "worktree":"/Users/isaiah-robinson/docs"
  • After slice: /docs/modules/automation-testing/pages/index.adoc
  • With AsciiDoc syntax: xref:../docs/modules/automation-testing/pages/index.adoc[index.adoc]

Related PRs, issues, or features (optional)

  • N/A

Metadata

  • Adds new file(s)
  • Edits existing file(s)
  • Removes file(s)

PR contributor checklist

@internetisaiah internetisaiah marked this pull request as ready for review July 25, 2023 17:08
@internetisaiah internetisaiah self-assigned this Jul 25, 2023
@internetisaiah internetisaiah merged commit 4394f99 into main Jul 25, 2023
2 checks passed
@internetisaiah internetisaiah deleted the update-beautify-script branch July 25, 2023 17:53
@internetisaiah internetisaiah removed their assignment Oct 16, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant