Repository navigation
Prepare the first release: packaging, license texts, docs site, release workflow - #2
Merged
Merged
Conversation
- pyproject.toml: classifiers, keywords, project URLs, dev and docs extras, ruff settings (as in compas_fab), and the bump-my-version configuration compas-actions releases with. The version starts at 0.0.0 (compas-actions accepts plain X.Y.Z only); the first release bumps it to 0.1.0. - CHANGELOG.md in the Keep a Changelog layout compas-actions expects. - licenses/THIRD_PARTY_RUST.txt: license texts of the 59 Rust crates compiled into the extension, generated with cargo-about (about.toml, about.hbs), MIT preferred where a crate offers a choice. Wheels ship it with the other license files. - __version__, and no more "spike" in the package and bindings docs. - Imports sorted with compas_fab as a third-party package. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
- README and the docs home page: pip install compas_fab_native, which platforms have wheels, how to develop and how to release. - mkdocs site in the compas_fab style (material, mike, mkdocstrings): home, how it works, API reference, changelog, license. - Links to SPIKE.md point to GitHub, since it lives outside docs/. - Demo README: the UR description's license file is in compas_fab. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
- prepare-release.yml opens a release pull request (version bump and dated changelog); merging it runs release.yml. - release.yml: detects the release merge, builds and tests the wheels and the sdist through wheels.yml, checks their versions and metadata, publishes to PyPI with trusted publishing, creates the GitHub release and deploys the docs with mike. - wheels.yml can be called by release.yml, also builds the sdist, and tests a build from it. - pr-checks.yml: release metadata and changelog checks. - docs.yml: strict docs build on pull requests. - ci.yml: ruff, and a check that the shipped Rust license texts match Cargo.lock. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Sets up the first release: packaging metadata, versioning, changelog, the license texts of the Rust crates in the wheel, a docs site, and the release workflow on
compas-dev/compas-actions@v1, followingcompas_pb. Stacked on #1, which should be merged first.Releasing, once this is merged
minor). It opensrelease/v0.1.0, which bumps the version and dates the changelog.What's here
0.0.0incrates/motion_py/Cargo.toml, where maturin reads it. compas-actions accepts plainX.Y.Zonly, so the first release PR bumps it to0.1.0.[tool.bumpversion]also coversCargo.lock,__version__and the changelog heading, which are the only files a release may change.release.ymlcallswheels.yml, so the release builds and tests exactly what CI does: Linux x86_64, macOS universal2 and Windows x64 wheels on Python 3.9 and 3.13, plus an sdist built and tested from scratch. Before publishing, it checks that every file carries the release version and passestwine check --strict. Publishing uses PyPI trusted publishing, so there are no tokens.licenses/THIRD_PARTY_RUST.txtholds the licenses of the 59 crates compiled into the extension, generated with cargo-about (MIT where a crate offers a choice). Wheels and the sdist ship it. A CI job fails if it drifts fromCargo.lock.devanddocsextras, and ruff settings as in compas_fab (import sorting fixed accordingly). The repo description, homepage, topics and theno changeloglabel are already set.pip install compas_fab_nativeand drop the "spike" wording.Checked locally
bump-my-version1.3.0minorgives exactly the five allowed files,Cargo.lockstays consistent, compas-actions'check_release.pyreportsis-release=true,v0.1.0, and maturin buildscompas_fab_native-0.1.0.LICENSE,NOTICEand all oflicenses/, andtwine check --strictpasses.mkdocs build --strictpasses; 40 Python tests, the six examples, ruff and cargo fmt pass.Expect once
The release metadata check fails on this PR, and the release detection fails once on the merge to
main.mainhas no[tool.bumpversion]yet, so there's no version to compare against. From the next PR on, there is.Needed outside this PR
compas_fab_native: ownercompas-dev, repositorycompas_fab_native, workflowrelease.yml, environmentpypi.gh-pages, enable Pages from that branch. The site should then appear at compas.dev/compas_fab_native, as compas_pb's does.🤖 Generated with Claude Code