Skip to content

Update Revision History with GitHub Issues/PR links#31

Merged
mdkinney merged 1 commit intotianocore-docs:mainfrom
mdkinney:Update_Revision_History_Github_Issues_And_Proposed_2_5
Apr 3, 2026
Merged

Update Revision History with GitHub Issues/PR links#31
mdkinney merged 1 commit intotianocore-docs:mainfrom
mdkinney:Update_Revision_History_Github_Issues_And_Proposed_2_5

Conversation

@mdkinney
Copy link
Copy Markdown
Contributor

@mdkinney mdkinney commented Mar 26, 2026

Description

Bugzilla server is no longer available. Update revision history with GitHub Issue link when available. Preserve the Bugzilla ID# if available. Add link to PR# if available. If PR# link is not available, then provide link to commit.

Contributed-under: TianoCore Contribution Agreement 1.1

makubacki
makubacki previously approved these changes Mar 26, 2026
@mdkinney mdkinney force-pushed the Update_Revision_History_Github_Issues_And_Proposed_2_5 branch from 79ceebf to 2538df9 Compare March 26, 2026 18:03
@mdkinney mdkinney changed the title Update Revision History for GitHub Issues Update Revision History with GitHub Issues/PR links Mar 26, 2026
@mdkinney
Copy link
Copy Markdown
Contributor Author

Made update to combine history under proposed 2.4 release

@mdkinney mdkinney requested a review from makubacki March 26, 2026 19:05
makubacki
makubacki previously approved these changes Mar 26, 2026
@mdkinney mdkinney force-pushed the Update_Revision_History_Github_Issues_And_Proposed_2_5 branch from 2538df9 to c7a5bca Compare March 27, 2026 00:56
@mdkinney mdkinney requested a review from makubacki March 27, 2026 00:57
@mdkinney
Copy link
Copy Markdown
Contributor Author

Did one more push to clarify when the start of new content for next spec starts in the Revision History. All lines that follow that start line for spec revision are included in that revision.

Can be a bit confusing because the dates are the dates the changes were merged into the repo. The revision history does not show the date that the spec was published. That information is only available from the title page.

@mdkinney
Copy link
Copy Markdown
Contributor Author

@leiflindholm @ardbiesheuvel @makubacki I send an email to devel mailing list proposing an April 3 release date for 2.4.

Let me know if there is a better process to get community approval for an official release from documents maintained in tianocore-docs that are not necessarily monitored well.

Bugzilla server is no longer available. Update revision
history with GitHub Issue link when available.
Preserve the Bugzilla ID# if available. Add link to
PR# if available. If PR# link is not available, then
provide link to commit.

Contributed-under: TianoCore Contribution Agreement 1.1
Signed-off-by: Michael D Kinney <michael.d.kinney@intel.com>
@mdkinney mdkinney force-pushed the Update_Revision_History_Github_Issues_And_Proposed_2_5 branch from c7a5bca to 3179fc5 Compare March 27, 2026 17:30
@mdkinney
Copy link
Copy Markdown
Contributor Author

mdkinney commented Mar 27, 2026

Added line to revision history for this PR. Should be standard practice for each PR in docs to do content change and extend revision history. Otherwise, we have to do cleanup PR like this one.

A bit odd, because you do not know the PR number until PR is opened, so at least one revision to PR has to be done to follow this process.

@makubacki
Copy link
Copy Markdown
Contributor

Let me know if there is a better process to get community approval for an official release from documents maintained in tianocore-docs that are not necessarily monitored well.

Sending a notification to the mailing list seems good in any case. Though, I think that we should start trying to use GitHub milestones to show intention for an upcoming release and associate changes (issues and pull requests) that target that release. It also makes release notes much easier to generate with automatic references. I'll write up some details in a small RFC on it.

@mdkinney mdkinney merged commit 4010e88 into tianocore-docs:main Apr 3, 2026
1 check passed
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