Review existing implementation #16
Description
When trying out the current implementation, it appears we need to slightly improve some parts of the action before making it generally available. More specifically:
- Improving the scope of the action, which currently doesn't match the requirements - it provides artefacts for readme, licence, documentation, testing and requirements, but fails to mention coding guidelines and release process. See the intended scope for more information.
- Similarly, adding the artefacts to the release assets is not required - the SDV maturity assessment scripts already archive them in a separate, independent repository. Granularity and kiss principle are important, as not every project has the same needs in terms of e.g. release assets. We need to provide an action that makes one thing, and one thing only, and the documentation should make it clear.
- The documentation could be slightly improved. We need to provide an example that shows a simple use case, with only bare minimum working inputs. The readme file is a bit confusing: first extract doesn't show the manifest upload, and second extract lists several steps that are not required. Also, the only example we have today, up-rust in Eclipse uProtocol, uses another action, and has a very (fine and) complex automation system that makes it hard for newcomers to know what part they should be reusing.
I will propose an update of the existing code and documentation to reach the intended first scope - i.e. requirements for the SDV maturity assessment badges as they are defined today. In a second step, we will discuss how to add the Trustable framework inputs to the assessment.