Release of API version 1.0.0-rc.1

[bigludo7]

What type of PR is this?

Add one of the following kinds:

• documentation
• subproject management

What this PR does / why we need it:

Generation of first release-candidate for OTPValidationAPI

This first release candidate r1.1 contains the definition and documentation of the release-candidate of the OTPValidation API v1.0.0-rc.1.

Which issue(s) this PR fixes:

Fixes

Special notes for reviewers:

Changelog input

 release-note

Additional documentation

This section can be blank.

docs

[github-actions]

🦙 MegaLinter status: ✅ SUCCESS

Descriptor	Linter	Files	Fixed	Errors	Elapsed time
✅ ACTION	actionlint	2		0	0.03s
✅ OPENAPI	spectral	1		0	1.64s
✅ REPOSITORY	git_diff	yes		no	0.01s
✅ REPOSITORY	secretlint	yes		no	0.68s
✅ YAML	yamllint	1		0	0.36s

See detailed report in MegaLinter reports

MegaLinter is graciously provided by

[hdamker]

@bigludo7 The CHANGELOG.md should be updated as part of the release PR. I suppose you plan to do first the pre-release with the release candidate of v1.0.0. The release tag would be r1.1, the title in changelog be "r1.1 - rc", the API Version 1.0.0-rc.1. The PR should also change the version and base path within the YAML at the same time and do the final updates within the API Readiness Checklist.

For the CHANGELOG entry there is a template available within CHANGELOG_TEMPLATE.md.

Contentwise: I wouldn't call the stable release a "patch release". It will be just the first stable release (and here the release candidate of it). The reference to the changes within v0.5.0 don't help, as there were nothing documented ;-(

I created a "draft release" with GitHub to see the relevant changes since v0.5.0, I suppose the following PRs should be mentioned, but reformulated and sorted into the categories:

---

• Make '+' mandatory for phoneNumber by @bigludo7 in Make '+' mandatory for phoneNumber #50
• Fixed one-time-password-sms.yaml after megalinter check by @bigludo7 in Fixed one-time-password-sms.yaml after megalinter check #53
• Update Authorization and authentication part accordingly to ICM by @bigludo7 in Update Authorization and authentication part accordingly to ICM #65
• Align securitySchemes with ICM by @fernandopradocabrillo in Align securitySchemes with ICM #68

(plus the ones which are still open)

New Contributors

• @fernandopradocabrillo made their first contribution in Fernando replaces Mona as maintainer #37
• @rartych made their first contribution in GitHub workflows #60

Full Changelog: v0.5.0...r1.1

---

I'm on vacation the next days, but the Release Management team (e.g. Tanja) can help if needed.

[bigludo7]

Thanks @hdamker
This is very helpful. I have rename the issue in order to tackle here the release candidate. Once PR #73 solve i will in this PR add the -rc yaml. I will also work here for the readme file.

Hope I'm on the right way

[bigludo7]

I did another review considering a) the proposed renaming of the repository in #75 b) that the actual API is one-time-password-sms, not "OTP Validation API"

I did not proposed all changes within the generated links ... they will continue to work after the renaming.

Thanks a lot @hdamker for the help !

[hdamker]

@bigludo7 I approved the changes as they are working as expected (GitHub does not care about upper/lower case in the repository name). But the repository name is now "OTPValidation", not "OTPvalidation" ...

[hdamker]

Please add @camaraproject/release-management_maintainers if ready for final review.

[hdamker]

@bigludo7 Very minor comments from the final review done in context of camaraproject/ReleaseManagement#56

[hdamker]

Name of the file should be one-time-password-sms-API-Readiness-Checklist.md

[bigludo7]

done :)

[hdamker]

LGTM from ReleaseManagement view - suppose we are done here.

@fernandopradocabrillo the PR still needs a codeowner review before it can be merged

[fernandopradocabrillo]

@hdamker sorry for the late review

LGTM

[hdamker]

@fernandopradocabrillo the PR can be merged and the release created. Let me know if you need support here.

[hdamker]

@fernandopradocabrillo there seem to be no additional comments. Can you please merge the PR and create the release?

[fernandopradocabrillo]

@fernandopradocabrillo there seem to be no additional comments. Can you please merge the PR and create the release?

Sure! Sorry I didn't see the notification