Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
zimeg merged 2 commits into from
Sep 17, 2025
Merged

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

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5563ab3
build: run the docgen command with make tag release
zimeg Sep 17, 2025
c4d569f
fix: avoid automatic updates when generating documentation
zimeg Sep 17, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,12 +78,13 @@ build-snapshot: clean
.PHONY: tag
tag:
git diff --quiet --cached
git diff --quiet docs/guides/installing-the-slack-cli-*.md
git diff --quiet
@if echo "$(RELEASE_VERSION)" | grep -q '^v'; then \
echo "Error: Release version should not begin with a version prefix."; \
exit 1; \
fi
@printf "$(FONT_BOLD)Updating Docs$(FONT_RESET)\n"
./bin/slack docgen ./docs/reference --skip-update
sed -i.bak -E "s#slack_cli_[0-9]+\.[0-9]+\.[0-9]+_macOS_arm64\.tar\.gz#slack_cli_$(RELEASE_VERSION)_macOS_arm64.tar.gz#" docs/guides/installing-the-slack-cli-for-mac-and-linux.md
sed -i.bak -E "s#slack_cli_[0-9]+\.[0-9]+\.[0-9]+_macOS_amd64\.tar\.gz#slack_cli_$(RELEASE_VERSION)_macOS_amd64.tar.gz#" docs/guides/installing-the-slack-cli-for-mac-and-linux.md
sed -i.bak -E "s#slack_cli_[0-9]+\.[0-9]+\.[0-9]+_linux_64-bit\.tar\.gz#slack_cli_$(RELEASE_VERSION)_linux_64-bit.tar.gz#" docs/guides/installing-the-slack-cli-for-mac-and-linux.md
Expand All @@ -94,6 +95,7 @@ tag:
rm docs/guides/installing-the-slack-cli-for-mac-and-linux.md.bak
rm docs/guides/installing-the-slack-cli-for-windows.md.bak
@printf "$(FONT_BOLD)Git Add$(FONT_RESET)\n"
git add docs/reference
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"
Expand Down
Loading