Skip to content

Implement PR-number-based proposal workflow#104

Merged
k-wall merged 1 commit into
kroxylicious:mainfrom
k-wall:pr-number-based-proposals
Apr 28, 2026
Merged

Implement PR-number-based proposal workflow#104
k-wall merged 1 commit into
kroxylicious:mainfrom
k-wall:pr-number-based-proposals

Conversation

@k-wall
Copy link
Copy Markdown
Member

@k-wall k-wall commented Apr 24, 2026

This PR implements Rob's suggestion from #95 to use PR numbers as proposal identifiers.

Changes

  • Simplified proposals/README.md: Removed index tables (directory listing serves as the index), streamlined author workflow
  • Updated proposals/000-template.md: Added workflow instructions
  • Added GitHub workflow: Automatically checks proposal numbering
    • Updates PR description when files don't match PR number
    • Provides exact commands to fix naming
    • Removes warning once corrected
  • Added notify-open-prs.sh: One-time script to notify existing PR authors to rebase

Proposal Numbering

Proposals now use PR numbers as identifiers (e.g., PR #105 → proposals/105-my-proposal.md).

Why PR numbers?

  • Natural chronological ordering
  • No number collisions (GitHub guarantees unique PR numbers)
  • GitHub references (#105) work automatically
  • Simpler workflow (no separate allocation PR needed)

Migration for Existing Proposals

After merge, run ./notify-open-prs.sh to 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

@k-wall k-wall requested a review from a team as a code owner April 24, 2026 14:56
@k-wall k-wall force-pushed the pr-number-based-proposals branch from 1e9b272 to 6ff9dd1 Compare April 24, 2026 14:56
@k-wall k-wall force-pushed the pr-number-based-proposals branch 3 times, most recently from a7725a5 to 22926ed Compare April 24, 2026 15:02
Copy link
Copy Markdown
Member

@robobario robobario left a comment

Choose a reason for hiding this comment

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

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.

Comment thread proposals/README.md Outdated
Comment thread .github/workflows/proposal-numbering.yml Outdated
Comment on lines +16 to +17
paths:
- 'proposals/*.md'
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.

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.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Good idea.

Comment thread .github/workflows/proposal-numbering.yml Outdated
@k-wall k-wall force-pushed the pr-number-based-proposals branch from 4dd08cb to d928f7c Compare April 28, 2026 08:27
k-wall added a commit to k-wall/design that referenced this pull request Apr 28, 2026
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>
k-wall added a commit to k-wall/design that referenced this pull request Apr 28, 2026
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>
@k-wall k-wall force-pushed the pr-number-based-proposals branch from 842670c to 7c5f5f8 Compare April 28, 2026 09:08
@k-wall k-wall merged commit 85ae88b into kroxylicious:main Apr 28, 2026
1 check passed
@k-wall k-wall deleted the pr-number-based-proposals branch April 28, 2026 09:09
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.

2 participants