Page MenuHomeFreeBSD

Update release engineering article to follow git workflow
ClosedPublic

Authored by minsoochoo0122_proton.me on Jul 19 2023, 3:11 PM.
Tags
Referenced Files
Unknown Object (File)
Thu, Nov 28, 1:45 PM
Unknown Object (File)
Mon, Nov 25, 3:29 AM
Unknown Object (File)
Fri, Nov 22, 10:12 AM
Unknown Object (File)
Thu, Nov 21, 11:27 PM
Unknown Object (File)
Thu, Nov 14, 1:21 PM
Unknown Object (File)
Nov 8 2024, 1:20 AM
Unknown Object (File)
Nov 7 2024, 6:05 AM
Unknown Object (File)
Nov 5 2024, 9:07 AM

Details

Summary

Bugzilla bug report 1 Bugzilla bug report 2

The release engineering article is out of date and does not mention the new git workflow. This revision is created to reflect latest changes in the release engineering process using git.

Test Plan

make run

Diff Detail

Repository
R9 FreeBSD doc repository
Lint
Lint Skipped
Unit
Tests Skipped

Event Timeline

documentation/content/en/articles/freebsd-releng/_index.adoc
266–267

What is the equivalent thing of base/svnadmin/conf/approvers in Git?

333

Where do these html files go in git?

345

Do we still use something equivalent of 'fbsd:nokeywords` in git?

569–570

Same question as above with svnadmin/conf/approvers

582

Same question as above with svnadmin/conf/approvers

625–626

I couldn't find git repository for thermite.sh. Where is it?

749

Same question as above with svnadmin/conf/approvers

documentation/content/en/articles/freebsd-releng/_index.adoc
628–629

How does this work in Git?

carlavilla added a subscriber: carlavilla.

Thanks for this!
Ok from the docs side, but we need the approval from re@ :)

I'll ping them to move this ASAP

This revision is now accepted and ready to land.Jul 22 2023, 7:28 AM

I made comments in diff because there are things that I don't know about, like svnadmin. Can you check them please?

I will review the rest of the changes on Monday and follow-up on this.

documentation/content/en/articles/freebsd-releng/_index.adoc
266–267

This is actually handled by Li-Wen Hsu manually at the moment. There is no automatic way to enforce approval yet, but it is something he has been working on.

I made comments in diff because there are things that I don't know about, like svnadmin. Can you check them please?

Sorry, Monday got away from me unfortunately. This is one of the top items on my TODO list Tuesday (or, as I should say, "later today").

documentation/content/en/articles/freebsd-releng/_index.adoc
333

These are now in the doc repository. For example. website/content/en/releases/14.0R/.

345

Do we still use something equivalent of 'fbsd:nokeywords` in git?

No, fbsd:nokeywords has no effect in Git.

569–570

Same answer as above. For now, we should probably state that git-admins@ handles this, as we do not currently have a way to commit this as part of the tree directly like we did with Subversion.

582

Same answer.

625–626

I am inclined to suggest removal of mentioning thermite.sh in this document. It is still available via svnweb.freebsd.org, but I do not know how long that will be accessible once stable/12 is no longer maintained.

Should there be a need to put mention of thermite.sh back, that can be resolved in the future.

628–629

It works the same, but let's get rid of mention of thermite.sh. It is merely a complex wrapper script around the in-tree release.sh.

Approver list is now handled by gitadm@FreeBSD.org
Removed thermite.sh part.

This revision now requires review to proceed.Jul 25 2023, 8:55 PM
minsoochoo0122_proton.me marked an inline comment as done.

The rest of this looks good. Thank you very much for taking the time to update it. Once the two nits I pointed out are addressed, I think this can be committed.

@carlavilla would you please do the honors when it is ready? I do not think my local setup is currently up-to-date regarding documentation builds, etc.

documentation/content/en/articles/freebsd-releng/_index.adoc
266–267

For clarity, how about:

..., the Release Engineering Team must approve any changes to the branch, in which case the commit log must include an "Approved by: re (login)" line, where "login" is the login ID of the approver.

333

These are now in the doc repository. For example. website/content/en/releases/14.0R/.

Sorry, I was not clear on my response. The files in the website are automatically generated from the hardware.adoc, relnotes.adoc, and so on. There are no files copied cross-repository anymore. (The targets in src/release/Makefile related to this have been removed since the transition to Hugo/AsciiDOC.)

I think this can be removed, as new files for releases are copeied from previous releases (vi cp, not git add), and truncated content-wise.

Made sentence more clear. Release related docs are automatically generated after it is added to doc repository.

This revision is now accepted and ready to land.Jul 26 2023, 6:50 PM

Thanks Glen for the review. I’ll make the commit :)