docs: DOC-752 copies changelog on docs build and adds to sidebar menu#1345
docs: DOC-752 copies changelog on docs build and adds to sidebar menu#1345
Conversation
Downside of this approach is it will be broken in local render.
|
ui docs preview (Available for 14 days) |
…te was never actually used. Further, change the template to correct whitespace in output, and add PR links. We did this because the default template outputs some html for breaking changes which was invalid JSX, which how I discovered it wasn't using the template at all. Finally added a script that can regen the changelog, to fix all the old changelog entries.
|
ui docs preview (Available for 14 days) |
|
plotly-express docs preview (Available for 14 days) |
dsmmcken
changed the title
dsmmcken
changed the title
| f"cp -r docs/_assets {BUILT_DOCS}/_assets", | ||
| f"[ -d docs/snapshots ] && cp -r docs/snapshots {BUILT_DOCS}/snapshots", | ||
| f"cp docs/sidebar.json {BUILT_DOCS}/sidebar.json", | ||
| f"[ -f CHANGELOG.md ] && cp CHANGELOG.md {BUILT_DOCS}/changelog.md || true", |
There was a problem hiding this comment.
I think you can make this work with local preview (if you wanted) by adding a symlink for the changelog in the docs/src. Not sure if that would break the build, but since you're copying the src file it should be fine?
There was a problem hiding this comment.
But if one were to run the docs build step locally, it would then overwrite it and someone could then commit that instead, I guess unless the symlink was created then gitignored? You think that's worth doing vs just 404 locally?
There was a problem hiding this comment.
Ehh probably not. As long as everything else still works, I don't really see much reason to need to view the changelog locally.
I don't think running the build would change anything. If the local is running from docs src (I don't remember) then you would just symlink docs/src/changelog to changelog further up. This build step is copying from the root which I think would override the initial "build" of the symlink
| #!/usr/bin/env bash | ||
| # Regenerate plugins/<package>/CHANGELOG.md from scratch by replaying every |
There was a problem hiding this comment.
Is this file needed? We shouldn't need to regenerate it again, right?
There was a problem hiding this comment.
No, probably not, but I figured I would leave it in case we ever needed to generate it locally or something.
| { username = "jnumainville", signature = "Joe Numainville" }, | ||
| { username = "jnumainville", signature = "Joe" }, | ||
| { username = "mofojed", signature = "Mike Bender" }, | ||
| { username = "mofojed", signature = "mikebender" }, | ||
| { username = "devinrsmith", signature = "Devin Smith" }, | ||
| { username = "mattrunyon", signature = "Matt Runyon" }, | ||
| { username = "mattrunyon", signature = "Matthew Runyon" }, | ||
| { username = "vbabich", signature = "Vlad Babich" }, | ||
| { username = "dsmmcken", signature = "Don" }, |
There was a problem hiding this comment.
Several authors had duplicated entries with a different display name (signature)
There was a problem hiding this comment.
🤷 several authors have committed to the repo with different git.config names. These are ones Claude discovered.
mofojed
left a comment
mofojed
left a comment
There was a problem hiding this comment.
LGTM
You'll need to resolve the conflicts with the changelog because I just published another deephaven.ui version
# Conflicts: # plugins/ui/CHANGELOG.md
|
ui docs preview (Available for 14 days) |
|
plotly-express docs preview (Available for 14 days) |
3 participants
Copies the changelog during sphinx build step into the docs for publishing. Adds it to the sidebar. Downside of this approach is that page 404s in local render, but this seems like the easiest way to implement.
During this change I discovered our cog template wasn't actually being used. The default template had some invalid JSX in the form of html style="" spans around the word breaking. When I went to remove that I discovered our template wasn't actually being used at all.
cog bump --packagechangelog uses thepackage_templatewhich was unset, so our template was never actually used. I made additional changes to the template to correct whitespace in output, and add PR links, and adjust the output heading.Finally, I added a script that can regen the changelog, to back fix all the old changelog entries.