diff --git a/.github/workflows/build-test-pack.yml b/.github/workflows/build-test-pack.yml index 6c99218..b260f4b 100644 --- a/.github/workflows/build-test-pack.yml +++ b/.github/workflows/build-test-pack.yml @@ -1,69 +1,30 @@ -name: Build, Test, and Pack +name: Build and Test on: - push: - branches: - - main - pull_request: - workflow_dispatch: + push: + branches: + - main + pull_request: + workflow_dispatch: jobs: - build-test-pack: - runs-on: ubuntu-latest + build-test: + runs-on: ubuntu-latest - steps: - - name: Checkout - uses: actions/checkout@v5 - with: - fetch-depth: 0 + steps: + - name: Checkout + uses: actions/checkout@v5 - - name: Setup .NET - uses: actions/setup-dotnet@v5 - with: - dotnet-version: 10.0.x + - name: Setup .NET + uses: actions/setup-dotnet@v5 + with: + dotnet-version: 10.0.x - - name: Setup GitVersion - uses: gittools/actions/gitversion/setup@v4 - with: - versionSpec: "6.x" + - name: Restore + run: dotnet restore HealthChecks.MiniUI.sln - - name: Determine Version - id: gitversion - uses: gittools/actions/gitversion/execute@v4 + - name: Build + run: dotnet build HealthChecks.MiniUI.sln -c Release --no-restore /p:ContinuousIntegrationBuild=true - - name: Resolve package version - id: pkgver - shell: bash - run: | - VERSION="${{ steps.gitversion.outputs.SemVer }}" - if [ -z "$VERSION" ]; then VERSION="${{ steps.gitversion.outputs.semVer }}"; fi - if [ -z "$VERSION" ]; then - echo "Could not resolve GitVersion SemVer output." >&2 - exit 1 - fi - echo "Resolved package version: $VERSION" - echo "value=$VERSION" >> "$GITHUB_OUTPUT" - - - name: Restore - run: dotnet restore HealthChecks.MiniUI.sln - - - name: Build - run: dotnet build HealthChecks.MiniUI.sln -c Release --no-restore /p:ContinuousIntegrationBuild=true - - - name: Test - run: dotnet test tests/HealthChecks.MiniUI.Tests/HealthChecks.MiniUI.Tests.csproj -c Release --no-build - - - name: Pack NuGet - run: >- - dotnet pack src/HealthChecks.MiniUI/HealthChecks.MiniUI.csproj - -c Release - --no-build - -o artifacts - /p:Version=${{ steps.pkgver.outputs.value }} - /p:PackageVersion=${{ steps.pkgver.outputs.value }} - - - name: Upload package artifact - uses: actions/upload-artifact@v7 - with: - name: nuget-package - path: artifacts/*.nupkg + - name: Test + run: dotnet test tests/HealthChecks.MiniUI.Tests/HealthChecks.MiniUI.Tests.csproj -c Release --no-build diff --git a/.github/workflows/publish-nuget.yml b/.github/workflows/publish-nuget.yml index cb82add..f5805a0 100644 --- a/.github/workflows/publish-nuget.yml +++ b/.github/workflows/publish-nuget.yml @@ -11,9 +11,12 @@ permissions: id-token: write jobs: - publish: + build: runs-on: ubuntu-latest + outputs: + package_version: ${{ steps.pkgver.outputs.value }} + steps: - name: Checkout uses: actions/checkout@v5 @@ -64,14 +67,31 @@ jobs: -o artifacts /p:Version=${{ steps.pkgver.outputs.value }} /p:PackageVersion=${{ steps.pkgver.outputs.value }} + /p:PackageOwner="WorldDirect" - name: Upload package artifact uses: actions/upload-artifact@v7 with: - name: nuget-package-${{ steps.pkgver.outputs.value }} + name: nuget-package path: artifacts/*.nupkg if-no-files-found: warn + publish-nuget: + runs-on: ubuntu-latest + needs: build + + steps: + - name: Setup .NET + uses: actions/setup-dotnet@v5 + with: + dotnet-version: 10.0.x + + - name: Download package artifact + uses: actions/download-artifact@v8 + with: + name: nuget-package + path: artifacts + # NuGet trusted publishing still requires a username hint for policy lookup. # This value must be the NuGet username of the account that created the # trusted publishing policy (not necessarily the policy owner org name). @@ -83,4 +103,7 @@ jobs: user: ${{ vars.NUGET_TRUSTED_PUBLISHER_USER }} - name: Push to NuGet.org (Trusted Publishing) - run: dotnet nuget push "artifacts/*.nupkg" --api-key "${{ steps.nuget-login.outputs.NUGET_API_KEY }}" --source "https://api.nuget.org/v3/index.json" --skip-duplicate + run: | + dotnet nuget push "artifacts/*.nupkg" \ + --api-key "${{ steps.nuget-login.outputs.NUGET_API_KEY }}" \ + --source "https://api.nuget.org/v3/index.json" diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..d4201c8 --- /dev/null +++ b/LICENSE @@ -0,0 +1,176 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS \ No newline at end of file diff --git a/assets/icon.png b/assets/icon.png new file mode 100644 index 0000000..59b4371 Binary files /dev/null and b/assets/icon.png differ diff --git a/assets/icon.svg b/assets/icon.svg new file mode 100644 index 0000000..a81794e --- /dev/null +++ b/assets/icon.svg @@ -0,0 +1,22 @@ + + + + + + + + + + + + + + + + + + + + + + diff --git a/assets/render-icon.sh b/assets/render-icon.sh new file mode 100755 index 0000000..b13a524 --- /dev/null +++ b/assets/render-icon.sh @@ -0,0 +1,22 @@ +#!/usr/bin/env bash +set -euo pipefail + +SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)" +SVG_PATH="${SCRIPT_DIR}/icon.svg" +PNG_PATH="${SCRIPT_DIR}/icon.png" +SIZE="128" + +if ! command -v sips >/dev/null 2>&1; then + echo "Error: 'sips' is required on macOS to render icon.png from icon.svg." >&2 + exit 1 +fi + +if [[ ! -f "${SVG_PATH}" ]]; then + echo "Error: Source file not found: ${SVG_PATH}" >&2 + exit 1 +fi + +sips -s format png "${SVG_PATH}" --out "${PNG_PATH}" >/dev/null +sips -z "${SIZE}" "${SIZE}" "${PNG_PATH}" >/dev/null + +echo "Rendered ${PNG_PATH} from ${SVG_PATH} (${SIZE}x${SIZE})." diff --git a/scripts/delete-test-tags.sh b/scripts/delete-test-tags.sh new file mode 100755 index 0000000..d5cd0a1 --- /dev/null +++ b/scripts/delete-test-tags.sh @@ -0,0 +1,99 @@ +#!/usr/bin/env bash +set -euo pipefail + +# Deletes local and remote git tags matching a regex. +# Defaults to dry-run mode to prevent accidental deletion. + +REMOTE="origin" +PATTERN='^v0\.0\.' +APPLY=false + +usage() { + cat < Regex to match tags (default: ${PATTERN}) + --remote Remote name for remote tag deletion (default: ${REMOTE}) + --apply Actually delete matched tags locally and on remote + -h, --help Show this help + +Examples: + # Preview what would be deleted + ./scripts/delete-test-tags.sh + + # Preview tags matching a custom pattern + ./scripts/delete-test-tags.sh --pattern '^v0\\.0\\.(10[0-9]|11[0-9])$' + + # Execute deletion + ./scripts/delete-test-tags.sh --apply +EOF +} + +while [[ $# -gt 0 ]]; do + case "$1" in + --pattern) + PATTERN="${2:-}" + shift 2 + ;; + --remote) + REMOTE="${2:-}" + shift 2 + ;; + --apply) + APPLY=true + shift + ;; + -h|--help) + usage + exit 0 + ;; + *) + echo "Unknown argument: $1" >&2 + usage >&2 + exit 1 + ;; + esac +done + +if [[ -z "${PATTERN}" ]]; then + echo "Error: --pattern cannot be empty." >&2 + exit 1 +fi + +if [[ "$(git rev-parse --is-inside-work-tree 2>/dev/null || echo false)" != "true" ]]; then + echo "Error: This script must be run inside a git repository." >&2 + exit 1 +fi + +TAGS=() +while IFS= read -r tag; do + TAGS+=("${tag}") +done < <(git tag -l | grep -E "${PATTERN}" || true) + +if [[ ${#TAGS[@]} -eq 0 ]]; then + echo "No tags matched pattern: ${PATTERN}" + exit 0 +fi + +echo "Matched ${#TAGS[@]} tag(s) using pattern: ${PATTERN}" +printf ' %s\n' "${TAGS[@]}" + +if [[ "${APPLY}" != true ]]; then + echo + echo "Dry run only. No tags were deleted." + echo "Re-run with --apply to delete these tags locally and on remote '${REMOTE}'." + exit 0 +fi + +echo +for tag in "${TAGS[@]}"; do + echo "Deleting local tag: ${tag}" + git tag -d "${tag}" >/dev/null || true + + echo "Deleting remote tag: ${tag}" + git push "${REMOTE}" ":refs/tags/${tag}" >/dev/null || true +done + +echo +printf 'Deleted %d tag(s) locally and attempted remote delete on %s.\n' "${#TAGS[@]}" "${REMOTE}" diff --git a/src/HealthChecks.MiniUI/HealthChecks.MiniUI.csproj b/src/HealthChecks.MiniUI/HealthChecks.MiniUI.csproj index e026ec3..2ab2d00 100644 --- a/src/HealthChecks.MiniUI/HealthChecks.MiniUI.csproj +++ b/src/HealthChecks.MiniUI/HealthChecks.MiniUI.csproj @@ -7,8 +7,15 @@ true $(WarningsAsErrors);CS1591 WorldDirect.HealthChecks.MiniUI + WorldDirect + WorldDirect Tiny human-readable health page for ASP.NET Core health checks. + Apache-2.0 + icon.png + healthchecks;aspnetcore;observability;status-page + https://github.com/world-direct/HealthChecks.MiniUI README.md + https://github.com/world-direct/HealthChecks.MiniUI git @@ -18,6 +25,7 @@ +