Implement PR-number-based proposal workflow#104
Conversation
1e9b272 to
6ff9dd1
Compare
a7725a5 to
22926ed
Compare
robobario
left a comment
There was a problem hiding this comment.
LGTM. Had a play around with it on my fork and it updated/cleaned the PR description as expected.
I wonder if we should require the number to be mentioned in the proposal too, like the title should be XYZ - My Description Title, or include a PR link so that users can nav to the PR easily if they are browsing the merged files.
One thing I found is that PRs aren't google-able, this seems to be pretty standard, github offers up headers/robots to make sure PRs aren't crawled/indexed since they are in flux. So unfortunately if you Google "Kroxylicious Hot Reload" nothing useful comes up. Maybe we could add automation to automatically create an Issue for the new PR since Issues are indexed.
| paths: | ||
| - 'proposals/*.md' |
There was a problem hiding this comment.
Are we able to make this a required check in the branch rules if its conditional? I think it will be a no-op if we run it all the time for PRs with no proposals/* changes.
4dd08cb to
d928f7c
Compare
Updates proposal workflow to require PR number in the H1 title (e.g., "# 105 - My Feature Title") for easier navigation when browsing merged proposals. Changes: - Updated template to show title format: # <PR-NUMBER> - <Title> - Updated README to mention updating title when renaming file - Enhanced workflow to validate both filename and title format - Improved warning messages to provide separate guidance for filename and title issues Addresses feedback from robobario in PR kroxylicious#104. Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
The paths filter prevented the workflow from running on non-proposal PRs. When the check is configured as mandatory in branch protection, GitHub blocks merges if the check hasn't run. Removing the filter allows the check to run on all PRs and pass cleanly when there are no proposal files, making it safe to require. Addresses feedback from robobario in PR kroxylicious#104. Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
This change simplifies the proposal numbering system by using PR numbers as proposal identifiers, eliminating number collisions and removing the need for a separate allocation process. Changes: - Simplified proposals/README.md to focus on author workflow - Removed index tables (directory listing serves as the index) - Streamlined instructions for creating and renaming proposals - Updated proposal template with workflow instructions - Require PR number in title format: # <PR#> - <Title> - Moved workflow instructions into comment block - Added GitHub workflow to automatically check proposal numbering - Validates both filename and title format - Updates PR description when proposal files don't match PR number - Provides exact commands to fix naming issues - Removes warning once corrected - Handles both added and renamed files - Runs on all PRs (ready for mandatory status check) - Added notification script for existing open PRs - After merge, run notify-open-prs.sh to ask authors to rebase - Workflow will automatically guide them through renaming - Updated with all current open proposal PRs (kroxylicious#70, kroxylicious#82, kroxylicious#83, kroxylicious#85, kroxylicious#88, kroxylicious#93, kroxylicious#94, kroxylicious#96, kroxylicious#98, kroxylicious#99, kroxylicious#100, kroxylicious#101, kroxylicious#103) Proposals 001-019 retain their original numbers. Assisted-By: Claude Sonnet 4.5 <noreply@anthropic.com> Signed-off-by: Keith Wall <kwall@apache.org>
842670c to
7c5f5f8
Compare
This PR implements Rob's suggestion from #95 to use PR numbers as proposal identifiers.
Changes
Proposal Numbering
Proposals now use PR numbers as identifiers (e.g., PR #105 → proposals/105-my-proposal.md).
Why PR numbers?
#105) work automaticallyMigration for Existing Proposals
After merge, run
./notify-open-prs.shto notify authors of open proposal PRs. When they rebase, the workflow will automatically guide them through any needed renaming.Proposals 001-019 retain their original numbers.
Separately, kroxylicious#3794 has been raised to ensure that a Claude session running the main repo finds the proposals.
Note: This PR replaces #95 with a cleaner implementation focused on automation rather than manual index maintenance.
🤖 Generated with Claude Code