Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merge latest release notes with CLI and Sample repo info #642

Closed
wants to merge 1 commit into from

Conversation

artemkovalyov
Copy link
Member

What Has Changed?

Convert release notes into slightly more logical structure

Manual Checks?

  • Text adheres to the style guide (vale docs/)
    • Every sentence is on its own line
    • Headings use title capitalization (applies also to the sidebar and title of a document)
    • You followed naming center guidelines when referring to SAP products (e.g. SAP S/4HANA)
  • You checked your spelling and grammar (consider using Grammarly, see CONTRIBUTING.md)
  • You formatted all changed files with prettier (npm run prettier)
  • You tested if the documentation still builds (npm run build)
  • You verified all new and changed links still work (changing the id or name of a file can break links)
  • You have updated the feature matrix if you add documentation on a new feature or otherwise required.

Copy link
Contributor

@jjtang1985 jjtang1985 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for taking care.
I feel merging the release notes might lead to confusing to the users and to us.
If the vale issue cannot be solved, I would even vote for deleting them from the release notes and keep them in some other pages if we need.

### Improvements

- We updated the version of `@sap/edm-converters` to ensure Node 14 compatibility for the OData code generator.
- We published a new [repository with samples and starter projects](https://github.com/SAP-samples/cloud-sdk-js) for the SAP Cloud SDK for JavaScript.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I feel a bit confusing, as the the sample repo is not related to the new patch release.


[GitHub](https://github.com/SAP-samples/cloud-sdk-js)
- We deprecated on [npm](https://www.npmjs.com/package/@sap-cloud-sdk/cli) and archived on GitHub the [SAP Cloud SDK CLI](https://github.com/SAP-archive/cloud-sdk-cli)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also here, the cli repository and the npm package has nothing to do with the patch release.

@jjtang1985
Copy link
Contributor

Please check #644, @artemkovalyov .

@artemkovalyov
Copy link
Member Author

artemkovalyov commented Jan 19, 2022

Here's my thinking @jjtang1985, SDK is a product as a whole. Samples repo or CLI don't have any value separately. That's why I look at the release of the core module as on a train to communicate other updates related to the development with the SDK.

Semantically, you are right but for customers having samples repo, CLI that is no longer developed is even more confusing.
I think we can restructure things by simply having a release date and collecting together everything that made it out by that date or around it. No customer would care about when we published the samples repo or deprecated the CLI 99.99% of the time.

What would you prefer as an approach? Would you be confused really or is it just your assumption the customers will be confused?
This is also a reason why having only a trace log of releases on the GH repo doesn't work any longer.

@CharlesDuboisSAP CharlesDuboisSAP deleted the release-notes-js branch September 27, 2023 07:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants