Docs: Fix Add-On Overview Readme Table #146

Merged
Nick Alberelli merged 7 commits from :fix/addon-overview-readme into main 2023-09-19 19:51:36 +02:00
6 changed files with 59 additions and 23 deletions

View File

@ -1,2 +1 @@
<!--@include: ../../scripts-blender/README.md--> <!--@include: ../../scripts/pipeline-release/overview.md-->

View File

@ -1,21 +1,24 @@
# Blender Add-ons # 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-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.
| Add-on | Description |
|---|---|
|Anim Cupboard |Miscellaneous tools for animators.
|Asset Pipeline |Manages the Asset Pipeline, used by Modeling, Shading and Rigging departments.
|Blender Kitsu |Enforce conventions, build shots, manage production files and update data on kitsu server.
|Blender SVN |UI for the SVN (Subversion) file versioning system.
|Blender Gizmos |Attempt to prototype a system for using meshes for the manipulation of armatures.
|Cache Manager |Streamline the Alembic cache workflow of assets.
|Contact Sheet |Create a contactsheet from sequence editor strips.
|Easy Weights |Quality of life improvements for weight painting.
|Geonode Shapekeys |Enable animators to sculpt on linked and overridden meshes.
|Grease Converter |Convert annotations to Grease Pencil objects and vise versa.
|Lattice Magic |Lattice-based utilities.
|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.
| Add-on | Description | Latest Version | Checksum | Download release packages of the above add-ons from the [Add-on Release Table](https://studio.blender.org/pipeline/addons/overview) page.
|---|---|---|---|
|[Anim Cupboard](../addons/anim_cupboard) |Miscellaneous tools for animators. |[↓ v0.0.4](https://projects.blender.org/studio/blender-studio-pipeline/releases/download/0.0.1/anim_cupboard-0.0.4.zip) |[↓ SHA256](https://projects.blender.org/studio/blender-studio-pipeline/releases/download/0.0.1/anim_cupboard-0.0.4.sha256)| Download previous release of the above add-ons from the [Releases](https://projects.blender.org/studio/blender-studio-pipeline/releases) page.
|[Asset Pipeline](../addons/asset_pipeline ) |Manages the Asset Pipeline, used by Modeling, Shading and Rigging departments. |[↓ v0.1.2](https://projects.blender.org/studio/blender-studio-pipeline/releases/download/0.0.1/asset_pipeline-0.1.2.zip) |[↓ SHA256](https://projects.blender.org/studio/blender-studio-pipeline/releases/download/0.0.1/asset_pipeline-0.1.2.sha256)|
|[Blender Kitsu](../addons/blender_kitsu )|Enforce conventions, build shots, manage production files and update data on kitsu server. |[↓ v0.1.3](https://projects.blender.org/studio/blender-studio-pipeline/releases/download/0.0.1/blender_kitsu-0.1.3.zip) |[↓ SHA256](https://projects.blender.org/studio/blender-studio-pipeline/releases/download/0.0.1/blender_kitsu-0.1.3.sha256)|
|[Blender SVN](../addons/blender_svn ) |UI for the SVN (Subversion) file versioning system. |[↓ v1.0.1](https://projects.blender.org/studio/blender-studio-pipeline/releases/download/0.0.1/blender_svn-1.0.1.zip) |[↓ SHA256](https://projects.blender.org/studio/blender-studio-pipeline/releases/download/0.0.1/blender_svn-1.0.1.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.2](https://projects.blender.org/studio/blender-studio-pipeline/releases/download/0.0.1/easy_weights-0.1.2.zip) |[↓ SHA256](https://projects.blender.org/studio/blender-studio-pipeline/releases/download/0.0.1/easy_weights-0.1.2.sha256)|
|[Geonode Shapekeys](../addons/geonode_shapekeys ) |Enable animators to sculpt on linked and overridden meshes. |[↓ v0.0.3](https://projects.blender.org/studio/blender-studio-pipeline/releases/download/0.0.1/geonode_shapekeys-0.0.3.zip) |[↓ SHA256](https://projects.blender.org/studio/blender-studio-pipeline/releases/download/0.0.1/geonode_shapekeys-0.0.3.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.2](https://projects.blender.org/studio/blender-studio-pipeline/releases/download/0.0.1/lattice_magic-0.1.2.zip) |[↓ SHA256](https://projects.blender.org/studio/blender-studio-pipeline/releases/download/0.0.1/lattice_magic-0.1.2.sha256)|
|[Lighting Overrider](../addons/lighting_overrider ) |Create, manage and apply python overrides in a flexible and reliable way. |[↓ v0.1.2](https://projects.blender.org/studio/blender-studio-pipeline/releases/download/0.0.1/lighting_overrider-0.1.2.zip) |[↓ SHA256](https://projects.blender.org/studio/blender-studio-pipeline/releases/download/0.0.1/lighting_overrider-0.1.2.sha256)|
|[Pose Shape Keys](../addons/pose_shape_keys )|Manage and maintain shapekeys for rigging. |[↓ v0.0.3](https://projects.blender.org/studio/blender-studio-pipeline/releases/download/0.0.1/pose_shape_keys-0.0.3.zip) |[↓ SHA256](https://projects.blender.org/studio/blender-studio-pipeline/releases/download/0.0.1/pose_shape_keys-0.0.3.sha256)|
|[Render Review](../addons/render_review ) |Review renders from Flamenco with the sequence editor. |[↓ v0.1.3](https://projects.blender.org/studio/blender-studio-pipeline/releases/download/0.0.1/render_review-0.1.3.zip) |[↓ SHA256](https://projects.blender.org/studio/blender-studio-pipeline/releases/download/0.0.1/render_review-0.1.3.sha256)|

View File

@ -9,8 +9,20 @@ Pipeline release is a script to package addons in the pipeline repo.
## Prerequisite ## Prerequisite
In order to use this tool you need: In order to use this tool you need:
- Python 3.5+
- GIT - GIT
- Python 3.11+
- [Requests Module](https://requests.readthedocs.io/en/latest/)
## Generate Token
A Gitea API token is required to generate a pipeline release.
1. Navigate to https://projects.blender.org/user/settings/applications while logged in
2. **TEMP WORK AROUND for GITEA 1.20.0**
- Right-Click on the Generate Token button and select your browser's INSPECT tool.
- Find an element named `<details class="gt-hidden ui optional field"> ==$0`
- Rename element to `<details class=""> ==$0`
- A drop down named Select Scopes will appear above generate token version
- Enable `repo` and `package` scopes
3. Save the provided API key in the root of the pipeline-release directory with the name `api_token.env`
## Run ## Run
This folder contains a command line tool that doesn't require installation to use properly. To run `pipeline_release` without installation follow the steps below. This folder contains a command line tool that doesn't require installation to use properly. To run `pipeline_release` without installation follow the steps below.

View File

@ -0,0 +1,21 @@
# 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.4](https://projects.blender.org/studio/blender-studio-pipeline/releases/download/0.0.1/anim_cupboard-0.0.4.zip) |[↓ SHA256](https://projects.blender.org/studio/blender-studio-pipeline/releases/download/0.0.1/anim_cupboard-0.0.4.sha256)|
|[Asset Pipeline](../addons/asset_pipeline ) |Manages the Asset Pipeline, used by Modeling, Shading and Rigging departments. |[↓ v0.1.2](https://projects.blender.org/studio/blender-studio-pipeline/releases/download/0.0.1/asset_pipeline-0.1.2.zip) |[↓ SHA256](https://projects.blender.org/studio/blender-studio-pipeline/releases/download/0.0.1/asset_pipeline-0.1.2.sha256)|
|[Blender Kitsu](../addons/blender_kitsu )|Enforce conventions, build shots, manage production files and update data on kitsu server. |[↓ v0.1.3](https://projects.blender.org/studio/blender-studio-pipeline/releases/download/0.0.1/blender_kitsu-0.1.3.zip) |[↓ SHA256](https://projects.blender.org/studio/blender-studio-pipeline/releases/download/0.0.1/blender_kitsu-0.1.3.sha256)|
|[Blender SVN](../addons/blender_svn ) |UI for the SVN (Subversion) file versioning system. |[↓ v1.0.1](https://projects.blender.org/studio/blender-studio-pipeline/releases/download/0.0.1/blender_svn-1.0.1.zip) |[↓ SHA256](https://projects.blender.org/studio/blender-studio-pipeline/releases/download/0.0.1/blender_svn-1.0.1.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.2](https://projects.blender.org/studio/blender-studio-pipeline/releases/download/0.0.1/easy_weights-0.1.2.zip) |[↓ SHA256](https://projects.blender.org/studio/blender-studio-pipeline/releases/download/0.0.1/easy_weights-0.1.2.sha256)|
|[Geonode Shapekeys](../addons/geonode_shapekeys ) |Enable animators to sculpt on linked and overridden meshes. |[↓ v0.0.3](https://projects.blender.org/studio/blender-studio-pipeline/releases/download/0.0.1/geonode_shapekeys-0.0.3.zip) |[↓ SHA256](https://projects.blender.org/studio/blender-studio-pipeline/releases/download/0.0.1/geonode_shapekeys-0.0.3.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.2](https://projects.blender.org/studio/blender-studio-pipeline/releases/download/0.0.1/lattice_magic-0.1.2.zip) |[↓ SHA256](https://projects.blender.org/studio/blender-studio-pipeline/releases/download/0.0.1/lattice_magic-0.1.2.sha256)|
|[Lighting Overrider](../addons/lighting_overrider ) |Create, manage and apply python overrides in a flexible and reliable way. |[↓ v0.1.2](https://projects.blender.org/studio/blender-studio-pipeline/releases/download/0.0.1/lighting_overrider-0.1.2.zip) |[↓ SHA256](https://projects.blender.org/studio/blender-studio-pipeline/releases/download/0.0.1/lighting_overrider-0.1.2.sha256)|
|[Pose Shape Keys](../addons/pose_shape_keys )|Manage and maintain shapekeys for rigging. |[↓ v0.0.3](https://projects.blender.org/studio/blender-studio-pipeline/releases/download/0.0.1/pose_shape_keys-0.0.3.zip) |[↓ SHA256](https://projects.blender.org/studio/blender-studio-pipeline/releases/download/0.0.1/pose_shape_keys-0.0.3.sha256)|
|[Render Review](../addons/render_review ) |Review renders from Flamenco with the sequence editor. |[↓ v0.1.3](https://projects.blender.org/studio/blender-studio-pipeline/releases/download/0.0.1/render_review-0.1.3.zip) |[↓ SHA256](https://projects.blender.org/studio/blender-studio-pipeline/releases/download/0.0.1/render_review-0.1.3.sha256)|

View File

@ -301,8 +301,9 @@ def changelog_file_write(file_path: Path, content: str):
def update_release_table(addon_dir: Path, version: str, release_version: str): def update_release_table(addon_dir: Path, version: str, release_version: str):
template_file = addon_dir.parent.parent.joinpath("README.md.template") directory = Path(__file__).parent
table_file = addon_dir.parent.parent.joinpath("README.md") template_file = directory.joinpath("overview.md.template")
table_file = directory.joinpath("overview.md")
with open(template_file, 'r') as readme_template: with open(template_file, 'r') as readme_template:
for num, line in enumerate(readme_template): for num, line in enumerate(readme_template):
if addon_dir.name in line: if addon_dir.name in line:
@ -437,7 +438,7 @@ def addon_version_bump(directory: Path, is_major: bool):
### GITEA UPLOAD RELEASE ### GITEA UPLOAD RELEASE
import requests import requests # TODO ADD PRINT STATEMENT IF UNABLE TO IMPORT
import json import json
""" """