馃毀馃彈馃懛 Accept and deliver What's New information #580
Conversation
Signed-off-by: Arthur Schiwon <blizzz@arthur-schiwon.de>
|
What about simply parsing https://keepachangelog.com/en/1.0.0/ which is already supported by the store? |
That's too detailed. The idea is to provide up to 3 easy-understandable, non-technical items for end users (plus three for admins). Sort of release highlights. |
|
Have you thought about using dashes instead of camel case? e.g. <whats-new> instead of <whatsNew> etc? |
| <xs:element name="regular" type="whatsNewInfo" minOccurs="1" maxOccurs="1" /> | ||
| <xs:element name="admin" type="whatsNewInfo" minOccurs="0" maxOccurs="1" /> | ||
| </xs:sequence> | ||
| <xs:attribute name="lang" type="language" use="required" /> |
There was a problem hiding this comment.
@MorrisJobke how would this interact with translation? Not sure what your plans are currently for translating xml contents.
There was a problem hiding this comment.
We just put them in the same file: https://github.com/nextcloud/changelog_server/blob/master/data/14.0.0.xml#L16
| <xs:simpleType name="version"> | ||
| <xs:restriction base="xs:string"> | ||
| <xs:pattern value="(0|[1-9][0-9]*)\.(0|[1-9][0-9]*)\.(0|[1-9][0-9]*)"/> | ||
| <xs:minLength value="6"/> |
There was a problem hiding this comment.
I'd drop the min and max length requirements. min length of 6 makes 0.0.1 invalid btw.
|
|
||
| <!-- based on xs:language, just uses _ as a separator between lang and region. --> | ||
| <xs:simpleType name="language"> | ||
| <xs:restriction base="xs:token"> |
There was a problem hiding this comment.
Should maybe consistent with https://github.com/nextcloud/appstore/blob/master/nextcloudappstore/api/v1/release/info.xsd#L136
| <xs:element name="whatsNew" minOccurs="1" maxOccurs="unbounded"> | ||
| <xs:complexType> | ||
| <xs:sequence> | ||
| <xs:element name="regular" type="whatsNewInfo" minOccurs="1" maxOccurs="1" /> |
There was a problem hiding this comment.
What if there are only admin changes? like "ui for configuring additional mount type"
There was a problem hiding this comment.
Yeah, we should consider that. Might make sense for the server, too, as the maintenance releases often don't have much to brag about, but subtle bug fixes.
| @@ -35,6 +35,9 @@ def get_release_info(self, url: str, is_nightly: bool = False) -> Release: | |||
| info = parse_app_metadata(meta.info_xml, self.config.info_schema, | |||
| self.config.pre_info_xslt, | |||
| self.config.info_xslt) | |||
| if meta.changes_xml: | |||
| whats_new = parse_app_whats_new(meta.changes_xml, self.config.changes_schema, | |||
There was a problem hiding this comment.
Looks like an unused variable. If it's just for validation simply remove the assignment
| <item>First {{ app.name }} release!</item> | ||
| </regular> | ||
| <admin> | ||
| <item>requires {{ app.nextcloud_version }}</item> |
There was a problem hiding this comment.
This is redundant with the version in info.xml and probably a bad example for new developers. Better example or simply remove it?
| <xs:element name="release"> | ||
| <xs:complexType> | ||
| <xs:sequence> | ||
| <xs:element name="changelog" maxOccurs="1" minOccurs="1"> |
There was a problem hiding this comment.
This could be optional and re-use the CHANGELOG.md in the app folder by default
.
|
fyi, i was sick and need to reschedule a bit. so, will be a bit until i pick it up again. |
|
hi, is there any progression in this? This would be very very useful to have. |
馃毀 WIP solves #578 馃毀