Skip to content

Commit

Permalink
docs: prepare for 0.4.0 (#322)
Browse files Browse the repository at this point in the history
Added one small feature (`cmake.source-dir`), so this is a 0.4.0
release.

---------

Signed-off-by: Henry Schreiner <[email protected]>
  • Loading branch information
henryiii authored May 19, 2023
1 parent 4de2dfa commit 4e84930
Show file tree
Hide file tree
Showing 3 changed files with 37 additions and 8 deletions.
29 changes: 29 additions & 0 deletions docs/changelog.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,34 @@
# Changelog

## Version 0.4.0

An important fix/feature: LICENSE files were not being included in the wheel's
metadata folder. You can configure the license file selection via a new
configuration option, and a reasonable default was added. You can now select a
source directory for your CMakeLists.txt. A lot of work was done on the still
experimental setuptools backend; it still should be seen as completely
experimental while it is being finished.

Features:

- `cmake.source-dir` for CMakeLists in subdirectories by @henryiii in #323
- Add `LICENSE` file option by @henryiii in #321

Fixes:

- Ninja wasn't being used if present by @henryiii in #310
- Wheels were not including the `LICENSE` file by @henryiii in #321

Setuptools plugin:

- Refactor plugin as custom setuptools command by @henryiii in #312
- Adding `cmake_args` by @henryiii in #314
- Add wrapper for `skbuild.setup` compat by @henryiii in #315

Other:

- ci: add rpmlint and smoke tests by @LecrisUT in #313

## Version 0.3.3

This version improves WebAssembly support (Pyodide) and fixes a reported bug in
Expand Down
14 changes: 7 additions & 7 deletions docs/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -380,15 +380,15 @@ CMAKE_ARGS: -DSOME_DEFINE=ON;-DOTHER=OFF
````

## Dynamic metadata (WIP)
## Dynamic metadata

Scikit-build-core 0.3.0 will support dynamic metadata. This is not ready for
plugin development outside of scikit-build-core;
`tool.scikit-build.experimental=true` is required to use external plugins, since
the interface is provisional. Nested arbitrary dicts (as seen here) are not
supported in config-settings or environment variables.
Scikit-build-core 0.3.0 supports dynamic metadata with two built-in plugins.

There currently are two built-in plugins for dynamic metadata.
:::{warning}

This is not ready for plugin development outside of scikit-build-core;
`tool.scikit-build.experimental=true` is required to use plugins that are not
shipped with scikit-build-core, since the interface is provisional. :::

:::{tab} Setuptools-scm

Expand Down
2 changes: 1 addition & 1 deletion src/scikit_build_core/setuptools/build_cmake.py
Original file line number Diff line number Diff line change
Expand Up @@ -159,7 +159,7 @@ def run(self) -> None:
builder.build(build_args=build_args)
builder.install(Path(self.build_lib))

# def get_source_files(self) -> list[str]:
# def "get_source_file+ys"(self) -> list[str]:
# return ["CMakeLists.txt"]

# def get_outputs(self) -> list[str]:
Expand Down

0 comments on commit 4e84930

Please sign in to comment.