The RELEASE.md generation process is as follows:

• An CHANGELOG folder, containing files for the wanted generated RELEASE.md (release file upon now)
• As root of this folder, we have:
  • A folder for each version, each one containing various (0 to multiple) .md one line file, explaining a single change released in the proper version
    • The version folder can contains a date.md file, which contains the realease date
    • The only reserved file names are white.md, pink.md, black.md and date.md
    • Any other file not ending in .md will be ignored
  • header.md, md format lines at the beginning of the release file
  • footer.md, md format lines at the ending of the release file
  • changelog.py, a python file, which will generate the release file
• The python file process is:
  • Iterate over all the version folder in sorted order, joining all .json files in only one .md ( community/prof/corp.md ) in the proper version folder.
  • Generate the release file as header/v0file.md/.../vnfile.md/footer
• The release step-by-step generation should be:
  1. Checkout white/master and go to CHANGELOG/
  2. Run changelog.py (All .md file will be compressed to white.md files, excluding reserved filenames files)
  3. Replace old RELEASE.md with new generated file
  4. Git add CHANGELOG/
  5. Commit & push
  6. Checkout pink/master and go to CHANGELOG/
  7. Merge white/master
  8. Run changelog.py (All .md file will be compressed to pink.md files, excluding reserved filenames files)
  9. Replace old RELEASE.md with new generated file
  10. Git add CHANGELOG/
  11. Commit & push
  12. Checkout black/master and go to CHANGELOG/
  13. Merge pink/master
  14. Run changelog.py (All .md file will be compressed to black.md files, excluding reserved filenames files)
  15. Replace old RELEASE.md with new generated file
  16. Git add CHANGELOG/
  17. Commit & push

As for faraday 3.15.0, the changelog file changed to .json format with this structure:

{
  "level": "community|prof|corp",
  "md": "<changelog text>"
}