Adding a change log

[IshaanDesai]

Adding a CHANGELOG to the tutorials repository.

[MakisH]

Looks good: it looks like you followed the format used in preCICE and you transferred the release notes (have not checked in detail).

Just remember to contribute the changelog entries as independent files, to avoid merge conflicts.

[IshaanDesai]

Just remember to contribute the changelog entries as independent files, to avoid merge conflicts.

I dont really understand what you are saying here, can you please explain more 😅

[davidscn]

Have a look at the preCICE changelogs: https://github.com/precice/precice/tree/develop/docs/changelog

The CHANGELOG file is usually only updated for new version release. The changelog entries are collected in separate files in order to avoid merge conflicts.

[IshaanDesai]

Have a look at the preCICE changelogs: https://github.com/precice/precice/tree/develop/docs/changelog

The CHANGELOG file is usually only updated for new version release. The changelog entries are collected in separate files in order to avoid merge conflicts.

Okay, so this would only be valid for changes done from the last release till now correct? And how do we decide the numbers in the names of the files? Would the merge conflicts happen because multiple feature developments would consecutively edit the CHANGELOG? In that case does it not work if every feature developer just pulls, resolves the conflict and pushes to the CHANGELOG?

[davidscn]

Have a look at the preCICE changelogs: https://github.com/precice/precice/tree/develop/docs/changelog
The CHANGELOG file is usually only updated for new version release. The changelog entries are collected in separate files in order to avoid merge conflicts.

Okay, so this would only be valid for changes done from the last release till now correct? And how do we decide the numbers in the names of the files? Would the merge conflicts happen because multiple feature developments would consecutively edit the CHANGELOG? In that case does it not work if every feature developer just pulls, resolves the conflict and pushes to the CHANGELOG?

The numbers in the file names correspond to the PR number of the repo. To your second questions: yes that's right and yes that would be done as an alternative.

[fsimonis]

In that case does it not work if every feature developer just pulls, resolves the conflict and pushes to the CHANGELOG?

Yes, but this results in a merge conflict for each change since the PR started. Most importantly, it is so annoying that devs become angry. And angry devs are not got at resolving merge conflicts without accidentally deleting old entries.

The steps are easy:

• define a dir that doesn't break the jekyll import script.
• Use a script to create the changelong example
• Use a script to generate new entries using gh-cli example

[uekerman]

Some c&p problems I guess. Otherwise good to go from my side.
I am not sure about the markdown lint things.

Do we want to have the changelog-entries under docs?

[IshaanDesai]

Do we want to have the changelog-entries under docs?

I now have the entries at the base directory

[IshaanDesai]

The failing workflows are not relevant to the addition of the CHANGELOG and hence need to be investigated independently.

[MakisH]

I noticed 2-3 small things. Please consider them and then feel free to merge!

[MakisH]

Just FYI: this seems to be unrelated. But if this is coming from another branch, then it is fine.

[IshaanDesai]

This is indeed a change coming from another PR but as the whole change-log system is implemented here, it has been added via this PR.