ory / sdk

The place where ORY's SDKs are being auto-generated
Apache License 2.0
137 stars 85 forks source link

docs(dart): add additional metadata for pub.dev #263

Closed IchordeDionysos closed 1 year ago

IchordeDionysos commented 1 year ago

Related Issue or Design Document

Adds the repository to the pubspec.yaml so that on pub.dev a link to the repository will be shown to users. https://dart.dev/tools/pub/pubspec#repository

Also adds a longer, more descriptive description to the SDKs to better explain what the individual packages are about and to please pub.dev. Feel free to adjust the description (should be longer than 60 and less than 180 chars) :) I've mostly taken it from the repo descriptions.

image

Checklist

Further comments

CLAassistant commented 1 year ago

CLA assistant check
All committers have signed the CLA.

IchordeDionysos commented 1 year ago

Setting the repository may be blocked by this issue: https://github.com/OpenAPITools/openapi-generator/issues/15214

Seems not to be possible with the generator ...

IchordeDionysos commented 1 year ago

@jonas-jonas do you think it would be possible to update to the next major version once https://github.com/OpenAPITools/openapi-generator/pull/15232 lands? https://github.com/ory/sdk/blob/master/Dockerfile#L74

IchordeDionysos commented 1 year ago

@jonas-jonas I've moved the descriptions to config/descriptions/ if you have a better idea where to put them let me know :)

The idea essentially is when building to read the description from config/description/{project}.txt and put it in the DART_PUB_DESCRIPTION variable, this will then as I understand replace the value in the config/client/dart.yml file.

The openapi-generator will then put the description there instead of the default description.

For setting the repository (which is the more annoying part not being set) we'd need to


Also, should I revert the changes to the pubspec.yaml files or are there some commands that I need to run before merging the changes?

jonas-jonas commented 1 year ago

@IchordeDionysos there are some merge conflicts now, probably due to the changes to the pubspec.yaml. Probably best to revert all those changes here.

IchordeDionysos commented 1 year ago

Reverted the changes :) The repository will not be set now anymore but hopefully the changes to open-api-generator will soon be released in the next release (next week it should be there)

IchordeDionysos commented 1 year ago

Looking better and better 😍

image
jonas-jonas commented 1 year ago

Not sure where the escaped ' is coming from, but small issue :) Looks great, thanks for your help 🙌🏼

IchordeDionysos commented 1 year ago

Yeah tried to debug it but could get the generator to run locally in the half hour I tried it 🤔

IchordeDionysos commented 1 year ago

@jonas-jonas in the file config/client/dart.yml.proc.yml file it looks correct 🤔 image

IchordeDionysos commented 1 year ago

@jonas-jonas Actually I think I found the root cause of the encoding issue https://github.com/OpenAPITools/openapi-generator/pull/15570