Skip to content

[ZEPPELIN-6253] fix: remove SNAPSHOT from version when building crede…#4993

Open
hyo-ryeong wants to merge 2 commits into
apache:masterfrom
hyo-ryeong:feature/ZEPPELIN-6253
Open

[ZEPPELIN-6253] fix: remove SNAPSHOT from version when building crede…#4993
hyo-ryeong wants to merge 2 commits into
apache:masterfrom
hyo-ryeong:feature/ZEPPELIN-6253

Conversation

@hyo-ryeong

Copy link
Copy Markdown
Contributor

What is this PR for?

Fixes a broken "Learn more" link on the credential page.

Zeppelin currently appends -SNAPSHOT to the version when constructing the documentation link, which results in a 404 page.
This PR removes -SNAPSHOT from the version and ensures it uses a valid documentation path.

Broken link (before):
https://zeppelin.apache.org/docs/0.12.0-SNAPSHOT/setup/security/datasource_authorization.html

Corrected link (after):
https://zeppelin.apache.org/docs/0.12.0/setup/security/datasource_authorization.html


What type of PR is it?

  • Bug Fix

What is the Jira issue?

JIRA: ZEPPELIN-6253


How should this be tested?

  1. Navigate to Credential page in Zeppelin.
  2. Click the "?" (Learn more) link at the top right.
  3. Confirm it opens a valid docs page without 404.

Questions

  • Does the license files need to update? → No
  • Is there breaking changes for older versions? → No
  • Does this need documentation? → No

@tbonelee tbonelee left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thanks for fixing the broken doc URL.
Just to clarify, even after removing -SNAPSHOT, the docs page for the current development version might still be missing, since the latest version is not released yet. So the link could still be broken unless it falls back to a stable version like latest.
We might also consider a unified approach in #4980 if needed.

Comment on lines +202 to +203
let currentVersion = $rootScope.zeppelinVersion || '0.12.0';
currentVersion = currentVersion.replace('-SNAPSHOT', '');

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

How about replacing the -SNAPSHOT part if present, and falling back to 'latest' instead?
Also, I think it's preferrable to avoid hardcoding version strings like '0.12.0'.

Suggested change
let currentVersion = $rootScope.zeppelinVersion || '0.12.0';
currentVersion = currentVersion.replace('-SNAPSHOT', '');
const currentVersion = $rootScope.zeppelinVersion
&& $rootScope.zeppelinVersion.replace('-SNAPSHOT', '') || 'latest';


/*
* Add '/setup' to doc link on the version over 0.7.0
* Add '/setup' to doc link on the version over 0.7.0, add '/setup' to the doc URL

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

The add part seems to repeat the same meaning as the original comment.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Thanks for the review!
I updated the code to remove the hardcoded default version and added a fallback to 'latest' when zeppelinVersion is not available.
Also simplified the comment to avoid duplication.

@ParkGyeongTae ParkGyeongTae left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I think the PR title might be unfinished — could you please review it and update if needed?

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.

3 participants