diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml deleted file mode 100644 index 8ad5013..0000000 --- a/.github/workflows/docs.yml +++ /dev/null @@ -1,19 +0,0 @@ -name: docs - -on: - pull_request: - branches: - - main - -permissions: - contents: read - -jobs: - docs: - runs-on: ubuntu-latest - steps: - - uses: compas-dev/compas-actions/docs@v1 - with: - python-version: "3.11" - extras: dev - strict: false diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 96928b7..f58c423 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -45,9 +45,6 @@ jobs: needs: [release, prepare] if: needs.release.outputs.is-release == 'true' runs-on: ubuntu-latest - environment: - name: pypi - url: https://pypi.org/p/compas-threejs permissions: contents: read id-token: write diff --git a/CHANGELOG.md b/CHANGELOG.md index 38d413d..5b23413 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -11,6 +11,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ### Changed +- Aligned the release pipeline with `compas_pb` so publishing from `main` can proceed to GitHub release creation and documentation deployment +- Added package, Python, license, build, documentation, and COMPAS badges to the README +- Consolidated documentation automation in the release workflow + ### Removed diff --git a/README.md b/README.md index 8230306..bab9f37 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,14 @@ # COMPAS ThreeJS +

+ PyPI version + Python versions + License MIT + Build Status + Documentation + Made with COMPAS +

+ `compas_threejs` is a browser-based 3D viewer for COMPAS geometry. The Python package serves a bundled Three.js frontend and exchanges geometry, scene, and interaction messages through COMPAS Protobuf and WebSockets. @@ -27,7 +36,7 @@ The viewer runs until interrupted with `Ctrl+C`. - [TypeScript viewer](https://github.com/compas-dev/compas_threejs_ts) - [COMPAS](https://github.com/compas-dev/compas) -- [COMPAS Protobuf](https://github.com/gramaziokohler/compas_pb) +- [COMPAS Protobuf](https://github.com/compas-dev/compas_pb) ## License