diff --git a/docs/addons/anim_cupboard.md b/docs/addons/anim_cupboard.md index baa431c0..32ddfa86 100644 --- a/docs/addons/anim_cupboard.md +++ b/docs/addons/anim_cupboard.md @@ -1,5 +1 @@ - -## -# Changelog - - + \ No newline at end of file diff --git a/docs/addons/asset_pipeline.md b/docs/addons/asset_pipeline.md index e690c0fa..010fac7e 100644 --- a/docs/addons/asset_pipeline.md +++ b/docs/addons/asset_pipeline.md @@ -1,5 +1 @@ - -## -# Changelog - - + \ No newline at end of file diff --git a/docs/addons/blender_kitsu.md b/docs/addons/blender_kitsu.md index fae2849a..7da122ce 100644 --- a/docs/addons/blender_kitsu.md +++ b/docs/addons/blender_kitsu.md @@ -1,5 +1 @@ - -## -# Changelog - - + \ No newline at end of file diff --git a/docs/addons/blender_svn.md b/docs/addons/blender_svn.md index 98b6c8a8..7f139644 100644 --- a/docs/addons/blender_svn.md +++ b/docs/addons/blender_svn.md @@ -1,5 +1 @@ - -## -# Changelog - - + \ No newline at end of file diff --git a/docs/addons/bone_gizmos.md b/docs/addons/bone_gizmos.md index f716a1e7..4de721af 100644 --- a/docs/addons/bone_gizmos.md +++ b/docs/addons/bone_gizmos.md @@ -1,5 +1 @@ - -## -# Changelog - - + \ No newline at end of file diff --git a/docs/addons/cache_manager.md b/docs/addons/cache_manager.md index aefb4920..bbb81cd9 100644 --- a/docs/addons/cache_manager.md +++ b/docs/addons/cache_manager.md @@ -1,5 +1 @@ - -## -# Changelog - - + \ No newline at end of file diff --git a/docs/addons/contactsheet.md b/docs/addons/contactsheet.md index c8bd7b4b..6073aa74 100644 --- a/docs/addons/contactsheet.md +++ b/docs/addons/contactsheet.md @@ -1,5 +1 @@ - -## -# Changelog - - + \ No newline at end of file diff --git a/docs/addons/easy_weights.md b/docs/addons/easy_weights.md index df254a52..838cbb82 100644 --- a/docs/addons/easy_weights.md +++ b/docs/addons/easy_weights.md @@ -1,5 +1 @@ - -## -# Changelog - - + \ No newline at end of file diff --git a/docs/addons/geonode_shapekeys.md b/docs/addons/geonode_shapekeys.md index 68e9a400..ffbae192 100644 --- a/docs/addons/geonode_shapekeys.md +++ b/docs/addons/geonode_shapekeys.md @@ -1,5 +1 @@ - -## -# Changelog - - + \ No newline at end of file diff --git a/docs/addons/grease_converter.md b/docs/addons/grease_converter.md index a664a35b..13c8fe7f 100644 --- a/docs/addons/grease_converter.md +++ b/docs/addons/grease_converter.md @@ -1,5 +1 @@ - -## -# Changelog - - + \ No newline at end of file diff --git a/docs/addons/lattice_magic.md b/docs/addons/lattice_magic.md index e7ec8f3e..eb79f3e9 100644 --- a/docs/addons/lattice_magic.md +++ b/docs/addons/lattice_magic.md @@ -1,4 +1 @@ - -## -# Changelog - + \ No newline at end of file diff --git a/docs/addons/lighting_overrider.md b/docs/addons/lighting_overrider.md index 0c4b4c78..55b8e901 100644 --- a/docs/addons/lighting_overrider.md +++ b/docs/addons/lighting_overrider.md @@ -1,4 +1 @@ - -## -# Changelog - + \ No newline at end of file diff --git a/docs/addons/overview.md b/docs/addons/overview.md index caa4b15f..58cbf3e9 100644 --- a/docs/addons/overview.md +++ b/docs/addons/overview.md @@ -1 +1 @@ - \ No newline at end of file + \ No newline at end of file diff --git a/docs/addons/pose_shape_keys.md b/docs/addons/pose_shape_keys.md index 1127b186..c165d00f 100644 --- a/docs/addons/pose_shape_keys.md +++ b/docs/addons/pose_shape_keys.md @@ -1,4 +1 @@ - -## -# Changelog - + \ No newline at end of file diff --git a/docs/addons/render_review.md b/docs/addons/render_review.md index 0fc84298..64de3a16 100644 --- a/docs/addons/render_review.md +++ b/docs/addons/render_review.md @@ -1,4 +1 @@ - -## -# Changelog - + \ No newline at end of file diff --git a/scripts-blender/README.md b/scripts-blender/README.md index 0fa4d88d..c7aa1251 100644 --- a/scripts-blender/README.md +++ b/scripts-blender/README.md @@ -1,7 +1,9 @@ -# Blender Add-ons +# Blender Studio Add-ons Add-ons used by the Blender Studio pipeline. To review or report issues visit the [Blender-Studio-Pipeline](https://projects.blender.org/studio/blender-studio-pipeline/issues) issues board. +Download release packages of the below add-ons from the [Releases Page](https://projects.blender.org/studio/blender-studio-pipeline/releases). + | Add-on | Description | |---|---| |Anim Cupboard |Miscellaneous tools for animators. @@ -19,7 +21,3 @@ Add-ons used by the Blender Studio pipeline. To review or report issues visit th |Lighting Overrider |Create, manage and apply python overrides in a flexible and reliable way. |Pose Shape Keys |Manage and maintain shapekeys for rigging. |Render Review |Review renders from Flamenco with the sequence editor. - -Download release packages of the above add-ons from the [Add-on Release Table](https://studio.blender.org/pipeline/addons/overview) page. - -Download previous release of the above add-ons from the [Releases](https://projects.blender.org/studio/blender-studio-pipeline/releases) page. \ No newline at end of file diff --git a/scripts/pipeline-release/README.md b/scripts/pipeline-release/README.md index 2b02d6b3..a202debe 100644 --- a/scripts/pipeline-release/README.md +++ b/scripts/pipeline-release/README.md @@ -1,11 +1,4 @@ -Pipeline release is a script to package addons in the pipeline repo. - -# Features - - Automatically Find Commits since last version for each addon in `scripts-blender/addons/` - - Appends changelog to existing `CHANGELOG.md` per addon - - Bump Version on `__init__.py` file - - Commits `__init__.py` and `CHANGELOG.md` to current branch (user must manually push changes) - - Creates Archive with Checksum in `dist` folder +Pipeline release is a script to package all addons into a single zip on the pipeline repository. ## Prerequisite In order to use this tool you need: @@ -25,47 +18,3 @@ This folder contains a command line tool that doesn't require installation to us 2. Run `cd blender-studio-pipeline/scripts/pipeline_release` to enter directory 3. Run program with `python -m pipeline_release` -## How to get started - -| Command | Description | -| ----------- | ----------- | -| -m, --major|Bump the major version number, otherwise bump minor version| -| -n --name| Name of addon(s) folder to update. All addons will be checked if flag is not provided| -| -c --commit| Title of commit to consider basis of latest release, otherwise the last commit called 'Version Bump:' will be used| -| -f --force|Bump version even if no commits are found| -| -t, --test |Test release system by only running locally and skip committing| -| -h, --help| show the above help message and exit| - - -## Changelog Conventions -|Changelog Title| Commit Prefix| -| ----------- | ----------- | -|ADD |add| -|BUG FIX |fix| -|CHANGED |change| -|REMOVED |remove| -|MERGED |merge| -|DOCUMENTED|doc| -|BREAKING|breaking| - - -This tool will automatically generate changelog messages based on the "changelog categories" below. Commit's subject line convention is `{Name of Addon}: {category} commit content` for example: -### Commit Subject Line: -``` -Blender Kitsu: Fix naming conventions -```` - -### Changelog Output: -``` -### Fixes -- Fix naming conventions -``` - -## Example Usage -| Action | Command | -| ----------- | ----------- | -|Create a new minor version if available of all addons|`python -m pipeline_release`| -|Create a new major version if available of all addons|`python -m pipeline_release -m`| -|Create a new version even no new commits are found|`python -m pipeline_release` -f| -|Only check if addon has this name(s) |`python -m pipeline_release -n "blender_kitsu, blender_svn"`| -|Find a commit that matches this message and uses as version basis otherwise the last commit called 'Version Bump:' will be used |`python -m pipeline_release -c "Commit MSG"`| \ No newline at end of file diff --git a/scripts/pipeline-release/overview.md b/scripts/pipeline-release/overview.md deleted file mode 100644 index cbb32657..00000000 --- a/scripts/pipeline-release/overview.md +++ /dev/null @@ -1,21 +0,0 @@ -# Blender Add-ons - -Add-ons used by the Blender Studio pipeline. Download the latest addons releases from the table below. To review or report issues visit the [Blender-Studio-Pipeline](https://projects.blender.org/studio/blender-studio-pipeline/issues) issues board. - - -| Add-on | Description | Latest Version | Checksum | -|---|---|---|---| -|[Anim Cupboard](../addons/anim_cupboard) |Miscellaneous tools for animators. |[↓ v0.0.6](https://projects.blender.org/studio/blender-studio-pipeline/releases/download/0.0.3/anim_cupboard-0.0.6.zip) |[↓ SHA256](https://projects.blender.org/studio/blender-studio-pipeline/releases/download/0.0.3/anim_cupboard-0.0.6.sha256)| -|[Asset Pipeline](../addons/asset_pipeline ) |Manages the Asset Pipeline, used by Modeling, Shading and Rigging departments. |[↓ v0.2.1](https://projects.blender.org/studio/blender-studio-pipeline/releases/download/0.0.3/asset_pipeline-0.2.1.zip) |[↓ SHA256](https://projects.blender.org/studio/blender-studio-pipeline/releases/download/0.0.3/asset_pipeline-0.2.1.sha256)| -|[Blender Kitsu](../addons/blender_kitsu )|Enforce conventions, build shots, manage production files and update data on kitsu server. |[↓ v0.1.6](https://projects.blender.org/studio/blender-studio-pipeline/releases/download/0.0.4/blender_kitsu-0.1.6.zip) |[↓ SHA256](https://projects.blender.org/studio/blender-studio-pipeline/releases/download/0.0.4/blender_kitsu-0.1.6.sha256)| -|[Blender SVN](../addons/blender_svn ) |UI for the SVN (Subversion) file versioning system. |[↓ v1.0.3](https://projects.blender.org/studio/blender-studio-pipeline/releases/download/0.0.3/blender_svn-1.0.3.zip) |[↓ SHA256](https://projects.blender.org/studio/blender-studio-pipeline/releases/download/0.0.3/blender_svn-1.0.3.sha256)| -|[Blender Gizmos](../addons/bone_gizmos )|Attempt to prototype a system for using meshes for the manipulation of armatures. |[↓ v0.0.3](https://projects.blender.org/studio/blender-studio-pipeline/releases/download/0.0.1/bone_gizmos-0.0.3.zip) |[↓ SHA256](https://projects.blender.org/studio/blender-studio-pipeline/releases/download/0.0.1/bone_gizmos-0.0.3.sha256)| -|[Cache Manager](../addons/cache_manager ) |Streamline the Alembic cache workflow of assets. |[↓ v0.1.2](https://projects.blender.org/studio/blender-studio-pipeline/releases/download/0.0.1/cache_manager-0.1.2.zip) |[↓ SHA256](https://projects.blender.org/studio/blender-studio-pipeline/releases/download/0.0.1/cache_manager-0.1.2.sha256)| -|[Contact Sheet](../addons/contactsheet ) |Create a contactsheet from sequence editor strips. |[↓ v0.1.2](https://projects.blender.org/studio/blender-studio-pipeline/releases/download/0.0.1/contactsheet-0.1.2.zip) |[↓ SHA256](https://projects.blender.org/studio/blender-studio-pipeline/releases/download/0.0.1/contactsheet-0.1.2.sha256)| -|[Easy Weights](../addons/easy_weights ) |Quality of life improvements for weight painting. |[↓ v0.1.4](https://projects.blender.org/studio/blender-studio-pipeline/releases/download/0.0.2/easy_weights-0.1.4.zip) |[↓ SHA256](https://projects.blender.org/studio/blender-studio-pipeline/releases/download/0.0.2/easy_weights-0.1.4.sha256)| -|[Geonode Shapekeys](../addons/geonode_shapekeys ) |Enable animators to sculpt on linked and overridden meshes. |[↓ v0.0.5](https://projects.blender.org/studio/blender-studio-pipeline/releases/download/0.0.3/geonode_shapekeys-0.0.5.zip) |[↓ SHA256](https://projects.blender.org/studio/blender-studio-pipeline/releases/download/0.0.3/geonode_shapekeys-0.0.5.sha256)| -|[Grease Converter](../addons/grease_converter ) |Convert annotations to Grease Pencil objects and vise versa. |[↓ v0.1.2](https://projects.blender.org/studio/blender-studio-pipeline/releases/download/0.0.1/grease_converter-0.1.2.zip) |[↓ SHA256](https://projects.blender.org/studio/blender-studio-pipeline/releases/download/0.0.1/grease_converter-0.1.2.sha256)| -|[Lattice Magic](../addons/lattice_magic ) |Lattice-based utilities. |[↓ v0.1.3](https://projects.blender.org/studio/blender-studio-pipeline/releases/download/0.0.3/lattice_magic-0.1.3.zip) |[↓ SHA256](https://projects.blender.org/studio/blender-studio-pipeline/releases/download/0.0.3/lattice_magic-0.1.3.sha256)| -|[Lighting Overrider](../addons/lighting_overrider ) |Create, manage and apply python overrides in a flexible and reliable way. |[↓ v0.1.3](https://projects.blender.org/studio/blender-studio-pipeline/releases/download/0.0.3/lighting_overrider-0.1.3.zip) |[↓ SHA256](https://projects.blender.org/studio/blender-studio-pipeline/releases/download/0.0.3/lighting_overrider-0.1.3.sha256)| -|[Pose Shape Keys](../addons/pose_shape_keys )|Manage and maintain shapekeys for rigging. |[↓ v0.0.4](https://projects.blender.org/studio/blender-studio-pipeline/releases/download/0.0.3/pose_shape_keys-0.0.4.zip) |[↓ SHA256](https://projects.blender.org/studio/blender-studio-pipeline/releases/download/0.0.3/pose_shape_keys-0.0.4.sha256)| -|[Render Review](../addons/render_review ) |Review renders from Flamenco with the sequence editor. |[↓ v0.1.4](https://projects.blender.org/studio/blender-studio-pipeline/releases/download/0.0.3/render_review-0.1.4.zip) |[↓ SHA256](https://projects.blender.org/studio/blender-studio-pipeline/releases/download/0.0.3/render_review-0.1.4.sha256)| \ No newline at end of file diff --git a/scripts/pipeline-release/overview.md.template b/scripts/pipeline-release/overview.md.template deleted file mode 100644 index a9d38370..00000000 --- a/scripts/pipeline-release/overview.md.template +++ /dev/null @@ -1,21 +0,0 @@ -# Blender Add-ons - -Add-ons used by the Blender Studio pipeline. Download the latest addons releases from the table below. To review or report issues visit the [Blender-Studio-Pipeline](https://projects.blender.org/studio/blender-studio-pipeline/issues) issues board. - - -| Add-on | Description | Latest Version | Checksum | -|---|---|---|---| -|[Anim Cupboard](../addons/anim_cupboard) |Miscellaneous tools for animators. |[↓ v]() |[↓ SHA256]()| -|[Asset Pipeline](../addons/asset_pipeline ) |Manages the Asset Pipeline, used by Modeling, Shading and Rigging departments. |[↓ v]() |[↓ SHA256]()| -|[Blender Kitsu](../addons/blender_kitsu )|Enforce conventions, build shots, manage production files and update data on kitsu server. |[↓ v]() |[↓ SHA256]()| -|[Blender SVN](../addons/blender_svn ) |UI for the SVN (Subversion) file versioning system. |[↓ v]() |[↓ SHA256]()| -|[Blender Gizmos](../addons/bone_gizmos )|Attempt to prototype a system for using meshes for the manipulation of armatures. |[↓ v]() |[↓ SHA256]()| -|[Cache Manager](../addons/cache_manager ) |Streamline the Alembic cache workflow of assets. |[↓ v]() |[↓ SHA256]()| -|[Contact Sheet](../addons/contactsheet ) |Create a contactsheet from sequence editor strips. |[↓ v]() |[↓ SHA256]()| -|[Easy Weights](../addons/easy_weights ) |Quality of life improvements for weight painting. |[↓ v]() |[↓ SHA256]()| -|[Geonode Shapekeys](../addons/geonode_shapekeys ) |Enable animators to sculpt on linked and overridden meshes. |[↓ v]() |[↓ SHA256]()| -|[Grease Converter](../addons/grease_converter ) |Convert annotations to Grease Pencil objects and vise versa. |[↓ v]() |[↓ SHA256]()| -|[Lattice Magic](../addons/lattice_magic ) |Lattice-based utilities. |[↓ v]() |[↓ SHA256]()| -|[Lighting Overrider](../addons/lighting_overrider ) |Create, manage and apply python overrides in a flexible and reliable way. |[↓ v]() |[↓ SHA256]()| -|[Pose Shape Keys](../addons/pose_shape_keys )|Manage and maintain shapekeys for rigging. |[↓ v]() |[↓ SHA256]()| -|[Render Review](../addons/render_review ) |Review renders from Flamenco with the sequence editor. |[↓ v]() |[↓ SHA256]()| \ No newline at end of file