Description
Currently, our release workflow is a bit intimidating to understand. It involves multiple build processes, signing and notarization, packaging of completions and manuals, updating CLI website, updating homebrew and so on.
Some of it is easy enough to understand but plenty of it (particularly signing portions) are not. We should write a document explaining the different steps to help ourselves and future CLI contributors.
Expected Output
The expected output for this issue is:
- A document in this repository explaining the steps in the release process
Notes
I've decided that this should be a document separate from the workflows and scripts themselves. I think it would be better if the workflow were self-documenting but in my opinion the artifacts are currently too disjoint to make for a meaningful maintenance experience. The downside is that it will more likely get out of date, but we don't frequently touch the release process. Additionally, if we change our release process to make it self-documenting, it's likely that having a separate document to refer back to will be more useful than trying to maintain that context in-band.
Description
Currently, our release workflow is a bit intimidating to understand. It involves multiple build processes, signing and notarization, packaging of completions and manuals, updating CLI website, updating homebrew and so on.
Some of it is easy enough to understand but plenty of it (particularly signing portions) are not. We should write a document explaining the different steps to help ourselves and future CLI contributors.
Expected Output
The expected output for this issue is:
Notes
I've decided that this should be a document separate from the workflows and scripts themselves. I think it would be better if the workflow were self-documenting but in my opinion the artifacts are currently too disjoint to make for a meaningful maintenance experience. The downside is that it will more likely get out of date, but we don't frequently touch the release process. Additionally, if we change our release process to make it self-documenting, it's likely that having a separate document to refer back to will be more useful than trying to maintain that context in-band.