Docs: Remove Download Links from Add-On Table #272

Merged
Nick Alberelli merged 3 commits from TinyNick/blender-studio-pipeline:feature/replace_addon_table into main 2024-03-25 20:50:40 +01:00
3 changed files with 5 additions and 58 deletions
Showing only changes of commit cd396393ef - Show all commits

View File

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

View File

@ -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. 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 | | Add-on | Description |
|---|---| |---|---|
|Anim Cupboard |Miscellaneous tools for animators. |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. |Lighting Overrider |Create, manage and apply python overrides in a flexible and reliable way.
|Pose Shape Keys |Manage and maintain shapekeys for rigging. |Pose Shape Keys |Manage and maintain shapekeys for rigging.
|Render Review |Review renders from Flamenco with the sequence editor. |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.

View File

@ -1,11 +1,4 @@
Pipeline release is a script to package addons in the pipeline repo. Pipeline release is a script to package all addons into a single zip on the pipeline repository.
# 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
## Prerequisite ## Prerequisite
In order to use this tool you need: 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 2. Run `cd blender-studio-pipeline/scripts/pipeline_release` to enter directory
3. Run program with `python -m pipeline_release` 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"`|