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
- 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 python file process is:
- Iterate over all the version folder in sorted order, joining all .md files in only one ( white/pink/black.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:
- Checkout white/master and go to CHANGELOG/
- Run changelog.py (All .md file will be compressed to white.md files, excluding reserved filenames files)
- Replace old RELEASE.md with new generated file
- Git add CHANGELOG/
- Commit & push
- Checkout pink/master and go to CHANGELOG/
- Merge white/master
- Run changelog.py (All .md file will be compressed to pink.md files, excluding reserved filenames files)
- Replace old RELEASE.md with new generated file
- Git add CHANGELOG/
- Commit & push
- Checkout black/master and go to CHANGELOG/
- Merge pink/master
- Run changelog.py (All .md file will be compressed to black.md files, excluding reserved filenames files)
- Replace old RELEASE.md with new generated file
- Git add CHANGELOG/
- Commit & push