{"id":13731602,"url":"https://github.com/nunit/docs","last_synced_at":"2026-01-26T21:50:55.768Z","repository":{"id":3738687,"uuid":"50743570","full_name":"nunit/docs","owner":"nunit","description":"Documentation for all active NUnit projects","archived":false,"fork":false,"pushed_at":"2026-01-12T21:34:37.000Z","size":24278,"stargazers_count":601,"open_issues_count":90,"forks_count":161,"subscribers_count":53,"default_branch":"master","last_synced_at":"2026-01-13T01:54:11.494Z","etag":null,"topics":["documentation","hacktoberfest","nunit"],"latest_commit_sha":null,"homepage":"https://docs.nunit.org","language":"Dockerfile","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/nunit.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.md","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2016-01-30T20:30:14.000Z","updated_at":"2026-01-12T21:33:37.000Z","dependencies_parsed_at":"2023-09-22T07:52:15.309Z","dependency_job_id":"c5da8dc7-43d0-4bec-b530-af8df5d43c2e","html_url":"https://github.com/nunit/docs","commit_stats":{"total_commits":707,"total_committers":58,"mean_commits":"12.189655172413794","dds":0.6478076379066477,"last_synced_commit":"3ad681e0c9602d0bdda97e75ff176c44b79c187d"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/nunit/docs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nunit%2Fdocs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nunit%2Fdocs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nunit%2Fdocs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nunit%2Fdocs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nunit","download_url":"https://codeload.github.com/nunit/docs/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nunit%2Fdocs/sbom","scorecard":{"id":698721,"data":{"date":"2025-08-11","repo":{"name":"github.com/nunit/docs","commit":"6b716d530125da67ab18bdb3fc74ca5d929ec602"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":5.3,"checks":[{"name":"Code-Review","score":5,"reason":"Found 3/6 approved changesets -- score normalized to 5","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Maintained","score":10,"reason":"30 commit(s) and 2 issue activity found in the last 90 days -- score normalized to 10","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Dangerous-Workflow","score":10,"reason":"no dangerous workflow patterns detected","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: jobLevel 'deployments' permission set to 'write': .github/workflows/closed-pr.yml:7","Warn: no topLevel permission defined: .github/workflows/build-process.yml:1","Warn: no topLevel permission defined: .github/workflows/closed-pr.yml:1"],"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE.md:0","Info: FSF or OSI recognized license: MIT License: LICENSE.md:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Branch-Protection","score":-1,"reason":"internal error: error during branchesHandler.setup: internal error: githubv4.Query: Resource not accessible by integration","details":null,"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"Pinned-Dependencies","score":0,"reason":"dependency not pinned by hash detected -- score normalized to 0","details":["Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build-process.yml:47: update your workflow using https://app.stepsecurity.io/secureworkflow/nunit/docs/build-process.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/build-process.yml:50: update your workflow using https://app.stepsecurity.io/secureworkflow/nunit/docs/build-process.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/build-process.yml:60: update your workflow using https://app.stepsecurity.io/secureworkflow/nunit/docs/build-process.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build-process.yml:67: update your workflow using https://app.stepsecurity.io/secureworkflow/nunit/docs/build-process.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build-process.yml:78: update your workflow using https://app.stepsecurity.io/secureworkflow/nunit/docs/build-process.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build-process.yml:80: update your workflow using https://app.stepsecurity.io/secureworkflow/nunit/docs/build-process.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build-process.yml:96: update your workflow using https://app.stepsecurity.io/secureworkflow/nunit/docs/build-process.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/build-process.yml:103: update your workflow using https://app.stepsecurity.io/secureworkflow/nunit/docs/build-process.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/build-process.yml:111: update your workflow using https://app.stepsecurity.io/secureworkflow/nunit/docs/build-process.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/build-process.yml:121: update your workflow using https://app.stepsecurity.io/secureworkflow/nunit/docs/build-process.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/build-process.yml:127: update your workflow using https://app.stepsecurity.io/secureworkflow/nunit/docs/build-process.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build-process.yml:143: update your workflow using https://app.stepsecurity.io/secureworkflow/nunit/docs/build-process.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/build-process.yml:150: update your workflow using https://app.stepsecurity.io/secureworkflow/nunit/docs/build-process.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build-process.yml:19: update your workflow using https://app.stepsecurity.io/secureworkflow/nunit/docs/build-process.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build-process.yml:21: update your workflow using https://app.stepsecurity.io/secureworkflow/nunit/docs/build-process.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build-process.yml:33: update your workflow using https://app.stepsecurity.io/secureworkflow/nunit/docs/build-process.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build-process.yml:35: update your workflow using https://app.stepsecurity.io/secureworkflow/nunit/docs/build-process.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/closed-pr.yml:11: update your workflow using https://app.stepsecurity.io/secureworkflow/nunit/docs/closed-pr.yml/master?enable=pin","Warn: containerImage not pinned by hash: .devcontainer/Dockerfile:1: pin your Docker image by updating ghcr.io/nunit/docfx-action:v4.1.0 to ghcr.io/nunit/docfx-action:v4.1.0@sha256:04925f98d1e721321e7ff23884e06eed340356114ee3d7d99367fd1e02404b84","Warn: npmCommand not pinned by hash: .devcontainer/Dockerfile:16","Warn: npmCommand not pinned by hash: .devcontainer/Dockerfile:17","Warn: npmCommand not pinned by hash: .devcontainer/Dockerfile:18","Warn: npmCommand not pinned by hash: .devcontainer/Dockerfile:19","Warn: npmCommand not pinned by hash: .github/workflows/build-process.yml:26","Warn: npmCommand not pinned by hash: .github/workflows/build-process.yml:40","Warn: nugetCommand not pinned by hash: .github/workflows/build-process.yml:85: pin your dependecies by either enabling central package management (https://learn.microsoft.com/nuget/consume-packages/Central-Package-Management) or using a lockfile (https://learn.microsoft.com/nuget/consume-packages/package-references-in-project-files#locking-dependencies)","Info:   0 out of  10 GitHub-owned GitHubAction dependencies pinned","Info:   0 out of   8 third-party GitHubAction dependencies pinned","Info:   0 out of   1 nugetCommand dependencies pinned","Info:   0 out of   1 containerImage dependencies pinned","Info:   0 out of   6 npmCommand dependencies pinned"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 30 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}}]},"last_synced_at":"2025-08-22T04:32:29.441Z","repository_id":3738687,"created_at":"2025-08-22T04:32:29.441Z","updated_at":"2025-08-22T04:32:29.441Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28789119,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-26T21:49:50.245Z","status":"ssl_error","status_checked_at":"2026-01-26T21:48:29.455Z","response_time":59,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["documentation","hacktoberfest","nunit"],"created_at":"2024-08-03T02:01:33.812Z","updated_at":"2026-01-26T21:50:55.751Z","avatar_url":"https://github.com/nunit.png","language":"Dockerfile","funding_links":[],"categories":["Dockerfile"],"sub_categories":[],"readme":"# NUnit Documentation\n\nThis repository serves the content that is found at \u003chttps://docs.nunit.org\u003e.\n\n[![NUnit Documentation Build Process](https://github.com/nunit/docs/actions/workflows/build-process.yml/badge.svg)](https://github.com/nunit/docs/actions/workflows/build-process.yml)\n\n## What is the Docs site? How does it work?\n\nThe docs site is a project within the NUnit organization. [Read the vision at VISION.md](VISION.md) to understand more about how the documentation fits into the overall organization and how it supports the other projects.\n\n## How to Build these docs locally\n\n* Prerequisite: Install [docfx](https://dotnet.github.io/docfx/) (using [Chocolatey](https://chocolatey.org/)? The command is `choco install docfx -y`)\n* Pull this repository\n* `cd docs`\n* Run `docfx serve` and navigate to \u003chttp://localhost:8080/_site\u003e\n\n## How to Build These Docs Within GitHub Codespaces or a Dev Container\n\nFancy using GitHub Codespaces for your work on these docs? Or want to work in the environment locally? You can!\n\n* Open the branch you want to work on in GitHub Codespaces\n* The tooling, VS code extensions, etc. that we use will immediately be available to you.\n* To build from the Codespaces terminal: `build` (we've taken care of the rest for you)\n* To serve / preview from the Codespaces terminal: `serve` (we've taken care of the rest for you)\n* To run markdown linting from the Codespaces terminal: `lint` (we've taken care of the rest for you)\n* To run spellcheck from the Codespaces terminal: `spellcheck` (we've taken care of the rest for you)\n* To build/test the snippets from the Codespaces terminal: `snippets` (we've taken care of the rest for you)\n\nWe'll be working on follow-ups to make this more user-friendly, but it's now workable.\n\n## Linting Locally\n\n* Install `markdownlint-cli2`: `npm install markdownlint-cli2 -g`\n* Open the root of the project (`/`, not `/docs`)\n* Run `markdownlint-cli2 --config \".github/linters/.markdownlint.yml\" \"docs/**/*.md\"`\n\nWe recommend adding the following settings to your VSCode environment if they don't come through in the repository:\n\n```json\n    \"editor.codeActionsOnSave\": {\n        \"source.fixAll.markdownlint\": \"always\"\n    }\n```\n\nThis will fix 80% of the markdown linting issues for you upon save.\n\nWe'd love your contributions! See [The contributing guide](CONTRIBUTING.md) for how to get involved.\n\n## Building the API docs locally\n\nThe NUnit source code is in a separate repository from the docs, so we typically generate this at build time by copying\npublished code into a build-specific folder (`/code-output`). From there, `docfx` transforms the xmldoc comments that\nare alongside the DLLs into HTML files.\n\nSometimes you may need/want to reproduce this locally. You can take the following steps to do so:\n\n* Go to the NUnit release you want in the GitHub Releases\n* Download \u0026 extract the `.zip` file of the release contents\n* Copy the contents of one of the release targets, e.g. `net6.0`, into a `code-outputs` folder in the root of the\nrepository.\n* Run the `docfx` command as you normally would.\n\n## How the Docs are Built and Deployed\n\n* We build the docs via the GitHub actions located in `./github/workflows`.\n* The workflow uses a container with docfx installed; the container builds the docs.\n* The workflow then uses another container to push the results to the `gh-pages` branch, using a personal access token\nthat is stored in the repository's settings.\n* GitHub serves the outputted site from the `gh-pages` branch, and the DNS of `docs.nunit.org` points there.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnunit%2Fdocs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnunit%2Fdocs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnunit%2Fdocs/lists"}