|
1 | 1 | Changelog |
2 | 2 | ========= |
3 | 3 |
|
| 4 | +v0.0.4 (2021-11-04) |
| 5 | +------------------- |
| 6 | + |
| 7 | +New |
| 8 | +~~~ |
| 9 | +- Add initial pre-commit config. [Stephen L Arnold] |
| 10 | +- Add cmake module to generate coverage data. [Stephen L Arnold] |
| 11 | + |
| 12 | + * cmake module replicates makefile.am lcov/genhtml commands |
| 13 | + * tox bionic env updated to generate full coverage |
| 14 | + * move lcov to common deps in smoke workflow |
| 15 | + * note full coverage reqiures 2 passes, one with and one without |
| 16 | + the runtime socket path override (true for both autotools |
| 17 | + and cmake builds) |
| 18 | + * enabling cmake coverage also enables building test binaries; |
| 19 | + both are currently OFF by default |
| 20 | + |
| 21 | + - WITH_COVERAGE enables RIPC_BUILD_TESTING |
| 22 | + - enable RIPC_BUILD_TESTING to build test binaries only |
| 23 | +- One more (fast) workflow to test setting path ENV var. [Stephen L |
| 24 | + Arnold] |
| 25 | + |
| 26 | + * split env path, build (cmake and autotools) across ubuntu versions |
| 27 | + * note bionic lcov is too old for autotools, use cmake instead |
| 28 | +- Updates all tox envs, adds valgrind with ci workflow. [Stephen L |
| 29 | + Arnold] |
| 30 | + |
| 31 | + * valgrind args are currently hard-coded in tox.ini |
| 32 | + * uses three of five test executables |
| 33 | +- Test ccache module in conda devenv (not enbaled currently) [Stephen L |
| 34 | + Arnold] |
| 35 | + |
| 36 | + * can be used on linux; coughs broken compiler error on macos |
| 37 | +- Add FindJSONC module, update cmake cfg and recipe. [Stephen L Arnold] |
| 38 | +- Add cmake test coverage, checked with ctest build-and-test/gcovr. |
| 39 | + [Stephen L Arnold] |
| 40 | +- Add cmake module for conda env, disable windows. [Stephen L Arnold] |
| 41 | +- Add conda CI workflow, cleanup cmake options. [Stephen L Arnold] |
| 42 | +- Add local conda build recipe. [Stephen L Arnold] |
| 43 | +- Update cmake to create and install pkgconfig file. [S. Lockwood- |
| 44 | + Childs] |
| 45 | + |
| 46 | + Note that library version is still being maintained in 2 places, |
| 47 | + both CMakeLists.txt and configure.ac -- would be good to move it to |
| 48 | + a separate version file that both can share, at some point. |
| 49 | +- Update cmake to check for json-c with pkg-config. [S. Lockwood-Childs] |
| 50 | + |
| 51 | + Use consistent strategy for finding json-c and hiredis dependencies, |
| 52 | + which might be managed by pkg-config rather than native cmake modules |
| 53 | +- Add cmake build cfg, fix configure version and template typo. [Stephen |
| 54 | + L Arnold] |
| 55 | + |
| 56 | +Changes |
| 57 | +~~~~~~~ |
| 58 | +- Update pre-commit hooks, bump version for next release. [Stephen L |
| 59 | + Arnold] |
| 60 | +- Be more explicit with coverage badge. [Stephen L Arnold] |
| 61 | +- Set cmake-format intending to 4 and reformat. [Stephen L Arnold] |
| 62 | +- Add overview of gitchangelog commit message handling. [Stephen L |
| 63 | + Arnold] |
| 64 | +- Apply post-rebase pre-commit format updates. [Stephen L Arnold] |
| 65 | + |
| 66 | + * disable cmake auto-format around custom coverage command |
| 67 | +- Add some dev docs, add rst doc checks to pre-commit config. [Stephen L |
| 68 | + Arnold] |
| 69 | + |
| 70 | + * add doc8 and some pygrep hooks to validate .rst formatting |
| 71 | + * add some pre-commit dev docs, usage and config hooks |
| 72 | + * validate docs, reflow some text, fix some warnings |
| 73 | + * make ChangeLog.rst an actual .rst doc |
| 74 | +- Add pre-commit bash formatter, apply changes. [Stephen L Arnold] |
| 75 | + |
| 76 | + * update .pre-commit-config.yaml with prettysh |
| 77 | + * add prettysh to tox -e lint command |
| 78 | + * commit autogen.sh format changes |
| 79 | +- Add contributing section with pre-commit install steps. [Stephen L |
| 80 | + Arnold] |
| 81 | +- Pre-commit badge and readme cleanup. [Stephen L Arnold] |
| 82 | +- Add runtime path ENV to coverage workflow. [Stephen L Arnold] |
| 83 | + |
| 84 | + * test coverage results |
| 85 | +- Limit PPA dep installs, add setenv for tox. [Stephen L Arnold] |
| 86 | + |
| 87 | + * add setenv with override for RIPC_SERVER_PATH (auto,bionic) |
| 88 | + * reorder dep install commands, limit PPA installs (smoke) |
| 89 | + * fix bash quoting for nested quotes |
| 90 | +- Use gcovr from pip, update gcovr args for bionic. [Stephen L Arnold] |
| 91 | + |
| 92 | + * unexpected coverage output between ubuntu versions |
| 93 | +- Let cmake use socket path ENV var or path as build option. [Stephen L |
| 94 | + Arnold] |
| 95 | + |
| 96 | + * leave option empty/define unset if not found |
| 97 | + * prefer path found in env over build option |
| 98 | + * pass ENV var in tox.ini |
| 99 | +- Add section on tox commands, remove redis-ipc-py section. [Stephen L |
| 100 | + Arnold] |
| 101 | +- Json_test coughs runtime exception on macos, disable for now. [Stephen |
| 102 | + L Arnold] |
| 103 | + |
| 104 | + * tested on macos-10/11 in github (macos-10 did not run) |
| 105 | +- Bump action version, remove temporary fix for coverage data. [Stephen |
| 106 | + L Arnold] |
| 107 | +- Still more coverage refactoring. [Stephen L Arnold] |
| 108 | + |
| 109 | + * issue https://github.com/irongut/CodeCoverageSummary/issues/9 |
| 110 | +- Still has parse error, cleanup misc, disable fix, upload data. |
| 111 | + [Stephen L Arnold] |
| 112 | +- Upgrade CodeCoverageSummary action to latest, remove DTD. [Stephen L |
| 113 | + Arnold] |
| 114 | + |
| 115 | + * add more sed and rename script => fix_cov_file.sh |
| 116 | +- Add required deps, remove cruft (workflows) [Stephen L Arnold] |
| 117 | +- Add coverage workflow, update readme, nuke codecov. [Stephen L Arnold] |
| 118 | +- Test new action branch. [Stephen L Arnold] |
| 119 | +- Remove python/related files => moved to redis-ipc-py repo. [Stephen L |
| 120 | + Arnold] |
| 121 | +- Something amiss with running cccc-action container? [Stephen L Arnold] |
| 122 | + |
| 123 | + * the same smoke workflow is fine in the pcr repos |
| 124 | +- Remove python-only workflows and badges. [Stephen L Arnold] |
| 125 | +- Disable full conda workflow on PR, add dispatch to cov-test. [Stephen |
| 126 | + L Arnold] |
| 127 | +- Update readme build steps (add conda) and .gitignore. [Stephen L |
| 128 | + Arnold] |
| 129 | + |
| 130 | + * updates for deps, autotools, cmake, and conda |
| 131 | + * ignore generated environment.yml file |
| 132 | +- Remove ccache; not enough payoff, too much baggage. [Stephen L Arnold] |
| 133 | +- Add coverage/deps for devenv workflow, fix matrix. [Stephen L Arnold] |
| 134 | +- Remove macos until more debug, re-enable ccache on linux. [Stephen L |
| 135 | + Arnold] |
| 136 | +- Use conda-dev/env setup for conda-dev workflow. [Stephen L Arnold] |
| 137 | +- General build cleanup in cmake cfg and conda recipe. [Stephen L |
| 138 | + Arnold] |
| 139 | + |
| 140 | + * disable cmake modules, prefer pkg-config over find_package |
| 141 | + * adjust conda recipe deps and tests, add extra macos flags |
| 142 | +- Disable conda-dev and try full conda workflow. [Stephen L Arnold] |
| 143 | +- Switch generators, add cmake threads_init, test macos exc. [Stephen L |
| 144 | + Arnold] |
| 145 | + |
| 146 | + * json_test coughs an exception on macos, syscall warning |
| 147 | +- Add pkg-config dep and FindPython module. [Stephen L Arnold] |
| 148 | +- Use agnostic build-test command across all platforms. [Stephen L |
| 149 | + Arnold] |
| 150 | + |
| 151 | +Fixes |
| 152 | +~~~~~ |
| 153 | +- Add missing arg in readme example. [Stephen L Arnold] |
| 154 | +- Document fixes and pre-commit autoupdates. [Stephen L Arnold] |
| 155 | +- Improve gitchangelog config, populate ChangeLog => ..v0.0.3. [Stephen |
| 156 | + L Arnold] |
| 157 | + |
| 158 | + * use updated cfg with built-in rest_py for ChangeLog.rst |
| 159 | + * add experimental md template file for release page |
| 160 | + * add initial gitchangelog doc, update readme |
| 161 | +- Pre-commit whitespace/eol cleanup commit. [Stephen L Arnold] |
| 162 | +- Tweak pre-commit cfg, apply cmake/shell changes. [Stephen L Arnold] |
| 163 | + |
| 164 | + * yaml checks cough parse error on std conda meta.yaml format |
| 165 | + * cmake-format needs fencing/rulers to mark comments |
| 166 | + * add excludes and fence markers |
| 167 | + * restore missing clang toolchain file |
| 168 | +- Local autotools env and small nit in PR coverage xml report names. |
| 169 | + [Stephen L Arnold] |
| 170 | + |
| 171 | + * isolate internal env, override via ENV_RIPC_RUNTIME_DIR |
| 172 | + * define package (internal) env var names using tox defaults |
| 173 | + * move tox env commands to replicate workflow |
| 174 | +- Create both html coverage reports, add inc/ dir to metrics artifact. |
| 175 | + [Stephen L Arnold] |
| 176 | + |
| 177 | + * create both html reports, one for functions and one for branches |
| 178 | + * note each report is created via separate tox cmds |
| 179 | + * sync up metrics source code with coverage |
| 180 | + * update conda devenv file, use Ninja generator |
| 181 | + |
| 182 | + Signed-off-by: Stephen L Arnold <nerdboy@gentoo.org> |
| 183 | + |
| 184 | + chg: dev: py38/39 is not resolving deps like 37, remove jinja py ver |
| 185 | + |
| 186 | + * this should really not be necessary, somehow devenv is inconsistent |
| 187 | + * it should work fine across all python versions 36 => 39 |
| 188 | + * even on macos |
| 189 | +- Cleanup ci cmds (per OS env), add python dep for conda devenv. |
| 190 | + [Stephen L Arnold] |
| 191 | + |
| 192 | + * bionic lcov is too old for required include usage |
| 193 | + * devenv needs jinja python dep per CI version |
| 194 | +- Cleanup coverage flags, upload coverage report. [Stephen L Arnold] |
| 195 | + |
| 196 | + * speedup: switch coverage workflow to ctest |
| 197 | + * cleanup: make sure covrage builds are identical |
| 198 | + * add cov report artifact upload to smoke workflow (no gh-pages branch yet) |
| 199 | + * add/update coverage cfgs and tox commands |
| 200 | +- Remove stale results until next scan (cov-test workflow) [Stephen L |
| 201 | + Arnold] |
| 202 | + |
| 203 | + * add check for data file before triggering convert/upload steps |
| 204 | +- Use local lcov config file for make cov, fix name in ci. [Stephen L |
| 205 | + Arnold] |
| 206 | +- Refactor coverage generation/reporting, add fix script. [Stephen L |
| 207 | + Arnold] |
| 208 | + |
| 209 | + * add autobuild to tox, use lcov => gcovr for report |
| 210 | + * xml seems more compliant, except for pkg name="." |
| 211 | + * add fix_pkg_name.sh and run it in coverage workflow |
| 212 | +- Sort out coverage config, enable debug for branches/lines. [Stephen L |
| 213 | + Arnold] |
| 214 | +- Switch metrics action to latest release => 0.3. [Stephen L Arnold] |
| 215 | + |
| 216 | + * fixes metrics report artifact uploads |
| 217 | +- Remove action options until gh-pages branch is pushed. [Stephen L |
| 218 | + Arnold] |
| 219 | + |
| 220 | + * add readme note about python module move |
| 221 | +- Make sure autotools and cmake use the same soname/version. [Stephen L |
| 222 | + Arnold] |
| 223 | + |
| 224 | + * add missing configure check for pthreads (autotools) |
| 225 | + * allow SCM_VERSION to override static version (cmake) |
| 226 | +- Restore missing target property versions. [Stephen L Arnold] |
| 227 | +- Set recipe soversion, add include guard for unistd.h !win. [Stephen L |
| 228 | + Arnold] |
| 229 | + |
| 230 | +Other |
| 231 | +~~~~~ |
| 232 | +- Revert macos ci test. [Stephen L Arnold] |
| 233 | +- Update version in configure.ac, fix typo and check macos. [Stephen L |
| 234 | + Arnold] |
| 235 | +- Json.hh: make cpplint happier. [S. Lockwood-Childs] |
| 236 | +- Json.hh: throw custom exception for missing fields. [S. Lockwood- |
| 237 | + Childs] |
| 238 | + |
| 239 | + caller might want to specifically know about missing fields, |
| 240 | + so make that a specific exception that can be caught |
| 241 | +- Json.hh: fix json constructor from json_object ptr. [S. Lockwood- |
| 242 | + Childs] |
| 243 | + |
| 244 | + * if ptr is null, create an empty object |
| 245 | + * if ptr is non-null, take a reference on it so it will not |
| 246 | + get freed until json wrapper object is done with it |
| 247 | +- Fix package_version var for cmake and autotools. [Stephen L Arnold] |
| 248 | +- Add cmake-format cfg file, apply formatting updates. [Stephen L |
| 249 | + Arnold] |
| 250 | + |
| 251 | + * this seems to keep more of the original format |
| 252 | + * although it does add more dangling close-parens |
| 253 | +- Restore gcovr funtion report to coverage artifact. [Stephen L Arnold] |
| 254 | +- Fix generated pkgconfig file. [S. Lockwood-Childs] |
| 255 | + |
| 256 | + Now the @prefix@ in redis-ipc.pc.in should get substituted when building |
| 257 | + with cmake (already worked for autotools builds) |
| 258 | +- Update smoke/runtime workflows to use lcov from PPA on bionic. |
| 259 | + [Stephen L Arnold] |
| 260 | +- Configurable path to redis server socket. [S. Lockwood-Childs] |
| 261 | + |
| 262 | + * compile-time configuration with RIPC_RUNTIME_DIR |
| 263 | + * with cmake |
| 264 | + cmake -DRIPC_RUNTIME_DIR=/var/tmp/redis-ipc |
| 265 | + * with automake |
| 266 | + export RIPC_RUNTIME_DIR=/var/tmp/redis-ipc ./configure |
| 267 | + |
| 268 | + In each case, default path will be $RIPC_RUNTIME_DIR/socket |
| 269 | + Note that matches the usage of RIPC_RUNTIME_DIR in scripts/run_redis.sh |
| 270 | + If you set RIPC_RUNTIME_DIR when building, use the same value |
| 271 | + when using run_redis.sh to setup for tests. |
| 272 | + |
| 273 | + Path can be overrident at runtime by setting RIPC_SERVER_PATH |
| 274 | + NOTE this is full path, not just the parent dir like RIPC_RUNTIME_DIR: |
| 275 | + export RIPC_SERVER_PATH=/var/tmp/redis-ipc/socket |
| 276 | +- Allow building deb from git repo. [S. Lockwood-Childs] |
| 277 | + |
| 278 | + Make dpkg-buildpackage not require a pre-existing source tarball |
| 279 | +- Include pkgconfig when building deb. [S. Lockwood-Childs] |
| 280 | + |
| 281 | + Also removed python from deb packaging, since it moved to separate repo |
| 282 | +- Sync with deb packaging files from PPA. [S. Lockwood-Childs] |
| 283 | + |
| 284 | + PPA is at https://launchpad.net/~nerdboy/+archive/ubuntu/embedded |
| 285 | +- Cheg: dev: test temp fix for coverage workflow data parse error. |
| 286 | + [Stephen L Arnold] |
| 287 | + |
| 288 | + * remove temp fix when upstream issue is fixed |
| 289 | + * limit metrics collection to src/ directory only |
| 290 | + * adjust gcovr cmd root/path args, cleanup cruft |
| 291 | +- Updated coverity results from after cleanup commit. [S. Lockwood- |
| 292 | + Childs] |
| 293 | +- Clean up current detections from code scanners. [S. Lockwood-Childs] |
| 294 | +- Fix dev: use correct syntax in last devenv workflow step. [Stephen L |
| 295 | + Arnold] |
| 296 | +- Use new action release and set source directories for analysis. |
| 297 | + [Stephen L Arnold] |
| 298 | +- Update recipe, add pkg-config to test commands, disable inspect. |
| 299 | + [Stephen L Arnold] |
| 300 | +- Add develop branch to all workflowa, inspect conda pkgs. [Stephen L |
| 301 | + Arnold] |
| 302 | +- Dis-able conda dev workflow, debug on macos (segfault) [Stephen L |
| 303 | + Arnold] |
| 304 | +- Revert msvc include changes, re-enable conda-dev workflow. [Stephen L |
| 305 | + Arnold] |
| 306 | +- Remove windows (msvc) from CI workflows and conda recipe. [Stephen L |
| 307 | + Arnold] |
| 308 | +- Add more (win) build deps, tweak simple pkg tests. [Stephen L Arnold] |
| 309 | +- Set install libdir, update host deps and build scripts. [Stephen L |
| 310 | + Arnold] |
4 | 311 |
|
5 | 312 | v0.0.3 (2021-08-20) |
6 | 313 | ------------------- |
|
0 commit comments