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

Add additional shields.io badges to README #1167

Merged
merged 4 commits into from
Jun 21, 2024

Conversation

mitchelbaker-cisa
Copy link
Collaborator

@mitchelbaker-cisa mitchelbaker-cisa commented Jun 17, 2024

🗣 Description

Add license, GitHub/PSGallery versions, CICD workflow, open issues, and GitHub/PSGallery download badges to the README with respective links.

💭 Motivation and context

Resolves #1166

🧪 Testing

  • Check remote branch to see if badges display correctly, check links.
  • Created fork and tested all badges display correctly in GitHub Pages.

✅ Pre-approval checklist

  • This PR has an informative and human-readable title.
  • PR targets the correct parent branch (e.g., main or release-name) for merge.
  • Changes are limited to a single goal - eschew scope creep!
  • Changes are sized such that they do not touch excessive number of files.
  • All future TODOs are captured in issues, which are referenced in code comments.
  • These code changes follow the ScubaGear content style guide.
  • Related issues these changes resolve are linked preferably via closing keywords.
  • All relevant type-of-change labels added.
  • All relevant project fields are set.
  • All relevant repo and/or project documentation updated to reflect these changes.
  • Unit tests added/updated to cover PowerShell and Rego changes.
  • Functional tests added/updated to cover PowerShell and Rego changes.
  • All relevant functional tests passed.
  • All automated checks (e.g., linting, static analysis, unit/smoke tests) passed.

✅ Pre-merge checklist

  • PR passed smoke test check.

  • Feature branch has been rebased against changes from parent branch, as needed

    Use Rebase branch button below or use this reference to rebase from the command line.

  • Resolved all merge conflicts on branch

  • Notified merge coordinator that PR is ready for merge via comment mention

✅ Post-merge checklist

  • Feature branch deleted after merge to clean up repository.
  • Verified that all checks pass on parent branch (e.g., main or release-name) after merge.
  • Check that badges display correctly in GitHub Pages version of the README.

@mitchelbaker-cisa mitchelbaker-cisa added the enhancement This issue or pull request will add new or improve existing functionality label Jun 17, 2024
@mitchelbaker-cisa mitchelbaker-cisa added this to the Iceberg milestone Jun 17, 2024
@mitchelbaker-cisa mitchelbaker-cisa self-assigned this Jun 17, 2024
@mitchelbaker-cisa mitchelbaker-cisa changed the title Add GitHub/PsGallery download badges to README Add GitHub/PSGallery download badges to README Jun 17, 2024
Copy link
Collaborator

@james-garriss james-garriss left a comment

Choose a reason for hiding this comment

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

Perfect! Love it!

Copy link
Collaborator

@buidav buidav left a comment

Choose a reason for hiding this comment

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

Good thing we only switched to mainly PSGallery once we hit 10K downloads for the package :)

@mitchelbaker-cisa
Copy link
Collaborator Author

Added a post-merge check to see if badges display correctly in GitHub Pages, as @james-garriss I believe the changes will only display after we push to main?

@james-garriss
Copy link
Collaborator

Correct. If you want to test before PR, you can clone repo, make changes to show the badge on its main, and see what happens.

@mitchelbaker-cisa mitchelbaker-cisa changed the title Add GitHub/PSGallery download badges to README Add additional shields.io badges to README Jun 18, 2024
@buidav
Copy link
Collaborator

buidav commented Jun 18, 2024

On the current iteration of the PR. Would recommend putting the license badge somewhere after the GitHub release and PSGallery Badges.
As those are clickable release links and I suspect some people are savy enough to know they are. Lets save them several pixels of mouse drag :).
front

@mitchelbaker-cisa mitchelbaker-cisa force-pushed the 1166-add-download-badges branch from f977b1e to 5505294 Compare June 18, 2024 20:03
@mitchelbaker-cisa
Copy link
Collaborator Author

@nanda-katikaneni Ready to merge

@nanda-katikaneni nanda-katikaneni merged commit 3a5d2fb into main Jun 21, 2024
14 checks passed
@nanda-katikaneni nanda-katikaneni deleted the 1166-add-download-badges branch June 21, 2024 15:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement This issue or pull request will add new or improve existing functionality
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add shields.io badges to README
4 participants