Skip to content
This repository was archived by the owner on Aug 25, 2024. It is now read-only.

Commit 0fa15d9

Browse files
John Andersenpdxjohnny
authored andcommitted
docs: cotributing: maintainers: Adding new plugin
Signed-off-by: John Andersen <[email protected]>
1 parent bb02534 commit 0fa15d9

File tree

2 files changed

+29
-0
lines changed

2 files changed

+29
-0
lines changed

docs/contributing/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,3 +19,4 @@ or post in the `Gitter Chat <https://gitter.im/dffml/community>`_.
1919
testing
2020
docs
2121
debugging
22+
maintainers

docs/contributing/maintainers.rst

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
Maintainer Docs
2+
===============
3+
4+
These docs are for the maintainers of DFFML, if you're not a maintainer, you
5+
won't find anything useful here, unless your just curious.
6+
7+
Adding A New Plugin
8+
-------------------
9+
10+
When a new plugin is added we need to go manually upload it for the first time.
11+
12+
.. code-block:: console
13+
14+
$ cd model/new_model
15+
$ python3.7 setup.py test
16+
$ rm -rf dist
17+
$ git clean -xdf
18+
$ python3.7 setup.py sdist
19+
$ twine upload dist/*
20+
21+
Once it's be uploaded, we go to PyPi and create an API key which will be used to
22+
upload it via the automatic release at the end of ``run_plugin`` within the CI
23+
script.
24+
25+
.. image:: /images/pypi-token-to-github-secret.gif
26+
27+
Finally, update the ``PYPI_TOKENS`` file in ``.github/workflows/testing.yml``.
28+
Add a line for the plugin along with it's sceret.

0 commit comments

Comments
 (0)