Informative text file in release artefacts #126
Description
Context
I had an idea that is maybe beneficial for our projects. I am interested in opinions from others in the team if this would be useful.
When east is creating release artefacts, a simple text file is generated and included in the release artefacts arhive with some basic info. This would serve us developers and the end users for easier navigation, to confirm that all expected files were generated, named and placed in the correct dir and give us basic info - who, when, etc.
That would include (add or remove items if desired):
- full list of files ("sitemap") - in some projects, there would be a lot of artefacts generated for different boards, types, etc. For someone not familiar with the project structure it can take some time to find the correct file.
- date and time of the artefacts generation
- who generated it (CI, PC - which user) - we could just use the test runner or gh actions bot as the user in this case, for other cases east picks up some unique identifier - gh user, pc name, etc.
- release notes?
- links?
Required steps / Implementation details
TBD
Definition of Done
Described feature is implemented, documented, tested and reviewed.