The list is directly in readme.md, because why not...

# UppHub

```

It is not parsable as a JSON file ...
I cannot use it with my build automation system because of this markdown formatting:

I think the parser should first check for the upphub markers/sentinels (UPPHUB_BEGIN, UPPHUB_END), if the file is not marked explicitly as json.

      "readme": "https://raw.githubusercontent.com/mirek-fidler/gdal/master/README.md"
    }
    }

There is still a bug in this JSON file:

"readme": " https://raw.githubusercontent.com/mirek-fidler/gdal/master/R EADME.md"
}
}


(an extra curly brace ...)

Hello Mirek,

As I proposed early UppHub should not be under mirek-fidler. It should be in ultimatepp organization as separate repository. The organization is easier to find and it is common good. Right now we have several people in organization, so we can give them rights to maintain the list. Also, I would like to have everything in one place. So, I do not jump to mirek-fidler when I am look at ultimatepp repository.

I still see that package manifest is integrated with the ".json" file. What is your plan here? Do you plan to let repository construct manifest and keep single link on the list?

Would be nice to have some hind of json validation on CI/CD to do not break the list. This can be implemented later.

mirek wrote on Sat, 30 January 2021 14:50

The list is directly in readme.md, because why not...

It is not parsable as a JSON file ...
I cannot use it with my build automation system because of this markdown formatting:

# UppHub

```

#include <Core/Core.h>

using namespace Upp;

CONSOLE_APP_MAIN
{
	HttpRequest r("https://raw.githubusercontent.com/ultimatepp/UppHub/main/README.md");
		
	String s = r.Execute();
	
	int begin = s.FindAfter("UPPHUB_BEGIN");
	int end = s.Find("UPPHUB_END");
	
	if(begin >= 0 && end >= 0)
		s = s.Mid(begin, end - begin);

	Value v = ParseJSON(s);
	if(v.IsError()) {
		s.Replace("&quot;", "\"");
		s.Replace("&amp;", "&");
		v = ParseJSON(s);
	}
	
	ASSERT(!v.IsError());
}

Well, the idea is

a) this README.md is not to be visited by users, so it does not really matter
b) you can edit it directly in github

Adding check to autotest...

Novo wrote on Sun, 31 January 2021 13:34

mirek wrote on Sat, 30 January 2021 14:50

The list is directly in readme.md, because why not...

It is not parsable as a JSON file ...
I cannot use it with my build automation system because of this markdown formatting:

# UppHub

```

#include <Core/Core.h>

using namespace Upp;

CONSOLE_APP_MAIN
{
	HttpRequest r("https://raw.githubusercontent.com/ultimatepp/UppHub/main/README.md");
		
	String s = r.Execute();
	
	int begin = s.FindAfter("UPPHUB_BEGIN");
	int end = s.Find("UPPHUB_END");
	
	if(begin >= 0 && end >= 0)
		s = s.Mid(begin, end - begin);

	Value v = ParseJSON(s);
	if(v.IsError()) {
		s.Replace("&quot;", "\"");
		s.Replace("&amp;", "&");
		v = ParseJSON(s);
	}
	
	ASSERT(!v.IsError());
}

Hello Mirek,

Quote:

Well, the idea is

a) this README.md is not to be visited by users, so it does not really matter
b) you can edit it directly in github

The README.md can be visited by the user. If you found ultimatepp organization and then you are curious what is UppHub then you will see the list of the packages without any description. I think we need minimal README.md for UppHub repository. READSME.md file is all about communication with the visitor. If we push there dry data then the visitor will lose the learning opportunity. In our case README.md should contains description - what is UppHub and how can I add package to it, also adding links to our documentation would be valuable.

You can edit any file direcly on github not only README.md, so if you put upphub.json you can edit it too directly on GitHub (like any other text files). Please noticed that users outside organization will still needs to create PR for any modification. For us this is wanted behavior.

Quote:

Adding check to autotest...

Can you publish the results of automation somewhere. I think it would be nice if we have idea how stable upp is at the moment. Now you have this knowledge This check is indeed the step in the good direction, however if I modify (as a maintainer) the file and break the json the regression will be detected later. Why do not integrate parsing validator that is offer by GitHub for free for open source organization. I can help with it. The check will be triggered automatically when someone push something to master or on PR.

Klugier

For some reason an UppHub repo has completely disappeared from GitHub ...

Hello Mirek,

I added support for CircleCI that runs jsonschema after each commit. Here is the PR. This should detects any mistake very fast and it should prevent from committing faulty json. Also, it supports schema, so we can extend it to make sure that json have tags we designed.

Please review and apply. Also, the nests was moved from README.md to nests.json.

Klugier

Hello Mirek,

I added support for CircleCI that runs jsonschema after each commit. Here is the PR. This should detects any mistake very fast and it should prevent from committing faulty json. Also, it supports schema, so we can extend it to make sure that json have tags we desired.

Please review and apply. Also, the nests was moved from README.md to nests.json.

Klugier