Package registry: add description from UI #20628

simmstein · 2022-08-02T12:37:45Z

This PR fix #20604

The package has 2 new columns: description and readme
Settings contains 2 new fields dedicated to the description (plain text) and the readme (markdown)
Package page contains the description below the package name and the readme below the installation guide
The packages list show descriptions below each package title

KN4CK3R · 2022-08-02T18:04:44Z

Some package types already contain a readme. (Pub (#20560), npm, PyPI)

All package types (except generic) have at minimum a description field which can be provided by the package. For your Docker case you can set the description with LABEL org.opencontainers.image.description=Your description of the image. So I don't think your description field is needed.

And keep in mind the readme may change from version to version. So it may be wrong to have the readme at the package level.

simmstein · 2022-08-05T13:55:18Z

The built-in package description is mainly interesting when you use the package search system. The proposed description is supposed to describe the package inside gitea.
Like docker hub, the readme is a global description which does not depend of the shown version.
This proposal unifies the way to manage descriptions of all packages 📦

wxiaoguang · 2023-05-10T06:58:11Z

Could there be a conclusion from maintainers: go or no-go?

lafriks · 2023-05-10T12:06:26Z

Feature-wise I think it's good

wxiaoguang · 2023-05-12T17:56:22Z

@KN4CK3R has your concern been addressed?

techknowlogick

Thanks for this PR! A few notes in terms of the code, although of course pending @KN4CK3R's feedback too.

techknowlogick · 2023-05-15T21:36:08Z

models/packages/package.go

@@ -130,6 +130,8 @@ type Package struct {
 	Name             string `xorm:"NOT NULL"`
 	LowerName        string `xorm:"UNIQUE(s) INDEX NOT NULL"`
 	SemverCompatible bool   `xorm:"NOT NULL DEFAULT false"`
+	Description      string `xorm:"VARCHAR(255)"`
+	Readme           string `xorm:"LONGBLOB"`


I believe TEXT is more suitable for this column, as xorm should translate it into the appropriate type for each database

LONGTEXT (for MySQL)

techknowlogick · 2023-05-15T21:39:34Z

web_src/js/features/package-editor.js

@@ -0,0 +1,31 @@
+import $ from 'jquery';


Linting rules should prevent the addition of new jQuery code, could you utilize vanilla JS instead?

Cc: @silverwind who has more insight into linting

There is no linting for it, I don't think it's possible for the linter to distinguish old and new code. But yes, new code should prefer not to use jQuery, we want to eventually remove it.

techknowlogick · 2023-05-15T21:41:37Z

models/migrations/v224.go

@@ -0,0 +1,18 @@
+// Copyright 2022 The Gitea Authors. All rights reserved.


Could you move this migration into a versioned directory?
Also, could you update the copyright heading to match the new format?

delvh · 2023-05-10T09:13:04Z

options/locale/locale_fr-FR.ini

+settings.descriptions.success = Les descriptifs ont été mises à jour
+settings.descriptions.error = Échec de la mise à jour des descriptifs
+settings.descriptions = Descriptifs
+settings.description.description = Description
+settings.readme.description = Readme
+settings.descriptions.button = Mettre à jour les descriptifs
+readme = Readme


Will be overridden by the CI again

delvh · 2023-05-13T13:42:33Z

models/packages/package.go

@@ -130,6 +130,8 @@ type Package struct {
 	Name             string `xorm:"NOT NULL"`
 	LowerName        string `xorm:"UNIQUE(s) INDEX NOT NULL"`
 	SemverCompatible bool   `xorm:"NOT NULL DEFAULT false"`
+	Description      string `xorm:"VARCHAR(255)"`
+	Readme           string `xorm:"LONGBLOB"`


Why not LONGTEXT?

models/migrations/v224.go

delvh · 2023-05-13T13:43:47Z

models/migrations/migrations.go

@@ -414,7 +414,7 @@ var migrations = []Migration{
 	// v222 -> v223
 	NewMigration("Drop old CredentialID column", v1_17.DropOldCredentialIDColumn),
 	// v223 -> v224
-	NewMigration("Rename CredentialIDBytes column to CredentialID", v1_17.RenameCredentialIDBytes),
+	NewMigration("Rename CredentialIDBytes column to CredentialID", renameCredentialIDBytes),


This file is absolutely outdated by now as @techknowlogick mentioned in https://github.com/go-gitea/gitea/pull/20628/files#r1194390383

delvh · 2023-05-13T13:44:22Z

templates/package/content/composer.tmpl

@@ -22,6 +22,8 @@
 		</div>
 	</div>

+	{{template "package/content/readme" .}}


A few more registries have been merged in the mean time.
Those should get this call too.

delvh · 2023-05-15T21:48:31Z

web_src/js/features/package-editor.js

+  const $tabMenu = $form.find('.tabular.menu');
+  $tabMenu.find('.item').tab();
+  $tabMenu.find(`.item[data-tab="${$tabMenu.data('preview')}"]`).on('click', function () {


This selector looks really fragile.
Please create a specific class instead and query for that class.

That's just the old code, after the "editor" refactoring, no such code is needed.

Actually, this PR has been stale for too long time, I guess the author might have lost interest on it?

If it is still stale and inactive, it needs the maintainers who have writer permission to help.

routers/web/user/package.go

KN4CK3R · 2023-05-21T17:12:50Z

@KN4CK3R has your concern been addressed?

I'm still not sure if we should have the readme part because some packages already provide a readme and then there would be two readmes shown.

We could store the provided readme in the new readme field, but the provided readme may be version dependend. I don't know if thats really a problem. It may be needed to set/update the readme and description fields from the package metadata (which may again be version dependend).

Github simply shows the README.md file if the package is linked to a (git) repository (similar to the profile readme feature).

wxiaoguang · 2023-05-21T17:29:12Z

Then maybe it (this PR's proposal) needs some real cases for why a separate (non-package) README is needed, to see whether the separate README would be widely used and really needed.

lunny · 2023-05-22T09:17:31Z

Maybe it's like repository which has both description and README.md?

simmstein · 2023-05-22T10:36:44Z

As I said the built-in package description is mainly interesting when you use the package search system. The proposed description is supposed to describe the package inside gitea.
Like docker hub, the readme is a global description which does not depend of the shown version.
This proposal unifies the way to manage descriptions of all packages package: a description shown in list, a readme/bigger description wrote in markdown to get more information (eg: overview of https://hub.docker.com/_/ubuntu).

Co-authored-by: delvh <dev.lh@web.de>

ravensorb · 2023-12-19T20:41:06Z

Would it make sense to consider using the OCI annotation for docmentation -- org.opencontainers.image.documentation then it could be condition (display if the field is provided, don't if it is not)

ref: https://github.com/opencontainers/image-spec/blob/main/annotations.md

simmstein added 9 commits August 2, 2022 11:52

add new cols in package

e7c2d82

replace TEXT to VARCHAR (Description)

adb7da0

add form handler

86d371e

add form ui

413a27d

add package description in packages list

3dceba9

show description and readme in package view

28f3f4e

add translations (en)

39a9549

add translations (fr)

7d309b6

fix lint

0e96572

a1012112796 added the type/feature Completely new functionality. Can only be merged if feature freeze is not active. label Aug 2, 2022

simmstein changed the title ~~WIP: Package registry: add description from UI~~ Package registry: add description from UI Aug 2, 2022

KN4CK3R added the topic/packages label Aug 2, 2022

GiteaBot added the lgtm/need 2 This PR needs two approvals by maintainers to be considered for merging. label Aug 2, 2022

lafriks added this to the 1.18.0 milestone Aug 6, 2022

lunny modified the milestones: 1.18.0, 1.19.0 Oct 19, 2022

simmstein added 2 commits November 13, 2022 18:49

Merge branch 'main' into issue_20604

329aa26

Merge branch 'main' into issue_20604

bb23e8d

jolheiser modified the milestones: 1.19.0, 1.20.0 Jan 31, 2023

wxiaoguang added the issue/needs-feedback For bugs, we need more details. For features, the feature must be described in more detail label May 10, 2023

techknowlogick reviewed May 15, 2023

View reviewed changes

delvh reviewed May 15, 2023

View reviewed changes

Update routers/web/user/package.go

ae6f2f5

Co-authored-by: delvh <dev.lh@web.de>

pull-request-size bot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label May 22, 2023

Update models/migrations/v224.go

3cb0f99

Co-authored-by: delvh <dev.lh@web.de>

delvh removed this from the 1.20.0 milestone Jun 4, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Package registry: add description from UI #20628

Package registry: add description from UI #20628

simmstein commented Aug 2, 2022 •

edited

Loading

KN4CK3R commented Aug 2, 2022

simmstein commented Aug 5, 2022

wxiaoguang commented May 10, 2023

lafriks commented May 10, 2023

wxiaoguang commented May 12, 2023

techknowlogick left a comment

techknowlogick May 15, 2023

delvh May 15, 2023

techknowlogick May 15, 2023

silverwind May 15, 2023

techknowlogick May 15, 2023

delvh May 10, 2023

delvh May 13, 2023

delvh May 13, 2023

delvh May 13, 2023

delvh May 15, 2023

wxiaoguang May 21, 2023

KN4CK3R commented May 21, 2023

wxiaoguang commented May 21, 2023 •

edited

Loading

lunny commented May 22, 2023

simmstein commented May 22, 2023

ravensorb commented Dec 19, 2023

		@@ -0,0 +1,18 @@
		// Copyright 2022 The Gitea Authors. All rights reserved.

Package registry: add description from UI #20628

Are you sure you want to change the base?

Package registry: add description from UI #20628

Conversation

simmstein commented Aug 2, 2022 • edited Loading

KN4CK3R commented Aug 2, 2022

simmstein commented Aug 5, 2022

wxiaoguang commented May 10, 2023

lafriks commented May 10, 2023

wxiaoguang commented May 12, 2023

techknowlogick left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

KN4CK3R commented May 21, 2023

wxiaoguang commented May 21, 2023 • edited Loading

lunny commented May 22, 2023

simmstein commented May 22, 2023

ravensorb commented Dec 19, 2023

simmstein commented Aug 2, 2022 •

edited

Loading

wxiaoguang commented May 21, 2023 •

edited

Loading