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

Reformat readme and add table of contents #127

Merged
merged 2 commits into from
Feb 2, 2024
Merged

Conversation

yahavi
Copy link
Member

@yahavi yahavi commented Jan 24, 2024

  • All tests passed. If this feature is not already covered by the tests, I added new tests.
  • I used npm run format for formatting the code before submitting the pull request.

https://github.com/yahavi/setup-jfrog-cli/blob/add-toc/README.md

  • Give the README a makeover
  • Include a table of contents
  • Streamline the OIDC instructions:
    • Keep it super basic - focus on getting it to function for a given repository
    • Drop the nitty-gritty details (like core.getIDToken())
    • Ditch the links to external docs; they clash a bit with this Action
  • Enhance the OIDC test a tad.

@yahavi yahavi added the ignore for release Automatically generated release notes label Jan 24, 2024
@yahavi yahavi self-assigned this Jan 24, 2024
@yahavi yahavi added the safe to test Approve running integration tests on a pull request label Jan 24, 2024
@github-actions github-actions bot removed the safe to test Approve running integration tests on a pull request label Jan 24, 2024
@yahavi yahavi added the safe to test Approve running integration tests on a pull request label Jan 24, 2024
@github-actions github-actions bot removed the safe to test Approve running integration tests on a pull request label Jan 24, 2024
Copy link
Contributor

@eranturgeman eranturgeman left a comment

Choose a reason for hiding this comment

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

The updated documentation looks great and the idea to add pictures is very helpful

.github/workflows/oidc-test.yml Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@yahavi yahavi merged commit c2665a8 into jfrog:master Feb 2, 2024
10 of 11 checks passed
@yahavi yahavi deleted the add-toc branch February 2, 2024 16:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ignore for release Automatically generated release notes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants