docs: configure GitHub for squash merge and auto-run workflows on Draft PRs#226
Merged
docs: configure GitHub for squash merge and auto-run workflows on Draft PRs#226
Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR updates the repository's merge strategy from rebase-only to squash-merge-only, aligning with GitHub best practices for maintaining linear history while simplifying the merge process. The changes document the new workflow and update CI configuration to support draft PRs.
Key changes:
- Switched from
--rebaseto--squashmerge strategy in CLAUDE.md workflow documentation - Added explicit PR event types to CI workflow to trigger on draft PRs
- Created comprehensive GITHUB_SETTINGS.md documenting all repository configurations
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| CLAUDE.md | Updated workflow steps and merge strategy documentation from rebase to squash merge, added manual rebase step before merge |
| .github/workflows/ci.yml | Added explicit PR event types to enable CI runs on draft PRs |
| .github/GITHUB_SETTINGS.md | New comprehensive documentation of all GitHub repository settings, merge strategies, and configuration details |
Comments suppressed due to low confidence (1)
CLAUDE.md:296
- Documentation still refers to 'rebase-only' strategy, but the PR changes the merge strategy to squash-only. This should be updated to reflect the new strategy: 'Linear history REQUIRED (squash-merge-only, no merge commits)'.
- ✅ Linear history REQUIRED (rebase-only, no merge commits)
|
|
||
| 2. **Updated via GitHub API:** Repository merge settings | ||
| - Enabled squash merge (was disabled) | ||
| - Kept rebase merge enabled |
There was a problem hiding this comment.
Documentation states 'Kept rebase merge enabled' but line 35 shows allow_rebase_merge: false and line 44 states 'Regular rebase disabled'. This is contradictory. The documentation should state 'Disabled rebase merge' to match the actual configuration.
Suggested change
| - Kept rebase merge enabled | |
| - Disabled rebase merge |
…ft PRs Changes: - Enable squash merge only (disable rebase merge) via GitHub API - Configure workflows to run automatically on Draft PRs - Add comprehensive documentation in .github/GITHUB_SETTINGS.md - Update CLAUDE.md with accurate squash merge workflow - Clarify that squash merge creates new commit (not git rebase) Result: - All PR merges → single squash commit on main - Linear history maintained (no merge commits) - CI runs automatically on Draft PRs without approval - Manual rebase required if main changes (strict mode)
- Fix TypeScript error TS2345 in lines 69 and 118 - Add instanceof Error check before passing to LoggingService.error() - Ensures type safety when logging caught errors
78d43ea to
cfad667
Compare
- Remove unused 'parsed' variable in AssetConversionService - Add _ prefix to unused vaultAdapter in Convert commands - Fixes TS6133 and TS6138 errors from PR #223
- Remove vaultAdapter from constructor signatures - Update CommandRegistry to not pass vaultAdapter - Update unit tests to match new constructor signatures - Fixes TS6138 errors for unused parameters
- Remove ObsidianVaultAdapter imports from Convert commands - Fixes TS6133 errors for unused imports
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Configures GitHub repository settings for:
Changes Made
GitHub API Configuration
allow_squash_merge: true)allow_rebase_merge: false)Workflow Changes
File:
.github/workflows/ci.yml[opened, synchronize, reopened, ready_for_review]Documentation
New file:
.github/GITHUB_SETTINGS.mdUpdated:
CLAUDE.mdstrict: truerequires manual branch updatesHow Squash Merge Works
What actually happens:
Key points:
git rebase origin/mainneeded if main changed (strict mode)Verification
Test Plan
References