Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Document our our release process #9142

Copy link
Copy link

Description

@williammartin
Issue body actions

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.

Reactions are currently unavailable

Metadata

Metadata

Assignees

No one assigned

    Labels

    coreThis issue is not accepting PRs from outside contributorsThis issue is not accepting PRs from outside contributorsdocstech-debtA chore that addresses technical debtA chore that addresses technical debt

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions

    Morty Proxy This is a proxified and sanitized view of the page, visit original site.