Skip to content

build: run the docgen command with make tag release - #229

Merged
zimeg merged 2 commits into
mainfrom
zimeg-build-release-docgen
Sep 17, 2025
Merged

build: run the docgen command with make tag release#229
zimeg merged 2 commits into
mainfrom
zimeg-build-release-docgen

Conversation

@zimeg

Copy link
Copy Markdown
Member

Summary

This PR follows up on #228 and adds the docgen command to the "make tag" release script. Might substitute #197?

Preview

tag.mov

Reviewers

Please feel free to comment out the "diff" and "commit" and "tag" steps for fast testing:

diff --git a/Makefile b/Makefile
index e6d9c24..dca25b0 100644
--- a/Makefile+++ b/Makefile@@ -77,8 +77,8 @@ build-snapshot: clean
# Usage: `make tag RELEASE_VERSION=3.7.0-example`
.PHONY: tag
tag:
-	git diff --quiet --cached-	git diff --quiet+	# git diff --quiet --cached+	# git diff --quiet
@if echo "$(RELEASE_VERSION)" | grep -q '^v'; then \
echo "Error: Release version should not begin with a version prefix."; \
exit 1; \
@@ -99,6 +99,6 @@ tag:
git add docs/guides/installing-the-slack-cli-for-mac-and-linux.md
git add docs/guides/installing-the-slack-cli-for-windows.md
@printf "$(FONT_BOLD)Git Commit$(FONT_RESET)\n"
-	git commit -m "chore: release slack-cli v$(RELEASE_VERSION)"+	# git commit -m "chore: release slack-cli v$(RELEASE_VERSION)"
@printf "$(FONT_BOLD)Git Tag$(FONT_RESET)\n"
-	git tag v$(RELEASE_VERSION)+	# git tag v$(RELEASE_VERSION)

Then confirm reference is regenerated and versions are updated as expected!

$ rm docs/reference/errors.md
$ rm docs/reference/commands/slack_app_list.md
$ git status
...
modified: Makefile
deleted: docs/reference/commands/slack_app_list.md
deleted: docs/reference/errors.md
... $ make tag RELEASE_VERSION=3.7.1
...
git tag v3.7.1
$ git status
On branch zimeg-build-release-docgen
Your branch is up to date with 'origin/zimeg-build-release-docgen'.
Changes to be committed:
(use "git restore --staged <file>..." to unstage)
modified: docs/guides/installing-the-slack-cli-for-mac-and-linux.md
modified: docs/guides/installing-the-slack-cli-for-windows.md
Changes not staged for commit:
(use "git add <file>..." to update what will be committed)
(use "git restore <file>..." to discard changes in working directory)
modified: Makefile

Notes

I'm still interested in the PR approach @lukegalbraithrussell shares in #197 in quest to automate more releases, but for now I think this'll match our current processes 👾

Requirements

@zimegzimeg added this to the Next Release milestone Sep 17, 2025
@zimegzimeg self-assigned this Sep 17, 2025
@zimeg
zimeg requested a review from a team as a code ownerSeptember 17, 2025 01:56
@zimegzimeg added docs M-T: Documentation work only semver:patch Use on pull requests to describe the release version increment build M-T: Changes to compilation and CI processes labels Sep 17, 2025
@codecov

codecovBot commented Sep 17, 2025

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 62.95%. Comparing base (ba5cb15) to head (c4d569f).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files
@@ Coverage Diff @@## main #229 +/- ##
==========================================
- Coverage 62.96% 62.95% -0.02% 
==========================================
Files 212 212 Lines 21782 21782 ==========================================
- Hits 13715 13712 -3 
Misses 7005 7005 - Partials 1062 1065 +3 

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@zimegzimeg mentioned this pull request Sep 17, 2025
2 tasks
@zimegzimeg added code health M-T: Test improvements and anything that improves code health and removed docs M-T: Documentation work only build M-T: Changes to compilation and CI processes labels Sep 17, 2025

@mwbrooksmwbrooks left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

✅ Love this iteration and honestly it feel safer than having a workflow that will make a commit.

📝 I left a minor suggestion to skip the upgrade prompt, which I came across while testing.

Comment threadMakefile Outdated
Co-authored-by: Michael Brooks <mbrooks@slack-corp.com>
@mwbrooks

Copy link
Copy Markdown
Member

Very nice! 🚀 time!

@zimeg

Copy link
Copy Markdown
MemberAuthor

@mwbrooks Thanks tons! Tests are passing now so we can merge this in hopes for a good release process next! 🚀

@zimeg
zimeg merged commit ca03cbd into mainSep 17, 2025
6 checks passed
@zimeg
zimeg deleted the zimeg-build-release-docgen branch September 17, 2025 05:14
@zimeg

Copy link
Copy Markdown
MemberAuthor

@mwbrooks 🗣️ ramble: Oops I hit send so soon - meant to agree that a commit on machine can be faster in current setups!

Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

code healthM-T: Test improvements and anything that improves code healthsemver:patchUse on pull requests to describe the release version increment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

@zimeg@mwbrooks