DDEV addons - archived and forked repositories

[GuySartorelli]

Right now, an addon in a repository which has been archived doesn't indicate that it's abandoned.

There are two options I can think of for this:

1. don't display it in the ddev add-on list --all list at all, but still allow it to be installed. Then, on installation, output some "this add-on is in an archived repository" message.
2. add some way to indicate the add-on is abandoned when it's displayed in ddev add-on list --all. As above, add a message on installation.

The other scenario I thought of after I noticed this is forked repositories. I haven't checked this, but presumably forks display in the addon list? If they do... should they? If they don't, then I assume this has already been discussed and thought about.

[tyler36]

I think retaining the ability to install/remove archive add-on is important.
Perhaps we simple don't show them in any listing. Out of sight, out of mind, but still available if you know where to look.

The other scenario I thought of after I noticed this is forked repositories.

Forks do NOT appear in the lists. If they did, you would see a ton of addons from @GuySartorelli as they raining down document update PRs at the moment. (Thank you!)

[GuySartorelli]

I think retaining the ability to install/remove archive add-on is important.

Completely agree. I think some sort of message should be output, but definitely still allow them to be installed. This is more about whether and how they appear in the list.

[rfay]

First, @GuySartorelli THANK YOU FOR THE INCREDIBLE WORK, first for the ambitious change and now for the ambitious cleanup!!! Craziness, and so much appreciated.

Second, if a repo does not have the ddev-get topic it doesn't get discovered by ddev add-on list --all, so the first line of defense is to get the author to remove the label. The second line of defense, for archived, as @stasadev says below, we can exclude archived.

[rfay]

@tyler36 :

I think retaining the ability to install/remove archive add-on is important.

The ability to install or remove is not related to the visibility in the github api. Removal is done by the stored information in the .ddev config, and installation can be done via github short-link or full link at any time, even if archived.

[tyler36]

Second, if a repo does not have the ddev-get topic it doesn't get discovered by ddev add-on list --all, so the first line of defense is to get the author to remove the label. The second line of defense, for archived, as @stasadev says below, we can exclude archived.

We can't always count on maintaining being willing or able to remove the label; especially on "abandoned" projects. Ideally, any script should include an "exclude" list that are never display.

[stasadev]

@GuySartorelli Thank you very much for all these updates!

Perhaps we simple don't show them in any listing.

We can exclude archived from the list with archived:false, I see there is one archive now:

https://api.github.com/search/repositories?q=topic:ddev-get+fork:true+archived:true

[GuySartorelli]

Sweet, that sounds sensible. There's no rush to do this, so maybe it can be part of the work to introduce a registry?

[rfay]

It's actually just in the query, PR is welcome. I could be wrong but I think it's just a minor tweak to ListAvailableAddons(),

ddev/pkg/ddevapp/addons.go

Lines 160 to 195 in fae659e

	func ListAvailableAddons(officialOnly bool) ([]*github.Repository, error) {
	client := github2.GetGithubClient(context.Background())
	q := "topic:ddev-get fork:true"
	if officialOnly {
	q = q + " org:" + globalconfig.DdevGithubOrg
	}
	opts := &github.SearchOptions{Sort: "updated", Order: "desc", ListOptions: github.ListOptions{PerPage: 200}}
	var allRepos []*github.Repository
	for {
	repos, resp, err := client.Search.Repositories(context.Background(), q, opts)
	if err != nil {
	msg := fmt.Sprintf("Unable to get list of available services: %v", err)
	if resp != nil {
	msg = msg + fmt.Sprintf(" rateinfo=%v", resp.Rate)
	}
	return nil, fmt.Errorf("%s", msg)
	}
	allRepos = append(allRepos, repos.Repositories...)
	if resp.NextPage == 0 {
	break
	}
	// Set the next page number for the next request
	opts.ListOptions.Page = resp.NextPage
	}
	out := ""
	for _, r := range allRepos {
	out = out + fmt.Sprintf("%s: %s\n", r.GetFullName(), r.GetDescription())
	}
	if len(allRepos) == 0 {
	return nil, fmt.Errorf("No add-ons found")
	}
	return allRepos, nil
	}