Squashed 'external/json/' changes from 60c48755e..55f93686c
55f93686c Merge branch 'release/3.12.0' 34e46d76d 🔖 set version to 3.12.0 00ecc7ed7 ⬆️ Bump github/codeql-action from 3.28.13 to 3.28.14 (#4726) 4424a0fcc 📝 update documentation (#4723) 11aa5f944 Make std::filesystem::path conversion to/from UTF-8 encoded string explicit (#4631) 79587f896 ⬆️ Bump mkdocs-material from 9.6.10 to 9.6.11 in /docs/mkdocs (#4715) b67f8644e ⬆️ Bump actions/dependency-review-action from 4.5.0 to 4.6.0 (#4716) 71884486d ⬆️ Bump step-security/harden-runner from 2.11.0 to 2.11.1 (#4718) 9ef496738 ⬆️ Bump cpplint from 2.0.0 to 2.0.1 in /cmake/requirements (#4719) 9f40a7b45 ⬆️ Bump mkdocs-material from 9.6.9 to 9.6.10 in /docs/mkdocs (#4711) d41ca94fa Adjust CMake minimal version (#4709) 3a5703931 ⬆️ Bump cppcheck from 1.4.8 to 1.5.0 in /cmake/requirements (#4698) 4d216e0c3 ⬆️ Bump actions/upload-artifact from 4.6.1 to 4.6.2 (#4700) f971dd770 ⬆️ Bump github/codeql-action from 3.28.11 to 3.28.13 (#4707) cd92c09c1 tests: Fix ignored attributes warning during build (#4670) b477d2b95 Suppress clang-analyzer-webkit.NoUncountedMemberChecker (#4701) 11a835df8 ⬆️ Bump cppcheck from 1.4.7 to 1.4.8 in /cmake/requirements (#4697) b592b6f2d ⬆️ Bump mkdocs-material from 9.6.8 to 9.6.9 in /docs/mkdocs (#4695) e2c95baef ⬆️ Bump mkdocs-git-revision-date-localized-plugin (#4689) 7abcb5e9a fixes issue 4691 (#4693) 5474b2227 ⬆️ Bump mkdocs-material from 9.6.5 to 9.6.8 in /docs/mkdocs (#4688) 6e684350b ⬆️ Bump github/codeql-action from 3.28.10 to 3.28.11 (#4683) f506d8acc ⬆️ Bump jinja2 from 3.1.5 to 3.1.6 in /tools/generate_natvis (#4680) 34665ae64 Correct typo in sax_interface.md (#4679) f3dc4684b ⬆️ Bump github/codeql-action from 3.28.9 to 3.28.10 (#4661) 0b938993e ⬆️ Bump lukka/get-cmake from 3.31.5 to 3.31.6 (#4668) 543d8e417 ⬆️ Bump actions/upload-artifact from 4.6.0 to 4.6.1 (#4665) f2e494686 ⬆️ Bump ossf/scorecard-action from 2.4.0 to 2.4.1 (#4664) 8215dbafb ⬆️ Bump mkdocs-material from 9.6.4 to 9.6.5 in /docs/mkdocs (#4659) a3143f5f2 ⬆️ Bump step-security/harden-runner from 2.10.4 to 2.11.0 (#4652) 0b6881a95 Add regression test for #3810 (#4608) a43350c4e Remove wsjcpp package manager (#4623) 8fb5d6f92 Some documentation updates (#4636) 2dc82053d ⬆️ Bump mkdocs-material from 9.5.50 to 9.6.4 in /docs/mkdocs (#4648) bf6b1e2f4 ⬆️ Bump github/codeql-action from 3.28.6 to 3.28.9 (#4646) 606b6347e ⬆️ Bump coverallsapp/github-action from 2.3.4 to 2.3.6 (#4634) c7d949f9f ⬆️ Bump github/codeql-action from 3.28.4 to 3.28.6 (#4635) e90c860d5 Add note on derived return type for value function (#4628) d0789e365 Bump lukka/get-cmake from 3.31.4 to 3.31.5 (#4625) 97dd60c22 Bump github/codeql-action from 3.28.3 to 3.28.4 (#4624) 666d06144 Bump github/codeql-action from 3.28.2 to 3.28.3 (#4620) bf8ccc20e fix compilation issue (#4613) 786c5040e Bump github/codeql-action from 3.28.1 to 3.28.2 (#4617) bd4fea39e Bump actions/stale from 9.0.0 to 9.1.0 (#4616) 8c7dcd3b4 Bump step-security/harden-runner from 2.10.3 to 2.10.4 (#4614) b23cdeac2 Bump mkdocs-material from 9.5.49 to 9.5.50 in /docs/mkdocs (#4615) 1b813519c Add VisionOS support to Swift Package Manager Package.swift definition file (#4611) f06604fce Bump the copyright years (#4606) d23291ba2 use diagnostic positions in exceptions (#4585) 0f9e6ae09 Fix broken links (#4605) 8a882f32e Generate template functions with NLOHMANN_DEFINE_TYPE macros (#4597) bdb8d2b7b Serialize empty tuple into '[]' instead of null (#4594) e72046ef9 Bump step-security/harden-runner from 2.10.2 to 2.10.3 (#4604) 4a0081a1c Bump actions/upload-artifact from 4.5.0 to 4.6.0 (#4603) 52b261421 Bump srvaroa/labeler (#4602) f74e5c6a5 Bump github/codeql-action from 3.27.9 to 3.28.1 (#4601) e25a82461 Bump lukka/get-cmake from 3.31.2 to 3.31.4 (#4600) 26cfec34b Clean up and document project files (#4560) ad2ee1853 Fix coverage job (#4595) 2d42229f4 Support BSON uint64 de/serialization (#4590) 1809b3d80 Add note to Jetbrains support (#4592) 48e7b4c23 BJData Fixes (#4588) 0cb1241d5 Improve Bazel support: Switch to Bzlmod (#4584) 2e50d5b2f BJData optimized binary array type (#4513) git-subtree-dir: external/json git-subtree-split: 55f93686c01528224f448c19128836e7df245f72
This commit is contained in:
irisz64
239
FILES.md
Normal file
239
FILES.md
Normal file
@@ -0,0 +1,239 @@
|
||||
# Supporting files
|
||||
|
||||
This file describes the source for supporting files; that is, files that are not part of the library, but define the infrastructure and other aspects of the project.
|
||||
|
||||
- [Continuous Integration](#continuous-integration)
|
||||
- [GitHub](#github)
|
||||
- [REUSE](#reuse)
|
||||
- [Package Managers](#package-managers)
|
||||
|
||||
## Continuous Integration
|
||||
|
||||
### `.cirrus.yml`
|
||||
|
||||
Configuration file for the pipeline at [Cirrus CI](https://cirrus-ci.com/github/nlohmann/json).
|
||||
|
||||
Further documentation:
|
||||
|
||||
- [Writing tasks](https://cirrus-ci.org/guide/writing-tasks/)
|
||||
|
||||
> [!IMPORTANT]
|
||||
> The filename `.cirrus.yml` and position (root of the repository) are predetermined by Cirrus CI.
|
||||
|
||||
### `.github/external_ci/appveyor.yml`
|
||||
|
||||
Configuration for the pipelines at [AppVeyor](https://ci.appveyor.com/project/nlohmann/json).
|
||||
|
||||
Further documentation:
|
||||
|
||||
- [appveyor.yml reference](https://www.appveyor.com/docs/appveyor-yml/)
|
||||
|
||||
> [!NOTE]
|
||||
> The filename can be freely configured in the AppVeyor project.
|
||||
|
||||
## GitHub
|
||||
|
||||
### `CITATION.cff`
|
||||
|
||||
A file to configure the citation for the repository which is displayed in the sidebar of the project.
|
||||
|
||||
Further documentation:
|
||||
|
||||
- [About CITATION files](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-citation-files)
|
||||
|
||||
> [!IMPORTANT]
|
||||
> The filename `CITATION.cff` and position (root of the repository) are predetermined by GitHub.
|
||||
|
||||
### `.github/CODE_OF_CONDUCT.md`
|
||||
|
||||
The code of conduct for the project. This is the Markdown version of the [Contributor Covenant Code of Conduct](https://www.contributor-covenant.org/version/2/1/code_of_conduct/). The code of conduct is linked on the [Community Standards](https://github.com/nlohmann/json/community) page and is mentioned by the Sentiment Bot.
|
||||
|
||||
Further documentation:
|
||||
|
||||
- [Adding a code of conduct to your project](https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/adding-a-code-of-conduct-to-your-project)
|
||||
|
||||
> [!IMPORTANT]
|
||||
> The filename `.github/CODE_OF_CONDUCT.md` is predetermined by GitHub.
|
||||
|
||||
> [!NOTE]
|
||||
> The file is part of the documentation and is included in `docs/mkdocs/docs/community/code_of_conduct.md`.
|
||||
|
||||
### `.github/CODEOWNERS`
|
||||
|
||||
The code owners file for the project which is used to select reviewers for new pull requests.
|
||||
|
||||
Further documentation:
|
||||
|
||||
- [About code owners](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners)
|
||||
|
||||
> [!IMPORTANT]
|
||||
> The filename `.github/CODEOWNERS` is predetermined by GitHub.
|
||||
|
||||
### `.github/config.yml`
|
||||
|
||||
Configuration file for [probot](https://probot.github.io/apps/), in particular the [Sentiment Bot](https://probot.github.io/apps/sentiment-bot/) and the [Request Info](https://probot.github.io/apps/request-info/).
|
||||
|
||||
> [!IMPORTANT]
|
||||
> The filename `.github/config.yml` is predetermined by probot.
|
||||
|
||||
### `.github/CONTRIBUTING.md`
|
||||
|
||||
The contribution guidelines which are linked in the [Community Standards](https://github.com/nlohmann/json/community) and at <https://github.com/nlohmann/json/contribute>.
|
||||
|
||||
Further documentation:
|
||||
|
||||
- [Setting guidelines for repository contributors](https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors)
|
||||
|
||||
> [!IMPORTANT]
|
||||
> The filename `.github/CONTRIBUTING.md` is predetermined by GitHub.
|
||||
|
||||
> [!NOTE]
|
||||
> The file is part of the documentation and is included in `docs/mkdocs/docs/community/contribution_guidelines.md`.
|
||||
|
||||
### `.github/dependabot.yml`
|
||||
|
||||
The configuration of [dependabot](https://github.com/dependabot) which ensures the dependencies (GitHub actions and Python packages used in the CI) remain up-to-date.
|
||||
|
||||
Further documentation:
|
||||
|
||||
- [Configuring Dependabot security updates](https://docs.github.com/en/code-security/dependabot/dependabot-security-updates/configuring-dependabot-security-updates)
|
||||
|
||||
> [!IMPORTANT]
|
||||
> The filename `.github/dependabot.yml` is predetermined by GitHub.
|
||||
|
||||
### `.github/FUNDING.yml`
|
||||
|
||||
A file to configure the sponsor button of the repository which is displayed in the sidebar of the project.
|
||||
|
||||
Further documentation:
|
||||
|
||||
- [Displaying a sponsor button in your repository](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/displaying-a-sponsor-button-in-your-repository)
|
||||
|
||||
> [!IMPORTANT]
|
||||
> The filename `.github/FUNDING.yml` is predetermined by GitHub.
|
||||
|
||||
### `.github/ISSUE_TEMPLATE/bug.yaml`
|
||||
|
||||
Issue form template for bugs.
|
||||
|
||||
Further documentation:
|
||||
|
||||
- [Configuring issue templates for your repository](https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository)
|
||||
|
||||
> [!IMPORTANT]
|
||||
> The folder `.github/ISSUE_TEMPLATE` is predetermined by GitHub.
|
||||
|
||||
### `.github/ISSUE_TEMPLATE/config.yaml`
|
||||
|
||||
Issue template chooser configuration. The file is used to configure the dialog when a new issue is created.
|
||||
|
||||
Further documentation:
|
||||
|
||||
- [Configuring issue templates for your repository](https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository)
|
||||
|
||||
> [!IMPORTANT]
|
||||
> The filename `.github/ISSUE_TEMPLATE/config.yaml` is predetermined by GitHub.
|
||||
|
||||
### `.github/labeler.yml`
|
||||
|
||||
Configuration file for the "Pull Request Labeler" workflow defined in `workflows/labeler.yml`. This file defines rules how labels are assigned to pull requests based on which files are changed.
|
||||
|
||||
Further documentation:
|
||||
|
||||
- [Label manager for PRs and issues based on configurable conditions](https://github.com/srvaroa/labeler)
|
||||
|
||||
> [!NOTE]
|
||||
> The filename defaults to `.github/labeler.yml` and can be configured in the workflow.
|
||||
|
||||
### `.github/PULL_REQUEST_TEMPLATE.md`
|
||||
|
||||
The pull request template which prefills new pull requests.
|
||||
|
||||
Further documentation:
|
||||
|
||||
- [Creating a pull request template for your repository](https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/creating-a-pull-request-template-for-your-repository)
|
||||
|
||||
> [!IMPORTANT]
|
||||
> The filename `.github/PULL_REQUEST_TEMPLATE.md` is predetermined by GitHub.
|
||||
|
||||
### `.github/SECURITY.md`
|
||||
|
||||
The goal is to describe how to securely report security vulnerabilities for this repository. The security policy is linked at <https://github.com/nlohmann/json/security/policy>.
|
||||
|
||||
Further documentation:
|
||||
|
||||
- [Adding a security policy to your repository](https://docs.github.com/en/code-security/getting-started/adding-a-security-policy-to-your-repository)
|
||||
|
||||
> [!IMPORTANT]
|
||||
> The filename `.github/SECURITY.yml` is predetermined by GitHub.
|
||||
|
||||
> [!NOTE]
|
||||
> The file is part of the documentation and is included in `docs/mkdocs/docs/community/security_policy.md`.
|
||||
|
||||
### `LICENSE.MIT`
|
||||
|
||||
The license of the project.
|
||||
|
||||
Further documentation:
|
||||
|
||||
- [Adding a license to a repository](https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/adding-a-license-to-a-repository)
|
||||
|
||||
> [!IMPORTANT]
|
||||
> The filename `LICENSE.MIT` is partly predetermined by GitHub. The root filename must be `LICENSE`.
|
||||
|
||||
## REUSE
|
||||
|
||||
### `.reuse/dep5`
|
||||
|
||||
The file defines the licenses of certain third-party component in the repository. The root `Makefile` contains a target `reuse` that checks for compliance.
|
||||
|
||||
Further documentation:
|
||||
|
||||
- [DEP5](https://reuse.software/spec-3.2/#dep5-deprecated)
|
||||
- [reuse command-line tool](https://pypi.org/project/reuse/)
|
||||
- [documentation of linting](https://reuse.readthedocs.io/en/stable/man/reuse-lint.html)
|
||||
- [REUSE](http://reuse.software)
|
||||
|
||||
> [!IMPORTANT]
|
||||
> The filename `.reuse/dep5` is predetermined by REUSE. Alternatively, a `REUSE.toml` file can be used.
|
||||
|
||||
### `.reuse/templates`
|
||||
|
||||
Copyright header templates for source files. The root `Makefile` contains a target `reuse` that updates copyright headers with the templates.
|
||||
|
||||
Further information:
|
||||
|
||||
- [reuse command-line tool](https://pypi.org/project/reuse/)
|
||||
- [documentation on templates](https://reuse.readthedocs.io/en/stable/man/reuse-annotate.html#cmdoption-t)
|
||||
- [REUSE](http://reuse.software)
|
||||
|
||||
> [!IMPORTANT]
|
||||
> The folder name `.reuse/templates` is predetermined by REUSE.
|
||||
|
||||
### `LICENSES`
|
||||
|
||||
A folder that contains every license of all licenses files (library and third-party code).
|
||||
|
||||
Further documentation:
|
||||
|
||||
- [REUSE specification](https://reuse.software/spec-3.3/)
|
||||
|
||||
> [!IMPORTANT]
|
||||
> The folder name `LICENSES` is predetermined by REUSE.
|
||||
|
||||
|
||||
## Package Managers
|
||||
|
||||
### `BUILD.bazel`
|
||||
|
||||
The file can be updated by calling
|
||||
|
||||
```shell
|
||||
make BUILD.bazel
|
||||
```
|
||||
|
||||
### `meson.build`
|
||||
|
||||
### `Package.swift`
|
||||
|
||||
### `WORKSPACE.bazel`
|
||||
Reference in New Issue
Block a user