OffTopic: DependencyUpdater

src/templates/default.trac

+{#
+This file is part of Adblock Plus <https://adblockplus.org/>,
+Copyright (C) 2006-present eyeo GmbH
+
+Adblock Plus is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License version 3 as
+published by the Free Software Foundation.
+
+Adblock Plus is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with Adblock Plus.  If not, see <http://www.gnu.org/licenses/>.
+#}
+=== Background ===

[kzar, 2017/11/10 14:32:01]

As mentioned in IRC it would be cool to print out the Issue subject at the top
here, then a blank line, then the issue body.

[tlucas, 2017/11/13 14:34:08]

Done.

+
+CHANGE ME!
+
+=== Included changes in `{{ repository }}` ===
+The list of changes imported by this is:
+[[TicketQuery({%- for issue_id in issue_ids -%}
+    id={{ issue_id }}{%- if not loop.last -%}&{%- endif -%}
+{%- endfor -%}
+,order=id,desc=1,format=table,col=summary|component)]]
+
+{% for change in noissues -%}
+|| [{{ change.hg_url }} {{ change.hg_hash }}] || {{ change.message }} || {{ change.author }} ||
+{% endfor %}
+
+=== What to change ===
+Update the `{{ repository }}` dependency to:
+
+|| **mercurial** || **git** ||
+|| {{ hg_hash }} || {{ git_hash }} ||

[kzar, 2017/11/10 14:32:01]

As mentioned in IRC I think the format like `hg:{{ hg_hash}} git:{{ git_hash }}`
would be more useful. (Or even better if the hashes were also links to the
commits in hg.adblockplus.org and Github too!)

[tlucas, 2017/11/13 14:34:08]

I think this would useful, yes - but i personally wouldn't do that in the
default template (most dependency update issues i had a look at followed this
default pattern), i'd rather add another (fully functional) example to the
README.md, which would then include this.

[kzar, 2017/11/13 15:20:45]

I disagree on this one, but it's not hugely important.

+
+=== Integration Notes ===
+
+CHANGE ME!
+
+=== Hints for testers ===
+
+CHANGE ME!