diff --git a/docs/index.rst b/docs/index.rst index 70ae5eb..bff65c4 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -16,6 +16,7 @@ This guide is intended to explain modern Python packaging, it covers most of the data ci advanced/index + sunpy Using the Template ================== diff --git a/docs/sunpy.rst b/docs/sunpy.rst new file mode 100644 index 0000000..8bfbcd6 --- /dev/null +++ b/docs/sunpy.rst @@ -0,0 +1,25 @@ +.. _sunpy-specific: + +====================== +SunPy Package Template +====================== + +This page is notes for maintainers of packages using the sunpy package template, it mostly talks about how to configure things the package template is expecting. + +``ci.yml`` +========== + +Publishing +---------- + +The package template uses Trusted Publishing to push to PyPI. +This requires two things to be configured. +Firstly, a GitHub environment which needs to be named ``pypi`` and should implement a pattern which matches tags for your releases (i.e. ``v*``). +Secondly, you need to configure PyPI to know about this environment and accept releases from it. +Todo this go to ``https://pypi.org/manage/project//settings/publishing/`` and enter the details, this is probably: + +* **Owner**: ``sunpy`` +* **Workflow name**: ``ci.yml`` +* **Environment name**: ``pypi`` + +