<pre style='margin:0'>
Rainer Müller (raimue) pushed a commit to branch master
in repository macports-guide.
</pre>
<p><a href="https://github.com/macports/macports-guide/commit/5d94c2a62f27431291a6b9febc1c8f7da34d872d">https://github.com/macports/macports-guide/commit/5d94c2a62f27431291a6b9febc1c8f7da34d872d</a></p>
<pre style="white-space: pre; background: #F8F8F8"><span style='display:block; white-space:pre;color:#808000;'>commit 5d94c2a62f27431291a6b9febc1c8f7da34d872d
</span>Author: Clemens Lang <neverpanic@gmail.com>
AuthorDate: Sun Nov 6 22:42:17 2016 +0100
<span style='display:block; white-space:pre;color:#404040;'> Allow GitHub usernames as port maintainers
</span><span style='display:block; white-space:pre;color:#404040;'>
</span><span style='display:block; white-space:pre;color:#404040;'> After the move to GitHub, it is sometimes difficult to figure out
</span><span style='display:block; white-space:pre;color:#404040;'> whether a pull request was sent or a ticket was opened by a maintainer,
</span><span style='display:block; white-space:pre;color:#404040;'> because both these systems use GitHub usernames now.
</span><span style='display:block; white-space:pre;color:#404040;'>
</span><span style='display:block; white-space:pre;color:#404040;'> This leads to more confusion with developers and users than needed.
</span><span style='display:block; white-space:pre;color:#404040;'> Change the documentation to allow GitHub usernames as maintainers for
</span><span style='display:block; white-space:pre;color:#404040;'> Portfiles to avoid this.
</span><span style='display:block; white-space:pre;color:#404040;'>
</span><span style='display:block; white-space:pre;color:#404040;'> Using a GitHub username leaves us with the problem that there is no
</span><span style='display:block; white-space:pre;color:#404040;'> email address available for this user, unless the user has added
</span><span style='display:block; white-space:pre;color:#404040;'> a public email address to their GitHub account. Email addresses are
</span><span style='display:block; white-space:pre;color:#404040;'> instead available in commits, and maintainers can always be reached by
</span><span style='display:block; white-space:pre;color:#404040;'> ticket or GitHub comment.
</span>---
guide/xml/portfile-keywords.xml | 25 ++++++++------
guide/xml/portfiledev.xml | 24 +++++++------
guide/xml/project.xml | 74 +++++++++++++++++++++++------------------
3 files changed, 68 insertions(+), 55 deletions(-)
<span style='display:block; white-space:pre;color:#808080;'>diff --git a/guide/xml/portfile-keywords.xml b/guide/xml/portfile-keywords.xml
</span><span style='display:block; white-space:pre;color:#808080;'>index b96474c..1f7f15a 100644
</span><span style='display:block; white-space:pre;background:#e0e0ff;'>--- a/guide/xml/portfile-keywords.xml
</span><span style='display:block; white-space:pre;background:#e0e0ff;'>+++ b/guide/xml/portfile-keywords.xml
</span><span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -108,12 +108,14 @@
</span> <term>maintainers</term>
<listitem>
<span style='display:block; white-space:pre;background:#ffe0e0;'>- <para>A port's maintainers are the people who have agreed to take
</span><span style='display:block; white-space:pre;background:#ffe0e0;'>- responsibility for keeping the port up-to-date. Most ports have only a
</span><span style='display:block; white-space:pre;background:#ffe0e0;'>- single maintainer, but some ports have two or more co-maintainers. The
</span><span style='display:block; white-space:pre;background:#ffe0e0;'>- <literal>maintainers</literal> keyword lists the maintainers' email
</span><span style='display:block; white-space:pre;background:#ffe0e0;'>- addresses, preferably in the obfuscated form which hides them
</span><span style='display:block; white-space:pre;background:#ffe0e0;'>- from spambots:</para>
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ <para>
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ A port's maintainers are the people who have agreed to take
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ responsibility for keeping the port up-to-date. Most ports have only
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ a single maintainer, but some ports have two or more co-maintainers.
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ The <literal>maintainers</literal> keyword lists the maintainers'
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ GitHub usernames or email addresses. GitHub usernames start with an
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ <literal>@</literal> symbol. Email addresses are preferably listed in
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ the obfuscated form below to hide them from spambots:</para>
</span>
<itemizedlist>
<listitem>
<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -129,12 +131,13 @@
</span> </listitem>
</itemizedlist>
<span style='display:block; white-space:pre;background:#ffe0e0;'>- <para>In the example below, the maintainer email addresses
</span><span style='display:block; white-space:pre;background:#ffe0e0;'>- <email>jdoe@macports.org</email> and
</span><span style='display:block; white-space:pre;background:#ffe0e0;'>- <email>julesverne@example.org</email> are hidden using these
</span><span style='display:block; white-space:pre;background:#ffe0e0;'>- conventions.</para>
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ <para>In the example below, the port is maintained by a GitHub user
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ named neverpanic, and the owners of the two email addresses
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ <email>jdoe@macports.org</email> and
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ <email>julesverne@example.org</email></para>
</span>
<span style='display:block; white-space:pre;background:#ffe0e0;'>- <programlisting>maintainers jdoe \
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ <programlisting>maintainers @neverpanic \
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ jdoe \
</span> example.org:julesverne</programlisting>
<note>
<span style='display:block; white-space:pre;color:#808080;'>diff --git a/guide/xml/portfiledev.xml b/guide/xml/portfiledev.xml
</span><span style='display:block; white-space:pre;color:#808080;'>index d850a3f..544ab01 100644
</span><span style='display:block; white-space:pre;background:#e0e0ff;'>--- a/guide/xml/portfiledev.xml
</span><span style='display:block; white-space:pre;background:#e0e0ff;'>+++ b/guide/xml/portfiledev.xml
</span><span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -194,17 +194,19 @@
</span> <listitem>
<para>Port maintainers</para>
<span style='display:block; white-space:pre;background:#ffe0e0;'>- <para>A port's maintainers are the people who have agreed to take
</span><span style='display:block; white-space:pre;background:#ffe0e0;'>- responsibility for keeping the port up-to-date. The
</span><span style='display:block; white-space:pre;background:#ffe0e0;'>- <literal>maintainers</literal> keyword lists the maintainers' email
</span><span style='display:block; white-space:pre;background:#ffe0e0;'>- addresses, preferably in the obfuscated form which hides them
</span><span style='display:block; white-space:pre;background:#ffe0e0;'>- from spambots. For more, see the full explanation of the <link
</span><span style='display:block; white-space:pre;background:#ffe0e0;'>- linkend="reference.keywords.maintainers">maintainers keyword</link> in
</span><span style='display:block; white-space:pre;background:#ffe0e0;'>- the <link linkend="reference.keywords">Global Keywords</link> section
</span><span style='display:block; white-space:pre;background:#ffe0e0;'>- of the <link linkend="reference">Portfile Reference</link>
</span><span style='display:block; white-space:pre;background:#ffe0e0;'>- chapter.</para>
</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-
</span><span style='display:block; white-space:pre;background:#ffe0e0;'>- <programlisting>maintainers jdoe \
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ <para>
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ A port's maintainers are the people who have agreed to take
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ responsibility for keeping the port up-to-date. The
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ <literal>maintainers</literal> keyword lists the maintainers' GitHub
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ usernames or email addresses, preferably in the obfuscated form which
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ hides them from spambots. For more, see the full explanation of the
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ <link linkend="reference.keywords.maintainers">maintainers
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ keyword</link> in the <link linkend="reference.keywords">Global
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ Keywords</link> section of the <link linkend="reference">Portfile
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ Reference</link> chapter.</para>
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ <programlisting>maintainers @neverpanic \
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ jdoe \
</span> example.org:julesverne</programlisting>
</listitem>
<span style='display:block; white-space:pre;color:#808080;'>diff --git a/guide/xml/project.xml b/guide/xml/project.xml
</span><span style='display:block; white-space:pre;color:#808080;'>index f5fe2ad..94d0f76 100644
</span><span style='display:block; white-space:pre;background:#e0e0ff;'>--- a/guide/xml/project.xml
</span><span style='display:block; white-space:pre;background:#e0e0ff;'>+++ b/guide/xml/project.xml
</span><span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -237,8 +237,8 @@
</span> </row>
<row>
<entry><guilabel>Owner</guilabel>/<guilabel>Cc</guilabel></entry>
<span style='display:block; white-space:pre;background:#ffe0e0;'>- <entry>Full email address of the port's maintainer. Run
</span><span style='display:block; white-space:pre;background:#ffe0e0;'>- <command>port info --maintainer
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ <entry>Full email address or GitHub username of the port's
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ maintainer. Run <command>port info --maintainer
</span> <replaceable><portname></replaceable></command> to
look this up. Do not add
<email>nomaintainer@macports.org</email> or
<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -432,36 +432,41 @@
</span> </listitem>
<listitem>
<span style='display:block; white-space:pre;background:#ffe0e0;'>- <para><guilabel>Cc:</guilabel> Anyone else besides the ticket
</span><span style='display:block; white-space:pre;background:#ffe0e0;'>- reporter and assignee who would like to be kept involved in the
</span><span style='display:block; white-space:pre;background:#ffe0e0;'>- development of the ticket. Multiple email addresses should be
</span><span style='display:block; white-space:pre;background:#ffe0e0;'>- separated with a comma and a space
</span><span style='display:block; white-space:pre;background:#ffe0e0;'>- (e.g., <literal>you@example.org, maintainer@macports.org</literal>).</para>
</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-
</span><span style='display:block; white-space:pre;background:#ffe0e0;'>- <para>When reporting port-related tickets, make sure you add the
</span><span style='display:block; white-space:pre;background:#ffe0e0;'>- port maintainers email address to the <guilabel>Cc:</guilabel> field
</span><span style='display:block; white-space:pre;background:#ffe0e0;'>- so they are notified of the ticket (unless you have commit access,
</span><span style='display:block; white-space:pre;background:#ffe0e0;'>- then see <guilabel>Assign To:</guilabel> below). You can obtain the
</span><span style='display:block; white-space:pre;background:#ffe0e0;'>- email address of the port maintainer from the Portfile, or by running
</span><span style='display:block; white-space:pre;background:#ffe0e0;'>- <literal>port info --maintainers <replaceable>[port]</replaceable>
</span><span style='display:block; white-space:pre;background:#ffe0e0;'>- </literal></para>
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ <para>
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ <guilabel>Cc:</guilabel> Anyone else besides the ticket reporter
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ and assignee who would like to be kept involved in the development
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ of the ticket. Multiple email addresses or GitHub usernames should
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ be separated with a comma and a space (e.g., <literal>neverpanic,
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ you@example.org, maintainer@macports.org</literal>).</para>
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ <para>
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ When reporting port-related tickets, make sure you add the port
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ maintainers email address or GitHub username to the
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ <guilabel>Cc:</guilabel> field so they are notified of the ticket
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ (unless you have commit access, then see <guilabel>Assign
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ To:</guilabel> below). You can obtain the email address or GitHub
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ username of the port maintainer by running <command>port info
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ --maintainers <replaceable>[port]</replaceable></command></para>
</span> </listitem>
<listitem>
<span style='display:block; white-space:pre;background:#ffe0e0;'>- <para><guilabel>Assign To:</guilabel> Only users with commit access
</span><span style='display:block; white-space:pre;background:#ffe0e0;'>- can edit this field. If this is not you, see the section on the
</span><span style='display:block; white-space:pre;background:#ffe0e0;'>- <guimenu>Cc</guimenu> field above.</para>
</span><span style='display:block; white-space:pre;background:#ffe0e0;'>-
</span><span style='display:block; white-space:pre;background:#ffe0e0;'>- <para>For tickets on ports, enter
</span><span style='display:block; white-space:pre;background:#ffe0e0;'>- the email address of the port's maintainer (use <command>port info
</span><span style='display:block; white-space:pre;background:#ffe0e0;'>- <portname></command> to find this). If multiple maintainers
</span><span style='display:block; white-space:pre;background:#ffe0e0;'>- are listed, enter the first maintainer's email address here and
</span><span style='display:block; white-space:pre;background:#ffe0e0;'>- enter the remaining maintainers' email addresses in the
</span><span style='display:block; white-space:pre;background:#ffe0e0;'>- <guimenu>Cc</guimenu> field. Exclude the email address
</span><span style='display:block; white-space:pre;background:#ffe0e0;'>- <email>openmaintainer@macports.org</email> if it appears.
</span><span style='display:block; white-space:pre;background:#ffe0e0;'>- If the maintainer's email address is
</span><span style='display:block; white-space:pre;background:#ffe0e0;'>- <email>nomaintainer@macports.org</email>, leave the field
</span><span style='display:block; white-space:pre;background:#ffe0e0;'>- blank.</para>
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ <para>
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ <guilabel>Assign To:</guilabel> Only users with commit access can
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ edit this field. If this is not you, see the section on the
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ <guimenu>Cc</guimenu> field above.</para>
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ <para>
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ For tickets on ports, enter the email address or GitHub username of
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ the port's maintainer (use <command>port info
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ <replaceable>[port]</replaceable></command> to find this). If
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ multiple maintainers are listed, enter the first maintainer's email
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ address or GitHub username here and enter the remaining
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ maintainers' email addresses or GitHub usernames in the
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ <guimenu>Cc</guimenu> field. Exclude the email address
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ <email>openmaintainer@macports.org</email> if it appears. If the
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ maintainer's email address is
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ <email>nomaintainer@macports.org</email>, leave the field
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ blank.</para>
</span> </listitem>
<listitem>
<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -589,7 +594,8 @@
</span> </listitem>
<listitem>
<span style='display:block; white-space:pre;background:#ffe0e0;'>- <para>Put the maintainer's email address into the
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ <para>
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ Put the maintainer's email address or GitHub username into the
</span> <guilabel>Cc</guilabel> field. You can use
<programlisting><prompt>%%</prompt> <userinput>port info --maintainer $portname</userinput></programlisting>
where <userinput>$portname</userinput> is the name of the port you
<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -628,7 +634,7 @@
</span>
<itemizedlist>
<listitem>
<span style='display:block; white-space:pre;background:#ffe0e0;'>- <para>An email address.</para>
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ <para>An email address or a GitHub account.</para>
</span> </listitem>
<listitem>
<para>A copy of the <filename>Portfile</filename>. Do not worry if
<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -746,7 +752,9 @@ To use the current port, you must be in a port's directory.</screen>
</span> <para>Open the <filename>Portfile</filename> in your favorite editor
and look for the line that starts with <option>maintainer</option>.
Delete <option>nomaintainer</option> from the line if it exists and
<span style='display:block; white-space:pre;background:#ffe0e0;'>- add your own email address in the form
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ add your own GitHub username or email address. For GitHub
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ usernames, prefix your username with an <literal>@</literal> sign.
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ Email addresses should be written in the form
</span> <userinput>domain.tld:localpart</userinput>. The address is
obfuscated to prevent email harvesters from automatically grabbing
your address. If you want, you can start fixing bugs in the
<span style='display:block; white-space:pre;background:#e0e0e0;'>@@ -782,7 +790,7 @@ To use the current port, you must be in a port's directory.</screen>
</span>
<para>Finally, run <userinput>port info</userinput> again. The
maintainers line in the output should now contain your email
<span style='display:block; white-space:pre;background:#ffe0e0;'>- address.</para>
</span><span style='display:block; white-space:pre;background:#e0ffe0;'>+ address or GitHub username.</para>
</span>
<note>
<para>If you made changes other than the maintainer line, you might
</pre><pre style='margin:0'>
</pre>