{"id":21683406,"url":"https://github.com/stonestepsinc/rapidjson-nuget","last_synced_at":"2026-01-11T02:39:05.596Z","repository":{"id":113509405,"uuid":"609923019","full_name":"StoneStepsInc/rapidjson-nuget","owner":"StoneStepsInc","description":"This project builds a RapidJSON Nuget package. ","archived":false,"fork":false,"pushed_at":"2024-09-22T16:59:06.000Z","size":17,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-01-02T03:08:00.821Z","etag":null,"topics":["dom-style","json","native","nuget","package","parser","rapidjson","sax-style"],"latest_commit_sha":null,"homepage":"","language":"C++","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/StoneStepsInc.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"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}},"created_at":"2023-03-05T16:33:14.000Z","updated_at":"2024-09-22T16:48:14.000Z","dependencies_parsed_at":null,"dependency_job_id":"64cb7da7-3f1b-4a5d-b961-69525d0753f2","html_url":"https://github.com/StoneStepsInc/rapidjson-nuget","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/StoneStepsInc%2Frapidjson-nuget","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/StoneStepsInc%2Frapidjson-nuget/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/StoneStepsInc%2Frapidjson-nuget/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/StoneStepsInc%2Frapidjson-nuget/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/StoneStepsInc","download_url":"https://codeload.github.com/StoneStepsInc/rapidjson-nuget/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":235575694,"owners_count":19012156,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":["dom-style","json","native","nuget","package","parser","rapidjson","sax-style"],"created_at":"2024-11-25T16:11:49.393Z","updated_at":"2025-10-07T02:30:32.312Z","avatar_url":"https://github.com/StoneStepsInc.png","language":"C++","funding_links":[],"categories":[],"sub_categories":[],"readme":"## RapidJSON Nuget Package\r\n\r\nThis project builds an RapidJSON Nuget package with RapidJSON\r\nheader files.\r\n\r\nVisit RapidJSON website for additional information about the\r\nRapidJSON project documentation:\r\n\r\nhttps://github.com/Tencent/rapidjson\r\n\r\n## Package Configuration\r\n\r\nRapidJSON is an header-only library and does not contain any static\r\nor dynamic library modules.\r\n\r\nCMake is configured to build RapidJSON with the following feature\r\noptions:\r\n\r\n  * `RAPIDJSON_BUILD_DOC=OFF`\r\n  * `RAPIDJSON_BUILD_EXAMPLES=OFF`\r\n  * `RAPIDJSON_BUILD_TESTS=OFF`\r\n  * `RAPIDJSON_BUILD_THIRDPARTY_GTEST=OFF`\r\n  * `RAPIDJSON_HAS_STDSTRING=ON`\r\n\r\nFollowing RapidJSON flags will be enabled in the Visual Studio\r\nproject using this package:\r\n\r\n  * `RAPIDJSON_HAS_CXX11_RVALUE_REFS`\r\n  * `RAPIDJSON_HAS_STDSTRING`\r\n  * `RAPIDJSON_HAS_CXX11_NOEXCEPT`\r\n  * `RAPIDJSON_HAS_CXX11_RANGE_FOR`\r\n\r\n## RapidJSON Changes\r\n\r\nRapidJSON source that was used to create this package contains a few\r\nchanges applied in patches described in this section against the\r\nRapidJSON release indicated in the package version.\r\n\r\n### `01-c++17.patch`\r\n\r\nThis patch removes inheritance from `std::iterator` for one\r\nof RapidJSON iterators because this pattern has been deprecated\r\nin C\\+\\+17.\r\n\r\n### `02-cmake-install-prefix.patch`\r\n\r\nThis patch removes the explicit `CMAKE_INSTALL_PREFIX` reference\r\nin CMake configuration, which makes the `--prefix` option ignored\r\nwhen `cmake --install` is being run.\r\n\r\n## Building a Nuget Package\r\n\r\nThis project can build a Nuget package for RapidJSON either locally\r\nor via a GitHub workflow. In each case, following steps are taken.\r\n\r\n  * RapidJSON source archive is downloaded from RapidJSON's website and\r\n    its SHA-256 signature is verified.\r\n\r\n  * The source is patched to build in Visual C++ 2022.\r\n\r\n  * CMake is used to generate Visual Studio project files.\r\n\r\n  * VS2022 Community Edition is used to build RapidJSON libraries\r\n    locally and Enterprise Edition to build libraries on GitHub.\r\n\r\n  * Build artifacts for all platforms and configurations are\r\n    collected in staging directories under `nuget/build/native`.\r\n\r\n  * `nuget.exe` is used to package staged files with the first\r\n    three version components used as a RapidJSON version and the last\r\n    version component used as a package revision. See _Package\r\n    Version_ section for more details.\r\n\r\n  * The Nuget package built on GitHub is uploaded to [nuget.org][].\r\n    The package built locally is saved in the root project\r\n    directory.\r\n\r\n## Package Version\r\n\r\n### Package Revision\r\n\r\nNuget packages lack package revision and in order to repackage\r\nthe same upstream software version, such as RapidJSON v1.1.0,\r\nthe 4th component of the Nuget version is used to track the\r\nNuget package revision.\r\n\r\nNuget package revision is injected outside of the Nuget package\r\nconfiguration, during the package build process, and is not\r\npresent in the package specification file.\r\n\r\nSpecifically, `nuget.exe` is invoked with `-Version=1.1.0.123`\r\nto build a package with the revision `123`.\r\n\r\n### Version Locations\r\n\r\nRapidJSON version is located in a few places in this repository and\r\nneeds to be changed in all of them for a new version of RapidJSON.\r\n\r\n  * nuget/StoneSteps.RapidJSON.VS2022.Static.nuspec (`version`)\r\n  * devops/make-package.bat (`PKG_VER`, `PKG_REV`, `RAPIDJSON_SHA256`)\r\n  * .github/workflows/build-nuget-package.yml (`name`, `PKG_VER`,\r\n    `PKG_REV`, `RAPIDJSON_FNAME`, `RAPIDJSON_DNAME`, `RAPIDJSON_SHA256`)\r\n\r\n`RAPIDJSON_SHA256` ia a SHA-256 checksum of the RapidJSON package\r\nfile and needs to be updated when a new version of RapidJSON is\r\nreleased.\r\n\r\nIn the GitHub workflow YAML, `PKG_REV` must be reset to `1` (one)\r\nevery time RapidJSON version is changed. The workflow file must be\r\nrenamed with the new version in the name. This is necessary because\r\nGitHub maintains build numbers per workflow file name.\r\n\r\nFor local builds package revision is supplied on the command line\r\nand should be specified as `1` (one) for a new version of RapidJSON\r\nand incremented with every package release for the same upstream\r\nversion.\r\n\r\n### GitHub Build Number\r\n\r\nBuild number within the GitHub workflow YAML is maintained in an\r\nunconventional way because of the lack of build maturity management\r\nbetween GitHub and Nuget.\r\n\r\nFor example, using build management systems, such as Artifactory,\r\nevery build would generate a Nuget package with the same version\r\nand package revision for the upcoming release and build numbers\r\nwould be tracked within the build management system. A build that\r\nwas successfully tested would be promoted to the production Nuget\r\nrepository without generating a new build.\r\n\r\nWithout a build management system, the GitHub workflow in this\r\nrepository uses the pre-release version as a surrogate build\r\nnumber for builds that do not publish packages to nuget.org,\r\nso these builds can be downloaded and tested before the final\r\nbuild is made and published to nuget.org. This approach is not\r\nrecommended for robust production environments because even\r\nthough the final published package is built from the exact\r\nsame source, the build process may still potentially introduce \r\nsome unknowns into the final package (e.g. build VM was updated).\r\n\r\n## Building Package Locally\r\n\r\nYou can build a Nuget package locally with `make-package.bat`\r\nlocated in `devops`. This script expects VS2022 Community Edition\r\ninstalled in the default location. If you have other edition of\r\nVisual Studio, edit the file to use the correct path to the\r\n`vcvarsall.bat` file.\r\n\r\nRun `make-package.bat` from the repository root directory with a\r\npackage revision as the first argument. There is no provision to\r\nmanage build numbers from the command line and other tools should\r\nbe used for this.\r\n\r\n## Sample Application\r\n\r\nA Visual Studio project is included in this repository under\r\n`sample-rapidjson` to test the Nuget package built by this\r\nproject.\r\n\r\nIn order to build `sample-rapidjson.exe`, open Nuget Package manager\r\nin the solution and install either the locally-built Nuget package\r\nor the one from [nuget.org][].\r\n\r\n[nuget.org]: https://www.nuget.org/packages/StoneSteps.RapidJSON.VS2022.Static/\r\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstonestepsinc%2Frapidjson-nuget","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fstonestepsinc%2Frapidjson-nuget","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstonestepsinc%2Frapidjson-nuget/lists"}