https://github.com/matmair/inventree-meta-plugin
Meta project for InvenTree plugins
https://github.com/matmair/inventree-meta-plugin
inventree inventreeplugins
Last synced: 7 months ago
JSON representation
Meta project for InvenTree plugins
- Host: GitHub
- URL: https://github.com/matmair/inventree-meta-plugin
- Owner: matmair
- Created: 2022-08-17T20:52:55.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2024-09-12T21:21:34.000Z (over 1 year ago)
- Last Synced: 2025-02-15T07:39:57.809Z (over 1 year ago)
- Topics: inventree, inventreeplugins
- Language: Python
- Homepage:
- Size: 54.7 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# inventree-meta-plugin
Meta project for InvenTree plugins. This repo contains general helpers to streamline InvenTree plugin development.
## Workflow
This keeps the workflows as simple as possible. Just bump the version to get the new flows.
```yaml
name: Plugin checking and building
on:
push:
branches: ['main', 'master']
pull_request:
types: [opened, edited, reopened]
release:
types: [published]
jobs:
plugin-action:
uses: matmair/inventree-meta-plugin/.github/workflows/plugin_action.yml@v1.0
secrets: inherit
```
The workflow runs flake8 and - if a release was published - builds and publishes to PyPi. For this to work you need to set a secret named `PYPI_API_TOKEN` with a valid token for publishing to PyPi.
Please scope the token to only work for the specific project and use a new one for each plugin. You might have to push the project once before the new scope becomes available in the [account settings](https://pypi.org/manage/account/).
## Cookie cutter
Cookie cutter is a template engine - we provide a template for a new plugin. It can be used to create a new plugin with a simple structure and all files required for scaleable plugins - from simple webhook integration to complex AppMixins.
```bash
cookiecutter gh:matmair/inventree-meta-plugin
```