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

Track breaking chart version changes #78

Open
mmattel opened this issue Aug 14, 2022 · 4 comments
Open

Track breaking chart version changes #78

mmattel opened this issue Aug 14, 2022 · 4 comments

Comments

@mmattel
Copy link
Contributor

mmattel commented Aug 14, 2022

We have a note in the documentation that a major (breaking) chart change needs manual intervention, but there is nothing described about how to identify the relevant change.

When we will introduce tagging, I propose a change file or files which document the changes from one tagged version to the next which we can include into the documentation. This will help readers to quickly identify those items to take a closer look on.

The HowTo needs to be discussed, but I guess it can be achieved via script.

@wkloucek @dragonchaser

@wkloucek
Copy link
Contributor

I think we have this already fulfilled, right?

@mmattel
Copy link
Contributor Author

mmattel commented Jul 12, 2023

I propose a change file or files which document the changes from one tagged version to the next
+
I think we have this already fulfilled, right?

Mind to point me to the/a changelog file?
I just maybe blind but I havn't found one.
Currently I am collecting changes I identify manually in Mention list for upgrading to the next ocis release to ease doc life, but this is not a future proof way.

@wkloucek
Copy link
Contributor

This ticket is about breaking changes and we have that: https://doc.owncloud.com/ocis/next/deployment/container/orchestration/tab-pages/breaking-changes.html

A general changelog is tracked by #325

@mmattel
Copy link
Contributor Author

mmattel commented Jul 12, 2023

Sorry, hair-splitting, I do not agree.

  • The result of breaking changes are shown in the doc link, where the source of that info is currently coming only via the tracking I make or via discussion with you. Not future proof as written.
  • The changelog issue is currently an issue only, as this one.

We can combine both issues and the result is that there is a changelog file here in ocis-charts that contains both normal and breaking changes. As long there is no physical changelog file present containing both normal and breaking changes, both issues are valid and open.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants