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

Deep Dive Document Release Process - #10503

#10503
Merged
williammartin merged 13 commits into
trunkcli/cli:trunkfrom
wm/document-release-processcli/cli:wm/document-release-processCopy head branch name to clipboard
Mar 4, 2025
Merged

Deep Dive Document Release Process#10503
williammartin merged 13 commits into
trunkcli/cli:trunkfrom
wm/document-release-processcli/cli:wm/document-release-processCopy head branch name to clipboard

Conversation

@williammartin

@williammartin williammartin commented Feb 25, 2025

Copy link
Copy Markdown
Member

Description

Fixes #9142

As I went through the workflow documenting pieces, it occurred to me that some of this information should be brought back into the scripts directly in the form of comments or restructuring. However, that is out of scope for this issue which was purely about providing some kind of structured documentation around the workflow.

@williammartin
williammartin force-pushed the wm/document-release-process branch 2 times, most recently from df241e5 to 3dac1fd Compare February 25, 2025 15:34
@williammartin
williammartin force-pushed the wm/document-release-process branch from 3dac1fd to 77e9899 Compare February 25, 2025 15:56

@jtmcg jtmcg left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great stuff so far! Very few comments on how you've ordered this and presented it - I found it quite easy to follow.

Comment thread docs/release-process-deep-dive.md
Comment thread docs/release-process-deep-dive.md Outdated
Comment thread docs/release-process-deep-dive.md
Comment thread docs/release-process-deep-dive.md Outdated
```
</details>

In addition to building and signing release artifacts, the `linux` job builds the [CLI manual](https://cli.github.com/manual/) for use in the later `release` job.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a weird place to put this... I'd have expected this to be its own job

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Unfortunately, there are no comments in #7324 to explain mislav reasoning for nestling this within the linux job. Hazarding a guess, I'd say minimizing the number of jobs and build minutes might have been the original motivation.

Comment thread docs/release-process-deep-dive.md
Comment thread docs/release-process-deep-dive.md
Comment thread docs/release-process-deep-dive.md Outdated

@andyfeller andyfeller left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Solid draft with a few minor nits, questions, and insights.

Comment thread docs/release-process-deep-dive.md Outdated
Comment thread docs/release-process-deep-dive.md Outdated
Comment thread docs/release-process-deep-dive.md Outdated
Comment thread docs/release-process-deep-dive.md Outdated
Comment thread docs/release-process-deep-dive.md Outdated
Comment thread docs/release-process-deep-dive.md Outdated
Comment thread docs/release-process-deep-dive.md Outdated
@andyfeller

Copy link
Copy Markdown
Contributor

The only other thing not really touched on in this document relates to official and unofficial operating systems and CPU architectures supported. I say that because 32-bit Android support is this weird situation where GitHub CLI does not officially support it except for cli/gh-extension-precompile for building extensions.

@williammartin

Copy link
Copy Markdown
Member Author

I believe I've addressed all first round comments in 48ce3a2. Now I'll move onto fleshing out the TODOs.

@williammartin
williammartin marked this pull request as ready for review March 3, 2025 14:22
@williammartin
williammartin requested a review from a team as a code owner March 3, 2025 14:22
@williammartin
williammartin requested a review from andyfeller March 3, 2025 14:22

@andyfeller andyfeller left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fairly extensive in all the right ways; several components in this latest update I didn't understand before but feel more confident of. 💯

Comment thread docs/release-process-deep-dive.md
Comment thread docs/release-process-deep-dive.md Outdated
Comment thread docs/release-process-deep-dive.md
Comment thread docs/release-process-deep-dive.md Outdated
@williammartin
williammartin merged commit b8cf16d into trunk Mar 4, 2025
@williammartin
williammartin deleted the wm/document-release-process branch March 4, 2025 12:30
tmeijn pushed a commit to tmeijn/dotfiles that referenced this pull request Mar 6, 2025
This MR contains the following updates:

| Package | Update | Change |
|---|---|---|
| [cli/cli](https://github.com/cli/cli) | minor | `v2.67.0` -> `v2.68.0` |

MR created with the help of [el-capitano/tools/renovate-bot](https://gitlab.com/el-capitano/tools/renovate-bot).

**Proposed changes to behavior should be submitted there as MRs.**

---

### Release Notes

<details>
<summary>cli/cli (cli/cli)</summary>

### [`v2.68.0`](https://github.com/cli/cli/releases/tag/v2.68.0): GitHub CLI 2.68.0

[Compare Source](cli/cli@v2.67.0...v2.68.0)

#### What's Changed

##### ✨ Features

-   \[gh repo view] Improve error message for forked repo by [@&#8203;iamazeem](https://github.com/iamazeem) in cli/cli#10334
-   Add signer-digest, source-ref, and source-digest options for `gh attestation verify` by [@&#8203;malancas](https://github.com/malancas) in cli/cli#10308
-   \[gh pr checkout] Add --no-tags option to git fetch commands in checkout by [@&#8203;latzskim](https://github.com/latzskim) in cli/cli#10479
-   \[`gh issue/pr comment`] Add `--create-if-none` and prompts to create a comment if no comment already exists  by [@&#8203;latzskim](https://github.com/latzskim) in cli/cli#10427
-   \[gh cache delete --all] Add `--succeed-on-no-caches` flag to return exit code 0 by [@&#8203;iamazeem](https://github.com/iamazeem) in cli/cli#10327
-   \[gh release create] Fail when there are no new commits since the last release by [@&#8203;iamazeem](https://github.com/iamazeem) in cli/cli#10398
-   update default upstream when forking repo during MR creation by [@&#8203;daviddl9](https://github.com/daviddl9) in cli/cli#10458

##### 🐛 Fixes

-   Refactor `GetLocalAttestations` and clean up custom registry transport by [@&#8203;malancas](https://github.com/malancas) in cli/cli#10382
-   Check `GH_REPO` too in addition to `--repo` for disambiguation by [@&#8203;williammartin](https://github.com/williammartin) in cli/cli#10539
    -   (Fixes `gh secret` subcommands not working outside of a repository)
-   Fix unhandled panic in FindWorkflow and add tests by [@&#8203;jtmcg](https://github.com/jtmcg) in cli/cli#10521
-   Fix checkout when URL arg is from fork and cwd is upstream by [@&#8203;williammartin](https://github.com/williammartin) in cli/cli#10512
-   \[gh api] Escape package name (URL encoding) for packages endpoint by [@&#8203;iamazeem](https://github.com/iamazeem) in cli/cli#10384
-   Fix `remoteResolver` caching issue by [@&#8203;iamazeem](https://github.com/iamazeem) in cli/cli#10456
-   Fix gh project item-edit to allow --number 0 as a valid value by [@&#8203;aryanbhosale](https://github.com/aryanbhosale) in cli/cli#10417
-   Add mutex to fix race in attestation test client by [@&#8203;codysoyland](https://github.com/codysoyland) in cli/cli#10439
-   Base64 decode GPG passphrase in deployment workflow by [@&#8203;BagToad](https://github.com/BagToad) in cli/cli#10546

##### 📚 Docs & Chores

-   Deep Dive Document Release Process by [@&#8203;williammartin](https://github.com/williammartin) in cli/cli#10503
-   Inconsistent format of examples in help text by [@&#8203;iamazeem](https://github.com/iamazeem) in cli/cli#10508
-   Inconsistent format of description of flags (starting with lowercase letter) by [@&#8203;iamazeem](https://github.com/iamazeem) in cli/cli#10507
-   Update Go version to 1.23 in CONTRIBUTING.md by [@&#8203;williammartin](https://github.com/williammartin) in cli/cli#10504
-   Fix minor auth login help typo by [@&#8203;williammartin](https://github.com/williammartin) in cli/cli#10501
-   docs: document how to revoke `gh` OAuth tokens in `auth logout`'s help by [@&#8203;BagToad](https://github.com/BagToad) in cli/cli#10490
-   chore: update codespaces Go version by [@&#8203;BagToad](https://github.com/BagToad) in cli/cli#10491
-   Allow injection of TUFMetadataDir in tests by [@&#8203;williammartin](https://github.com/williammartin) in cli/cli#10478
-   refactor: use a more straightforward return value by [@&#8203;beforetech](https://github.com/beforetech) in cli/cli#10489
-   Use subtests in attestation verification integration tests by [@&#8203;williammartin](https://github.com/williammartin) in cli/cli#10463
-   Fix typo in README by [@&#8203;iamazeem](https://github.com/iamazeem) in cli/cli#10445
-   Update usage to lower-kebab-case by [@&#8203;iamazeem](https://github.com/iamazeem) in cli/cli#10447
-   Standardize URLs by [@&#8203;iamazeem](https://github.com/iamazeem) in cli/cli#10429
-   Remove trailing whitespace by [@&#8203;iamazeem](https://github.com/iamazeem) in cli/cli#10430

##### :dependabot: Dependencies

-   Bump actions/attest-build-provenance from 2.2.0 to 2.2.2 by [@&#8203;dependabot](https://github.com/dependabot) in cli/cli#10518
-   Bump github.com/go-jose/go-jose/v4 from 4.0.2 to 4.0.5 by [@&#8203;dependabot](https://github.com/dependabot) in cli/cli#10499
-   Bump github.com/spf13/pflag from 1.0.5 to 1.0.6 by [@&#8203;dependabot](https://github.com/dependabot) in cli/cli#10338

</details>

---

### Configuration

📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied.

♻ **Rebasing**: Whenever MR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 **Ignore**: Close this MR and you won't be reminded about this update again.

---

 - [ ] <!-- rebase-check -->If you want to rebase/retry this MR, check this box

---

This MR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).
<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzOS4xODYuMCIsInVwZGF0ZWRJblZlciI6IjM5LjE4Ni4wIiwidGFyZ2V0QnJhbmNoIjoibWFpbiIsImxhYmVscyI6WyJSZW5vdmF0ZSBCb3QiXX0=-->
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Document our our release process

4 participants

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