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.

Sign up for GitHub

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

Jump to bottom

Streamline release process for doclet #180

Closed
alicejli opened this issue May 8, 2023 · 1 comment
Closed

Streamline release process for doclet #180

alicejli opened this issue May 8, 2023 · 1 comment
Assignees
@alicejli
Labels
priority: p3 Desirable enhancement or fix. May not be included in next release. type: feature request ‘Nice-to-have’ improvement, new feature or different behavior or design.

Comments

@alicejli
Copy link
Contributor

alicejli commented May 8, 2023

Currently if a change is made to the doclet, the following steps need to happen: (slightly amended from https://g3doc.corp.google.com/devrel/cloud/infra/devrel_services/g3doc/dev/content_automation/cloud_rad/java.md?cl=head#releasing-java-docfx-doclet-updates)

  1. Make updates to doclet and create a new release with attached jar

  2. Update doc-template java golden testdata with updated doclet yaml output

  3. Upload jar with dependencies to cloud-devrel-kokoro-resources/docfx

  4. Update doclet version:
    java-shared-config
    api-common-java, gax-java, google-oauth-java-client, google-http-java-client, google-auth-library-java, google-api-java-client, java-bigtable

  5. Release java-shared-config

  6. Merge java-shared-config version bump into individual repos

  7. Release individual repos

  8. Check publish_javadoc11 kokoro jobs for success

There is already an FR to upload this doclet to Maven: googleapis/google-cloud-java#8754. Let's use this bug as a general tracker for any release improvements for this doclet.
@alicejli alicejli added type: feature request ‘Nice-to-have’ improvement, new feature or different behavior or design. priority: p3 Desirable enhancement or fix. May not be included in next release. labels May 8, 2023
@alicejli alicejli self-assigned this May 8, 2023
@alicejli
Copy link
Contributor Author

The new process is documented here: https://github.com/googleapis/java-docfx-doclet/tree/main/third_party/docfx-doclet-143274#release-guide

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@alicejli alicejli

Labels
priority: p3 Desirable enhancement or fix. May not be included in next release. type: feature request ‘Nice-to-have’ improvement, new feature or different behavior or design.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@alicejli