Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
==================
Expand Down
25 changes: 25 additions & 0 deletions docs/sunpy.rst
Original file line number Diff line number Diff line change
@@ -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/<project_name>/settings/publishing/`` and enter the details, this is probably:

* **Owner**: ``sunpy``
* **Workflow name**: ``ci.yml``
* **Environment name**: ``pypi``