search

camaraproject / SimpleEdgeDiscovery

Repository to describe, develop, document and test the SimpleEdgeDiscovery API (part of EdgeCloud API family)
Apache License 2.0
1 stars 2 forks source link

changed version to 0.10.0-alpha.1 #4

Closed Kevsy closed 3 months ago

Kevsy commented 3 months ago

What type of PR is this?

Add one of the following kinds:

What this PR does / why we need it:

First upload of YAML from previous Edge Cloud sub-project, incorporating the scope of Simple Edge Discovery for Fall 24 Release #3

Which issue(s) this PR fixes:

Fixes issue 3 (which will remain pinned/open as it relates to the release scope )

Special notes for reviewers:

Changelog input

 release-note
 Incorporates the changes listed in  #3

Additional documentation

This section can be blank.

docs
hdamker commented 3 months ago

@Kevsy two options here:

1) This is already the PR which creates the alpha release. Then it should contain the CHANGELOG.md and the change to the README. Please add in the CHANGELOG also the link to the YAML within EdgeCloud (the exact commit which you have copied (I suppose that is https://github.com/camaraproject/EdgeCloud/blob/ed32560de80e55943d67766a040962df54d5498b/code/API_definitions/Discovery/simple_edge_discovery.yaml) In this case you have to set also the URL to simple-edge-discovery/v0.10alpha.1

2) Recommend: you use this PR only to transfer the YAML and doing a release PR after some correction. Then the version both in version field and the URL would be "wip" for now.

Kevsy commented 3 months ago

Thanks @hdamker ,

@Kevsy two options here:

  1. Recommend: you use this PR only to transfer the YAML and doing a release PR after some correction. Then the version both in version field and the URL would be "wip" for now.

Done

Need to be aligned with the version number.

Done

These lines are producing a linting error as they are not intended.

Done, removed

Also removed the release tag.

Kevsy commented 3 months ago

Looks good to me. Perhaps you want to include the SED.test file since both files are in the Edge Cloud repository or do you want to wait for Commonalities 0.4 to upload all the necessary documents?

Thanks @javierlozallu - I'll make a separate PR for that, and probably wait for the Commonalities v0.4 which will confirm the instructions in https://github.com/camaraproject/Commonalities/blob/main/documentation/API-Testing-Guidelines.md