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

fix: look for typedoc ending in .zip #4110

Merged
merged 1 commit into from
Feb 1, 2025
Merged

Conversation

traeok
Copy link
Member

@traeok traeok commented Jan 31, 2025

Describe your pull request here:

Recently, the typedoc was updated so that a .zip.bundle file is packaged alongside the other files in the Zowe release folder. However, this broke the grep check in updateTypedoc.sh that looks for the typedoc ZIP and it grabs the bundle instead, causing unzip to fail on line 25 of the script. This PR updates the check so it grabs the ZIP rather than the .zip.bundle file.

List the file(s) included in this PR:

scripts/updateTypedoc.sh

Signed-off-by: Trae Yelovich <trae.yelovich@broadcom.com>
@traeok traeok requested review from t1m0thyj and anaxceron January 31, 2025 19:47
Copy link

😺 Thank you for creating this PR! To publish your content to Zowe Docs, follow these required steps.

  • Add the label review: doc.
  • Identify your content topic with a label. (Examples: area: apiml, area: cli, area: install and config, etc.)
  • Specify the major Zowe release(s) for your content. (Examples: release: V1, release: V2, release: V3)
    • If adding content that needs to be removed from V3 documentation, add the V3 N/A tag.
  • Select the master branch if your PR updates content that is on the live site. Select docs-staging if your PR updates content for a future release.
  • Notify the Doc Squad about this PR. If you don't know whom should review your content, message the #zowe-doc Slack channel. If you know which Doc Squad writer should approve your content, add that person as a reviewer.

Need help? Contact the Doc Squad in the #zowe-doc Slack channel.

Copy link

📁 The PR description is missing the file name(s) for the updated content. List all the files included in this PR so this information displays in our Zowe Docs GitHub Slack channel.

If you have addressed this issue already, refresh this page in your browser to remove this comment.

Copy link
Collaborator

@anaxceron anaxceron left a comment

Choose a reason for hiding this comment

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

thanks for the fix, @traeok!

@anaxceron anaxceron added area: docs Documentation issue or issues that have documentation impact release: V3 Zowe V3 content review: doc Needs review by Doc Squad member labels Jan 31, 2025
Copy link

@github-actions github-actions bot temporarily deployed to pull request January 31, 2025 19:53 Inactive
Copy link
Member

@t1m0thyj t1m0thyj left a comment

Choose a reason for hiding this comment

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

LGTM, thanks @traeok!

@anaxceron anaxceron merged commit 715e8d6 into docs-staging Feb 1, 2025
12 of 20 checks passed
@anaxceron anaxceron deleted the fix/typedoc-zip-logic branch February 1, 2025 02:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: docs Documentation issue or issues that have documentation impact release: V3 Zowe V3 content review: doc Needs review by Doc Squad member
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants