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

Misleading Content in OIDC Example #171

Closed
tomjfrog opened this issue Jul 3, 2024 · 2 comments · Fixed by #169
Closed

Misleading Content in OIDC Example #171

tomjfrog opened this issue Jul 3, 2024 · 2 comments · Fixed by #169
Assignees
Labels
bug Something isn't working

Comments

@tomjfrog
Copy link

tomjfrog commented Jul 3, 2024

Describe the bug

In the OIDC guidance, there is a section titled "Example step utilizing OpenID Connect". In the code snippet, the JF_URL is a secret. Later in the documentation, it's noted that:

The Job Summary UI includes direct links to the JFrog Platform UI. It's important to note that for the platform links to function correctly, JF_URL should be set as a variable rather than a secret. This is to prevent GitHub from masking the URL.

Can this be corrected or clarified?

Current behavior

The documentation is a little confusing as per the Bug description.

Reproduction steps

No response

Expected behavior

Consistent approach to using either an var or secrets in the code examples of setup

Setup JFrog CLI version

@v4

JFrog CLI version

@v4

Workflow operating system type and version

N/A

JFrog Artifactory version (if relevant)

No response

JFrog Xray version (if relevant)

No response

@tomjfrog tomjfrog added the bug Something isn't working label Jul 3, 2024
@EyalDelarea EyalDelarea linked a pull request Jul 10, 2024 that will close this issue
2 tasks
@EyalDelarea EyalDelarea self-assigned this Jul 10, 2024
@EyalDelarea
Copy link
Contributor

Hey @tomjfrog,

Thank you for reporting this issue.
We will update the documentation to use vars instead of secrets.

To clarify, until now, we advised our users to define the JF_URL as a secret. With the release of JFrog Job Summaries, we have changed our approach to setting the JF_URL as a var instead of a secret to prevent GitHub from masking the URL in the summary.

@tomjfrog
Copy link
Author

Understood, thanks for the improvement @EyalDelarea 🐸

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants