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

Docs CI Upload Versioned Artifacts #4853

Merged
merged 37 commits into from
Nov 21, 2023

Conversation

stanbrub
Copy link
Contributor

@stanbrub stanbrub commented Nov 16, 2023

Updated Docs CI workflow to produce the following artifacts:

  • cppclient-docs-0.31.0
  • cppclient-examples-0.31.0
  • javadocs-0.31.0
  • pyclient-docs-0.31.0
  • pyserver-docs-0.31.0
  • rdoc-0.31.0
  • typedoc-0.31.0

Also, added appropriate verbiage to the RELEASE.MD.

These end up in the Summary for the Workflow and can be download/uploaded to Github release assets similar to the ones produced by the Publish CI.

@stanbrub stanbrub self-assigned this Nov 16, 2023
@stanbrub stanbrub linked an issue Nov 16, 2023 that may be closed by this pull request
@stanbrub stanbrub changed the title Docs ci version improvements Docs CI Upload Versioned Artifacts Nov 16, 2023
@stanbrub stanbrub added the NoReleaseNotesNeeded No release notes are needed. label Nov 16, 2023
.github/workflows/docs-ci.yml Outdated Show resolved Hide resolved
.github/workflows/docs-ci.yml Show resolved Hide resolved
RELEASE.md Show resolved Hide resolved
@stanbrub stanbrub requested a review from devinrsmith November 20, 2023 18:33
Copy link
Member

@devinrsmith devinrsmith left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks like you've got some conflicts w/ main...

Happy to approve this soon. The next step after this PR would be to actually publish based on release branches to named subdirectories of deephaven.io.

RELEASE.md Show resolved Hide resolved
@stanbrub stanbrub requested a review from devinrsmith November 20, 2023 23:08
niloc132 and others added 6 commits November 20, 2023 16:30
)

Replaces the annotation processor previously used with a doclet
implementation. This still emits a .d.ts file using Java
mirror/element types for accurate type information, but now is able
to traverse Javadoc trees as well, and produces corresponding
typedoc tags or markdown. The typedoc tool now generates HTML for
deployment to the Deephaven docs website.

Additionally, this branch produces a tarball suitable for deployment
as an npm module, containing only those generated types. However,
this output is still untested.
RELEASE.md Outdated Show resolved Hide resolved
RELEASE.md Show resolved Hide resolved
@stanbrub stanbrub requested a review from devinrsmith November 21, 2023 03:06
.github/workflows/docs-ci.yml Outdated Show resolved Hide resolved
.github/workflows/docs-ci.yml Show resolved Hide resolved
RELEASE.md Show resolved Hide resolved
@stanbrub stanbrub requested a review from devinrsmith November 21, 2023 20:23
@stanbrub stanbrub merged commit 2c64fb1 into deephaven:main Nov 21, 2023
12 checks passed
@stanbrub stanbrub deleted the docs-ci-version-improvements branch November 21, 2023 21:31
@github-actions github-actions bot locked and limited conversation to collaborators Nov 21, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

DocsCI Version and Upload Release Artifacts
3 participants