Document use of the maintainers field (#12270)

* Document use of the maintainers field

* Use fake GitHub usernames

* GitHub action is not automatic yet
This commit is contained in:
Adam J. Stewart 2019-11-15 13:58:24 -06:00 committed by GitHub
parent c587c76537
commit 5510bba1fd
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 20 additions and 1 deletions

View File

@ -136,6 +136,10 @@ generates a boilerplate template for your package, and opens up the new
homepage = "http://www.example.com" homepage = "http://www.example.com"
url = "https://gmplib.org/download/gmp/gmp-6.1.2.tar.bz2" url = "https://gmplib.org/download/gmp/gmp-6.1.2.tar.bz2"
# FIXME: Add a list of GitHub accounts to
# notify when the package is updated.
# maintainers = ['github_user1', 'github_user2']
version('6.1.2', '8ddbb26dc3bd4e2302984debba1406a5') version('6.1.2', '8ddbb26dc3bd4e2302984debba1406a5')
version('6.1.1', '4c175f86e11eb32d8bf9872ca3a8e11d') version('6.1.1', '4c175f86e11eb32d8bf9872ca3a8e11d')
version('6.1.0', '86ee6e54ebfc4a90b643a65e402c4048') version('6.1.0', '86ee6e54ebfc4a90b643a65e402c4048')
@ -184,6 +188,17 @@ The rest of the tasks you need to do are as follows:
The ``homepage`` is displayed when users run ``spack info`` so The ``homepage`` is displayed when users run ``spack info`` so
that they can learn more about your package. that they can learn more about your package.
#. Add a comma-separated list of maintainers.
The ``maintainers`` field is a list of GitHub accounts of people
who want to be notified any time the package is modified. When a
pull request is submitted that updates the package, these people
will be requested to review the PR. This is useful for developers
who maintain a Spack package for their own software, as well as
users who rely on a piece of software and want to ensure that the
package doesn't break. It also gives users a list of people to
contact for help when someone reports a build error with the package.
#. Add ``depends_on()`` calls for the package's dependencies. #. Add ``depends_on()`` calls for the package's dependencies.
``depends_on`` tells Spack that other packages need to be built ``depends_on`` tells Spack that other packages need to be built
@ -1464,7 +1479,7 @@ that the same package with different patches applied will have different
hash identifiers. To ensure that the hashing scheme is consistent, you hash identifiers. To ensure that the hashing scheme is consistent, you
must use a ``sha256`` checksum for the patch. Patches will be fetched must use a ``sha256`` checksum for the patch. Patches will be fetched
from their URLs, checked, and applied to your source code. You can use from their URLs, checked, and applied to your source code. You can use
the GNU utils ``sha256sum`` or the macOS ``shasum -a 256`` commands to the GNU utils ``sha256sum`` or the macOS ``shasum -a 256`` commands to
generate a checksum for a patch file. generate a checksum for a patch file.
Spack can also handle compressed patches. If you use these, Spack needs Spack can also handle compressed patches. If you use these, Spack needs

View File

@ -60,6 +60,10 @@ class {class_name}({base_class_name}):
homepage = "https://www.example.com" homepage = "https://www.example.com"
{url_def} {url_def}
# FIXME: Add a list of GitHub accounts to
# notify when the package is updated.
# maintainers = ['github_user1', 'github_user2']
{versions} {versions}
{dependencies} {dependencies}