Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(softwareCenter): add release note URLs for GitHub code repositories #795

Merged
merged 16 commits into from
Feb 3, 2025
Merged

feat(softwareCenter): add release note URLs for GitHub code repositories #795

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
3c3127e
feat(softwareCenter): add release note URLs for GitHub code repositories
stephdl Jan 29, 2025
ce47432
fix: ensure release note URL is set correctly for GitHub code reposit…
stephdl Jan 29, 2025
639c47f
Apply suggestions from code review
stephdl Jan 29, 2025
754a0e9
feat(SoftwareCenter): add release notes URL to the repodata schema
stephdl Jan 29, 2025
6b1777a
fix: update schema to use string type for URLs
stephdl Jan 30, 2025
49e6f9a
feat(AppInfoModal): add release notes link to app info modal
stephdl Jan 30, 2025
77fd716
feat(ReleaseNotes): add release notes link for app versions in Update…
stephdl Jan 30, 2025
89c35f2
feat(SoftwareCenter): add release notes column and translation to cor…
stephdl Jan 30, 2025
3e2cccc
refactor(UpdateAppModal): remove release notes link for app version
stephdl Jan 30, 2025
f5a31d9
feat(SoftwareCenter): display release notes in the version column
stephdl Jan 30, 2025
88ee89a
feat(SoftwareCenter): display in the update column with icon
stephdl Jan 30, 2025
59a9d6b
refactor(SoftwareCenterCoreApps): display changelog inline
stephdl Jan 30, 2025
d8cd85e
feat(SoftwareCenterAppInstances): add launch icon to release notes link
stephdl Jan 30, 2025
0d0d30c
refactor(SoftwareCenterCoreApps): replace release notes link with but…
stephdl Jan 30, 2025
3a5f15a
feat(SoftwareCenterAppInstances): replace release notes link with but…
stephdl Jan 30, 2025
b9f0e2a
refactor(i18n): remove 'release_notes' key from translations
stephdl Jan 30, 2025
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
4 changes: 4 additions & 0 deletions core/imageroot/usr/local/agent/pypkg/cluster/modules.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -336,6 +336,10 @@ def _get_available_modules(rdb):
continue # skip duplicated images from lower priority modules
modules[rmod["source"]] = rmod
rmod['versions'].sort(key=lambda v: _parse_version_object(v["tag"]), reverse=True)
# Set the general release note URL if the code URL is a GitHub repository
if rmod['docs']['code_url'].startswith("https://github.com/") and 'relnotes_url' not in rmod['docs']:
rmod['docs']['relnotes_url'] = f"{rmod['docs']['code_url']}/releases"

# Integrate the available set with instances that do not belong to any
# repository. They can be found in the "installed" dict:
for module_source, module_instances in list_installed(rdb).items():
Expand Down
12 changes: 8 additions & 4 deletions core/imageroot/var/lib/nethserver/cluster/actions/list-modules/validate-output.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -160,19 +160,23 @@
"type": "object",
"parameters": {
"terms_url": {
"type": "uri",
"type": "string",
"format": "uri",
"description": "Optional link to the application Terms & Conditions document"
},
"documentation_url": {
"type": "uri",
"type": "string",
"format": "uri",
"description": "Link to the package documentation"
},
"bug_url": {
"type": "uri",
"type": "string",
"format": "uri",
"description": "Link to the package issue tracker"
},
"code_url": {
"type": "uri",
"type": "string",
"format": "uri",
"description": "Link to the source code repository"
}
},
Expand Down
20 changes: 15 additions & 5 deletions core/imageroot/var/lib/nethserver/cluster/repodata-schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,8 @@
"docs": {
"documentation_url": "https://docs.nethserver.org",
"bug_url": "https://github.com/NethServer/dev",
"code_url": "https://github.com/NethServer/"
"code_url": "https://github.com/NethServer/",
"relnotes_url": "https://github.com/NethServer/ns8-kickstart/releases"
},
"source": "ghcr.io/nethserver/dokuwiki",
"versions": [
Expand Down Expand Up @@ -116,20 +117,29 @@
"type": "object",
"parameters": {
"terms_url": {
"type": "uri",
"type": "string",
"format": "uri",
"description": "Optional link to the application Terms & Conditions document"
},
"documentation_url": {
"type": "uri",
"type": "string",
"format": "uri",
"description": "Link to the package documentation"
},
"bug_url": {
"type": "uri",
"type": "string",
"format": "uri",
"description": "Link to the package issue tracker"
},
"code_url": {
"type": "uri",
"type": "string",
"format": "uri",
"description": "Link to the source code repository"
},
"relnotes_url": {
"type": "string",
"format": "uri",
"description": "Optional link to the application release notes"
}
},
"required": [
Expand Down
3 changes: 2 additions & 1 deletion core/ui/public/i18n/en/translation.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,8 @@
"configure": "Configure",
"terms_and_conditions": "Terms and Conditions",
"terms_required": "Please read and agree to @:common.terms_and_conditions",
"not_available": "Not available"
"not_available": "Not available",
"release_notes": "Release notes"
},
"error": {
"error": "Error",
Expand Down
8 changes: 8 additions & 0 deletions core/ui/src/components/software-center/AppInfoModal.vue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -157,6 +157,14 @@
</cv-link>
</span>
</template>
<template v-if="app.docs.relnotes_url">
&bull;
<span>
<cv-link :href="app.docs.relnotes_url" target="_blank">
{{ $t("common.release_notes") }}
</cv-link>
</span>
</template>
</div>
</div>
</template>
Expand Down
17 changes: 17 additions & 0 deletions core/ui/src/views/SoftwareCenterAppInstances.vue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -323,6 +323,23 @@
})
}}
</div>
<div
v-if="
app.docs.relnotes_url &&
isStableUpdateAvailable(app, instance)
"
class="row"
>
<cv-link
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We can use a standard <a href="..." here and remove class="row icon-and-text"

class="row icon-and-text"
:href="app.docs.relnotes_url"
target="_blank"
>
<NsButton kind="ghost" :icon="Launch20">
{{ $t("common.release_notes") }}
</NsButton>
</cv-link>
</div>
<div class="row actions">
<!-- app is installed and can be updated -->
<template v-if="isStableUpdateAvailable(app, instance)">
Expand Down
9 changes: 9 additions & 0 deletions core/ui/src/views/SoftwareCenterCoreApps.vue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,6 +100,15 @@
<cv-data-table-cell>{{ row.version }}</cv-data-table-cell>
<cv-data-table-cell v-if="isCoreUpdatable">
{{ row.update || "-" }}
<cv-link
v-if="row.docs.relnotes_url && row.update"
:href="row.docs.relnotes_url"
target="_blank"
>
<NsButton kind="ghost" :icon="Launch20">
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same as above

{{ $t("common.release_notes") }}
</NsButton></cv-link
>
</cv-data-table-cell>
</cv-data-table-row>
</template>
Expand Down