serious-scaffold / ss-cpp Goto Github PK

View Code? Open in Web Editor NEW

11.0 3.0 1.0 5.56 MB

A continuously evolving basic template for cpp development practice.

Home Page: https://serious-scaffold.github.io/ss-cpp/

License: MIT License

CMake 24.27% C++ 0.73% Jinja 71.35% JavaScript 1.44% Makefile 1.78% CSS 0.42%

project-template copier-template copier vcpkg cmake-presets cmake-template cpp-programming

ss-cpp's People

Contributors

Stargazers

Watchers

Forkers

msclock

ss-cpp's Issues

Improve ducument readability for the template integration

Add the testable ability to executable

Leave implementation in a header-only or compile target makes more managable.

Action Required: Fix Renovate Configuration

There is an error with this repository's Renovate configuration that needs to be fixed. As a precaution, Renovate will stop PRs until it is resolved.

Location: .renovaterc.json
Error type: Invalid JSON (parsing failed)
Message: Syntax error near ],

Remove Changelog generation

It seems the changelog generation is not necessary on the modern platform. Moreover, we have annotated the release tags with release change notes.

Extract samples from template to include

docs related.
readme and description.

Explictly declare dependency version

Automation release configuration prefer to double qoutes to create annotated tags

Single qoute may fail to update tags using release notes from semantic release.

Fix coverage missing

rename and add targets cause coverage missing on targets.

Disable scaffold maintained items are generated

Add a swig integration example

feat: use cmake modules from a vcpkg registry

Move cmake module utility to a vcpkg registry is more repducible and maintainable.

Docs build warning with cpp declaration GIT_EXTERN_C_BEGIN

Standardize the release workflow

Semantic Release
- Docs section about release workflow. #106
- No release rebasing and merging: no-release scope. #103
- Release workflow CI. #102, #105
Standard Commit convention:
- ~~Constraint commit message lint~~. (skip)
- Docs section about commit convention. #106

Customize the generation of cmake targets under src

Rename targets to conform the determined features

rename app to executable to feature an executable target
rename api to compile to feature a compile library target
rename header to header_only to feature a header only library target

Add a consistent checker to the repo

For enhancing maintainability, a consistent check should be enabled to possible conflict changes.

Security enhancements

fd:

Configurable compiler options. #166
Hardening compilation. #178
Configurable valgrind. #167
Cppcheck. #168
~~Fuzz tests~~. (skip)
Configureble sanitizers. #165
Security relevant documentation. #179

Add an approval action for the bot prs

See https://github.com/hmarr/auto-approve-action

fail to add dependencies to ccov-all with ${CMAKE_PROJECT_NAME}_docs

Because the lack of doxygen, no ${CMAKE_PROJECT_NAME}_docs target is generated , so it failed to add the target as a pre-dependency to ccov-all of the coverage configuration.

Auto target machine detection

fd:

make it automatically detect compiling triplets and compilers on the host system.

Commit Convention

Standard Commit convention:
- Constraint commit message lint.
- Docs section about commit convention.

Integrate performance ananysis tools

Use the GoogleTest module from cmake_module

Attach changelog to sphinx docs

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

chore(deps): update actions/upload-artifact digest to 834a144
chore(deps): update dependency watchfiles to v0.23.0
chore(deps): update github/codeql-action action to v3.26.0
Click on this checkbox to rebase all open PRs at once

Ignored or Blocked

These are blocked by an existing closed PR and will not be recreated unless you click a checkbox below.

chore(deps): update dependency macos to v14

Detected dependencies

github-actions

.github/workflows/cd.yml

actions/checkout v4@692973e3d937129bcbf40652eb9f2f61becf3332

actions/cache v4@0c45773b623bea8c8e75f6c82b208c3cf94ea4f9

aminya/setup-cpp v1

actions/setup-python v5@39cd14951b08e74b54015e9e001cdefcf80e669f

peaceiris/actions-gh-pages v4@4f9cc6602d3f66b9c108549d475ec49e8ef4d45e

ubuntu 22.04

.github/workflows/ci.yml

actions/checkout v4@692973e3d937129bcbf40652eb9f2f61becf3332

actions/setup-python v5@39cd14951b08e74b54015e9e001cdefcf80e669f

pre-commit/action v3.0.1@2c7b3805fd2a0fd8c1884dcaebf91fc102a13ecd

actions/checkout v4@692973e3d937129bcbf40652eb9f2f61becf3332

actions/setup-python v5@39cd14951b08e74b54015e9e001cdefcf80e669f

actions/checkout v4@692973e3d937129bcbf40652eb9f2f61becf3332

actions/cache v4@0c45773b623bea8c8e75f6c82b208c3cf94ea4f9

aminya/setup-cpp v1

actions/checkout v4@692973e3d937129bcbf40652eb9f2f61becf3332

actions/cache v4@0c45773b623bea8c8e75f6c82b208c3cf94ea4f9

actions/checkout v4@692973e3d937129bcbf40652eb9f2f61becf3332

actions/cache v4@0c45773b623bea8c8e75f6c82b208c3cf94ea4f9

aminya/setup-cpp v1

actions/checkout v4@692973e3d937129bcbf40652eb9f2f61becf3332

actions/cache v4@0c45773b623bea8c8e75f6c82b208c3cf94ea4f9

aminya/setup-cpp v1

actions/setup-python v5@39cd14951b08e74b54015e9e001cdefcf80e669f

actions/checkout v4@692973e3d937129bcbf40652eb9f2f61becf3332

actions/cache v4@0c45773b623bea8c8e75f6c82b208c3cf94ea4f9

aminya/setup-cpp v1

actions/checkout v4@692973e3d937129bcbf40652eb9f2f61becf3332

actions/cache v4@0c45773b623bea8c8e75f6c82b208c3cf94ea4f9

aminya/setup-cpp v1

actions/upload-artifact v4@0b2256b8c012f0828dc542b3febcab082c67f72b

actions/checkout v4@692973e3d937129bcbf40652eb9f2f61becf3332

actions/cache v4@0c45773b623bea8c8e75f6c82b208c3cf94ea4f9

aminya/setup-cpp v1

actions/setup-python v5@39cd14951b08e74b54015e9e001cdefcf80e669f

actions/checkout v4@692973e3d937129bcbf40652eb9f2f61becf3332

actions/cache v4@0c45773b623bea8c8e75f6c82b208c3cf94ea4f9

actions/checkout v4@692973e3d937129bcbf40652eb9f2f61becf3332

actions/cache v4@0c45773b623bea8c8e75f6c82b208c3cf94ea4f9

aminya/setup-cpp v1

actions/setup-python v5@39cd14951b08e74b54015e9e001cdefcf80e669f

actions/checkout v4@692973e3d937129bcbf40652eb9f2f61becf3332

actions/cache v4@0c45773b623bea8c8e75f6c82b208c3cf94ea4f9

aminya/setup-cpp v1

codecov/codecov-action v4.5.0@e28ff129e5465c2c0dcc6f003fc735cb6ae0c673

actions/checkout v4@692973e3d937129bcbf40652eb9f2f61becf3332

actions/cache v4@0c45773b623bea8c8e75f6c82b208c3cf94ea4f9

aminya/setup-cpp v1

actions/checkout v4@692973e3d937129bcbf40652eb9f2f61becf3332

actions/cache v4@0c45773b623bea8c8e75f6c82b208c3cf94ea4f9

aminya/setup-cpp v1

actions/checkout v4@692973e3d937129bcbf40652eb9f2f61becf3332

actions/cache v4@0c45773b623bea8c8e75f6c82b208c3cf94ea4f9

aminya/setup-cpp v1

actions/checkout v4@692973e3d937129bcbf40652eb9f2f61becf3332

actions/cache v4@0c45773b623bea8c8e75f6c82b208c3cf94ea4f9

aminya/setup-cpp v1

actions/checkout v4@692973e3d937129bcbf40652eb9f2f61becf3332

actions/cache v4@0c45773b623bea8c8e75f6c82b208c3cf94ea4f9

aminya/setup-cpp v1

actions/setup-python v5@39cd14951b08e74b54015e9e001cdefcf80e669f

re-actors/alls-green release/v1

hmarr/auto-approve-action v4

ubuntu 22.04

ubuntu 22.04

ubuntu 22.04

macos 12

windows 2022

windows 2022

ubuntu 22.04

ubuntu 22.04

ubuntu 22.04

macos 12

ubuntu 22.04

ubuntu 22.04

ubuntu 22.04

ubuntu 22.04

ubuntu 22.04

ubuntu 22.04

ubuntu 22.04

ubuntu 22.04

.github/workflows/codeql.yml

actions/checkout v4@692973e3d937129bcbf40652eb9f2f61becf3332

github/codeql-action v3.25.15@afb54ba388a7dca6ecae48f608c4ff05ff4cc77a

actions/cache v4@0c45773b623bea8c8e75f6c82b208c3cf94ea4f9

aminya/setup-cpp v1

github/codeql-action v3.25.15@afb54ba388a7dca6ecae48f608c4ff05ff4cc77a

ubuntu 22.04

.github/workflows/renovate.yml

actions/create-github-app-token v1@31c86eb3b33c9b601a1f60f98dcbfd1d70f379b4

ghcr.io/renovatebot/renovate 38.25.0@sha256:865a090f3087b6fea74e0a1e02acfd33285ad1ebe3f4af32f51d8bbdd7f77a2a

ubuntu 22.04

.github/workflows/semantic-release.yml

actions/create-github-app-token v1@31c86eb3b33c9b601a1f60f98dcbfd1d70f379b4

actions/checkout v4@692973e3d937129bcbf40652eb9f2f61becf3332

actions/setup-node v4@1e60f620b9541d16bece96c5465dc8ee9832be0b

cycjimmy/semantic-release-action v4

ubuntu 22.04

pre-commit

.pre-commit-config.yaml

pre-commit/pre-commit-hooks v4.6.0

macisamuele/language-formatters-pre-commit-hooks v2.14.0

Lucas-C/pre-commit-hooks v1.5.5

cheshirekow/cmake-format-precommit v0.6.13

codespell-project/codespell v2.3.0

shellcheck-py/shellcheck-py v0.9.0.6

pre-commit/mirrors-clang-format v18.1.8

igorshubovych/markdownlint-cli v0.41.0

renovatebot/pre-commit-hooks 38.25.0

regex

.github/workflows/ci.yml

copier 9.3.1

gcovr 7.2

clang-tidy 18.1.8

copier 9.3.1

.renovaterc.json

copier 9.3.1

Makefile

copier 9.3.1

pre-commit 3.8.0

watchfiles 0.22.0

template/.renovaterc.json.jinja

copier 9.3.1

template/Makefile.jinja

copier 9.3.1

pre-commit 3.8.0

watchfiles 0.22.0

template/[% if repo_platform == 'github' %].github[% endif %]/workflows/ci.yml.jinja

copier 9.3.1

gcovr 7.2

clang-tidy 18.1.8

copier 9.3.1

vcpkg.json

https://github.com/microsoft/vcpkg master@e590c2b30c08caf1dd8d612ec602a003f9784b7d

vcpkg.json

https://github.com/msclock/cmake-registry master@d10ff665fa09df91d0df85679bb91b8e9a89174f

Add a authentication example

alternatives:

https://github.com/weidai11/cryptopp: all
https://github.com/jedisct1/libhydrogen: all
https://github.com/jedisct1/libsodium: all
https://github.com/besser82/libxcrypt : linux
https://github.com/gpg/libgcrypt: !windows | mingw
https://github.com/ThePhD/infoware: all

Mantainable vcpkg dependency based on baseline

fd:

detect vcpkg dependency based on the registry baseline.

Add sphinx document build integration

Bind sphinx build to readthedocs.com

Using export mode with vcpkg manifest mode

vcpkg works with the export artifacts now,see https://devblogs.microsoft.com/cppblog/vcpkg-2023-10-19-release-export-for-manifests-documentation-improvements-and-more/

Manually export routine with manifest configured dependencies:

    vcpkg install --triplet=x64-windows --host-triplet=x64-windows
    vcpkg export --raw --triplet=x64-windows --host-triplet=x64-windows --output=x64-windows --output-dir=export

Rename repo_host to repo_platform

See serious-scaffold/ss-python#533

Add a wxWidget integration example

Missing debug dll on windows with the cmake module OSInstall.cmake

After executing cmake install, the debug distribution libs, such as msvcp140d.dll, vcruntime140d.dll, are reported as missing.

Make cpm/conan as a option based on copier.

Add custom configuration based on vcpkg integration

add a native plugin example

alternatives:

https://github.com/boostorg/dll

feat: convert to copier template

Release built artifacts

Add CI jobs to release built artifacts after semantic-release job.

Standardize the release workflow

Processing:

Semantic Release
- Docs section about release workflow.
- No release rebasing and merging: no-release scope.
- Release workflow CI
Standard Commit convention:
- Constraint commit message lint.
- Docs section about commit convention.

put export include to target build directories

Previously, it was easy to cause confusion by placing the generated export header files in the build root directory. Now it is more reasonable to place them in the corresponding build source directory.