search

vishnumaiea / KiExport

Tool to export manufacturing files from KiCad PCB projects.
5 stars 3 forks source link

Feature Request: add change log support #4

Open domleblanc94 opened 1 week ago

domleblanc94 commented 1 week ago

I often keep a changelog.md file with my boards that contains a table of the changes at each revision. I have been playing around with a method of including this within the folder structure as a txt file and can get it working work. I was wondering if: A. This is something you would be interested in supporting. B. If you have any thoughts on a standardised format for this?

vishnumaiea commented 1 week ago

I also do the same. I use a file called Changes.md and you can find one in the Mitayi-Pico project. Since the changelog is something related to the project development and not specifically to the manufacturing files generation, I don't see any reasons to integrate that with KiExport. Instead, changes can and should be tracked project-wise. To me, generated manufacturing files are always tied to a revision. In addition to that, I use the time/date stamp and the commit ID to track the files.

domleblanc94 commented 1 week ago

Maybe I should have worded this differently, from what I can see your changes.md file is your commit messages. What I was meaning was more like a release note for the given revision. If you don't feel the need for this I will come up with my open implementation on my fork.

domleblanc94 commented 1 week ago

The structure I was thinking of looks something like this with the intention being to give anyone who may not be familiar with a project an easy way to see what may have changed between different revisions. I could also include a compatibility table for FW if the hardware breaks backwards compatibility.

# Revision XXX Released YYYY-MM-DD
## BOM
### Removed
- C1

### Added
-  R5
- IC6

## Changed
- R1 now 10k

## Schematic
- Added SPI connections to IC1

## PCB
- Moved location of IC3 to make room for IC6

# Revision A Released  2024-11-11
Initial Release
vishnumaiea commented 6 days ago

Maybe I should have worded this differently, from what I can see your changes.md file is your commit messages. What I was meaning was more like a release note for the given revision. If you don't feel the need for this I will come up with my open implementation on my fork.

Usually, the commit messages will eventually make up the release notes if a project is rolled out on based on releases. That's what I do. I simply copy the entire list of commit messages from the last release and tidy it up for a general release note. But there is no universal way of doing this as far as I know. So I think it is still outside the scope of KiExport. But feel free to implement your own method 😉 Looking forward to seeing what you're going to come up with.