From 4ced6248535c13cccabf42eacf36ed402c203feb Mon Sep 17 00:00:00 2001 From: Timothée Ravier Date: Aug 16 2023 13:41:30 +0000 Subject: *: Improve formatting --- diff --git a/modules/release_guide/pages/final_release.adoc b/modules/release_guide/pages/final_release.adoc index 2257a4f..8bbff20 100644 --- a/modules/release_guide/pages/final_release.adoc +++ b/modules/release_guide/pages/final_release.adoc @@ -2,9 +2,9 @@ include::_partials/attributes.adoc[] = Fedora Final Release -== Update FedoraPreviousPrevious.yaml in ansible repository +== Update `FedoraPreviousPrevious.yaml` in ansible repository -set the https://pagure.io/fedora-infra/ansible/blob/main/f/vars/all[variable] to True in ansible repository. +Set the https://pagure.io/fedora-infra/ansible/blob/main/f/vars/all[variable] to True in ansible repository. == Koji changes diff --git a/modules/release_guide/pages/mass_rebuild.adoc b/modules/release_guide/pages/mass_rebuild.adoc index 922bddd..9830af6 100644 --- a/modules/release_guide/pages/mass_rebuild.adoc +++ b/modules/release_guide/pages/mass_rebuild.adoc @@ -1,6 +1,6 @@ include::_partials/attributes.adoc[] -= Mass rebuild information. += Mass rebuild information == Description diff --git a/modules/release_guide/pages/release_eol.adoc b/modules/release_guide/pages/release_eol.adoc index cce2070..f6bbc8a 100644 --- a/modules/release_guide/pages/release_eol.adoc +++ b/modules/release_guide/pages/release_eol.adoc @@ -8,15 +8,15 @@ Each release of Fedora is maintained as laid out in the https://fedoraproject.org/wiki/Fedora_Release_Life_Cycle#Maintenance_Schedule[maintenance schedule]. At the conclusion of the maintenance period, a Fedora release enters `end of life` status. This procedure describes the tasks -necessary to move a release to that status. To get the correct EOL date visit +necessary to move a release to that status. To get the correct EOL date visit https://fedorapeople.org/groups/schedule/f-{branched}/f-{branched}-key-tasks.html[release schedule] for the last release. == Actions === Reminder announcement -Send an email to devel@, devel-announce@, test-announce@, announce@ -lists as remainder about the release EOL. Use https://pagure.io/releng/blob/main/f/mail-templates/07-end-of-life.txt[template] from release engineering repo +Send an email to `devel@`, `devel-announce@`, `test-announce@`, `announce@` lists as remainder about the release EOL. +Use https://pagure.io/releng/blob/main/f/mail-templates/07-end-of-life.txt[template] from release engineering repo [NOTE] ==== @@ -114,14 +114,13 @@ $ sudo mbs-manager retire platform:f{old_release} === Final announcement -* Send the final announcement to devel@, devel-announce@, -test-announce@, announce@ lists +* Send the final announcement to `devel@`, `devel-announce@`, `test-announce@`, `announce@` lists. Use https://pagure.io/releng/blob/main/f/mail-templates/07-end-of-life.txt[template] from release engineering repo ==== Update FedoraPreviousPrevious.yaml in ansible repository -* set the variable to False +* Set the variable to False ==== Move the EOL release to archive @@ -148,8 +147,8 @@ ____ $ ls /pub/archive/fedora/linux/releases/ .... ____ -. Do a recursive rsync to update any changes in the trees since the -previous copy. +. Do a recursive rsync to update any changes in the trees since the previous +copy. + ____ [source,subs="attributes+"] @@ -181,9 +180,9 @@ $ cd testing $ rsync -avAXSHP {old_release}/ /pub/archive/fedora-secondary/updates/testing/{old_release}/ .... ____ -. Announce to the mirror list this has been done and that in 2 weeks you -will move the old trees to archives. -. in two weeks, log into mm-backend01 and run the archive script +. Announce to the mirror list this has been done and that in 2 weeks you will +move the old trees to archives. +. In two weeks, log into mm-backend01 and run the archive script + ____ [source,subs="attributes+"] @@ -193,7 +192,7 @@ $ sudo -u mirrormanager mm2_move-to-archive --originalCategory="Fedora Linux" -- ____ . If there are problems, the postgres DB may have issues and so you need to get a DBA to update the backend to fix items. -. wait an hour or so then you can remove the files from the main tree. +. Wait an hour or so then you can remove the files from the main tree. [NOTE] ==== diff --git a/modules/release_guide/pages/sop_bodhi_activation.adoc b/modules/release_guide/pages/sop_bodhi_activation.adoc index fe73eb1..ca421d2 100644 --- a/modules/release_guide/pages/sop_bodhi_activation.adoc +++ b/modules/release_guide/pages/sop_bodhi_activation.adoc @@ -72,13 +72,13 @@ As in https://pagure.io/fedora-infra/ansible/pull-request/1327[this Ansible Pull === Run the playbooks -.... +``` $ rbac-playbook openshift-apps/greenwave.yml $ rbac-playbook openshift-apps/bodhi.yml $ rbac-playbook groups/bodhi-backend.yml $ rbac-playbook groups/releng-compose.yml $ rbac-playbook manual/autosign.yml -.... +``` Greenwave runs in OpenShift (as implied by the playbook paths), and so the change will not be live right away when the playbook finishes. You @@ -93,11 +93,11 @@ bodhi-backend01 (Look at warning in https://docs.pagure.org/releng/sop_bodhi_activation.html#action and the bug is https://github.com/fedora-infra/bodhi/issues/2177) -.... +``` $ sudo systemctl restart bodhi-celery $ sudo systemctl restart fm-consumer@config $ sudo systemctl restart koji-sync-listener -.... +``` === Send Announcement diff --git a/modules/release_guide/pages/sop_file_ftbfs.adoc b/modules/release_guide/pages/sop_file_ftbfs.adoc index 08a9bb8..ddd86ee 100644 --- a/modules/release_guide/pages/sop_file_ftbfs.adoc +++ b/modules/release_guide/pages/sop_file_ftbfs.adoc @@ -1,14 +1,11 @@ = File FTBFS -== Description +NOTE: FTBFS means "Fails To Build From Source". -[NOTE] -==== -FTBFS = "Fails To Build From Source" -==== +== Description -After every mass rebuild, we file FTBFS bugs for the packages that -failed to build during mass rebuild. +After every mass rebuild, we file FTBFS bugs for the packages that failed to +build during mass rebuild. This should be run after the https://docs.pagure.org/releng/sop_mass_rebuild_packages.html#post-mass-rebuild-tasks[mass @@ -18,56 +15,45 @@ rebuild builds are merged into main tag]. The FTBFS bugs are filed in bugzilla. -. {blank} -+ -Create a bugzilla bug for FTBFS:: +. Create a bugzilla bug for `FTBFS`: * use the https://bugzilla.redhat.com/show_bug.cgi?id=1750908[previous FTBFS bugzilla bug example] if its not created -. {blank} -+ -Set alias for RAWHIDEFTBFS:: - * remove RAWHIDEFTBFS alias from the previous FTBFS bugzilla - * set RAWHIDEFTBFS alias on the new rawhide version FTBFS bugzilla - * set the alias on RAWHIDEFailsToInstall bugzilla in same fashion -. {blank} + +. Set alias for `RAWHIDEFTBFS`: + * remove `RAWHIDEFTBFS` alias from the previous `FTBFS` bugzilla + * set `RAWHIDEFTBFS` alias on the new rawhide version `FTBFS` bugzilla + * set the alias on `RAWHIDEFailsToInstall` bugzilla in same fashion + +. Install `python-bugzilla-cli` on your local machine if its not installed: + -Install [.title-ref]#python-bugzilla-cli# on your local machine if its -not installed:: -.... +``` $ sudo dnf install python-bugzilla-cli -.... -. {blank} -+ -Update the [.title-ref]#massrebuildsinfo.py#:: +``` + +. Update the `massrebuildsinfo.py`: * epoch * buildtag * destag * tracking_bug - + - [NOTE] - ==== - Most of these values are already updated during mass rebuild, only one - that might need updating is [.title-ref]#tracking_bug# - ==== -. {blank} + + -Update the [.title-ref]#mass_rebuild_file_bugs.py#:: +NOTE: Most of these values are already updated during mass rebuild, only one + that might need updating is `tracking_bug`. + +. Update the `mass_rebuild_file_bugs.py`: * rebuildid -. {blank} + +. Login into bugzilla in the terminal using `bugzilla login` command: + -Login into bugzilla in the terminal using [.title-ref]#bugzilla login# -command:: -.... +``` $ bugzilla login -.... - + - [NOTE] - ==== - Login as [.title-ref]#releng@fedoraproject.org# - ==== -. {blank} +``` + ++ +NOTE: Login as `releng@fedoraproject.org` + +. Run `mass_rebuild_file_bugs.py` locally: + -Run [.title-ref]#mass_rebuild_file_bugs.py# locally:: -.... +``` $ python mass_rebuild_file_bugs.py -.... +``` diff --git a/modules/release_guide/pages/sop_mass_branching.adoc b/modules/release_guide/pages/sop_mass_branching.adoc index f8c5425..ff2a08a 100644 --- a/modules/release_guide/pages/sop_mass_branching.adoc +++ b/modules/release_guide/pages/sop_mass_branching.adoc @@ -110,24 +110,22 @@ Apps in https://pagure.io/fedora-infra/ansible[ansible] need to be updated to be === Bodhi Bodhi needs to be updated to add new release. This needs to be done in -https://pagure.io/fedora-infra/ansible/blob/main/f/roles/bodhi2[bodhi2 -role] in infra ansible repo. This change includes, updating -koji-sync-listener.py, new-updates-sync, pungi configs for rpm updates, bodhi templates. +https://pagure.io/fedora-infra/ansible/blob/main/f/roles/bodhi2[bodhi2 role] in +infra ansible repo. This change includes, updating `koji-sync-listener.py`, +`new-updates-sync`, pungi configs for rpm updates, bodhi templates. -.... -- roles/bodhi2/backend/files/new-updates-sync -- roles/bodhi2/backend/tasks/main.yml -- roles/bodhi2/backend/templates/pungi.rpm.conf.j2 -- roles/bodhi2/backend/templates/koji_sync_listener.toml -.... +* `roles/bodhi2/backend/files/new-updates-sync` +* `roles/bodhi2/backend/tasks/main.yml` +* `roles/bodhi2/backend/templates/pungi.rpm.conf.j2` +* `roles/bodhi2/backend/templates/koji_sync_listener.toml` Please check these files from the https://pagure.io/fedora-infra/ansible/c/549e5d3ace41c04fdbef9d81f359f16c2fe0c2fa?branch=main[commit] for your reference. === Enable Branched Compose We need to enable the branched compose. This is done in -https://pagure.io/fedora-infra/ansible/blob/main/f/roles/releng[releng -role] of infra ansbile repo. +https://pagure.io/fedora-infra/ansible/blob/main/f/roles/releng[releng role] of +infra ansbile repo. Please check the file `roles/releng/files/branched` from the https://pagure.io/fedora-infra/ansible/c/549e5d3ace41c04fdbef9d81f359f16c2fe0c2fa?branch=main[commit] for your reference. @@ -150,18 +148,15 @@ Robosignatory has two parts, which can be found in https://pagure.io/fedora-infra/ansible/blob/main/f/roles/robosignatory[robosignatory role] in infra ansible repo.: -[arabic] -. Disable branched signing, so that we can freeze branched until we get -a compose. +. Disable branched signing, so that we can freeze branched until we get a compose. . Adding new release. - Please check the file `roles/robosignatory/templates/robosignatory.toml.j2` from the https://pagure.io/fedora-infra/ansible/c/a7dcdbd794e728f7b80b1afc6c142c0196b8c1a3?branch=main[commit] for your reference. === Push the changes -When done editing the files, commit, push and apply them via the -corresponding ansible playbook: +When done editing the files, commit, push and apply them via the corresponding +ansible playbook: ``` $ sudo rbac-playbook groups/koji-hub.yml @@ -426,23 +421,21 @@ be owned by _ftpsync:ftpsync_ === Creating rawhide release -To create a rawhide release in bodhi, you need to run - +To create a rawhide release in bodhi, you need to run: [attributes] `` $ bodhi releases create --name "F{rawhide}" --long-name "Fedora {rawhide}" --id-prefix FEDORA --version {rawhide} --branch f{rawhide} --dist-tag f{rawhide} --stable-tag f{rawhide} --testing-tag f{rawhide}-updates-testing --candidate-tag f{rawhide}-updates-candidate --pending-stable-tag f{rawhide}-updates-pending --pending-testing-tag f{rawhide}-updates-testing-pending --pending-signing-tag f{rawhide}-signing-pending --state pending --override-tag f{rawhide}-override --create-automatic-updates --not-composed-by-bodhi `` - -To create a container release for rawhide in bodhi, you need to run +To create a container release for rawhide in bodhi, you need to run: [attributes] `` $ bodhi releases create --name "F{rawhide}C" --long-name "Fedora {rawhide} Containers" --id-prefix FEDORA-CONTAINER --version {rawhide} --branch f{rawhide} --dist-tag f{rawhide}-container --stable-tag f{rawhide}-container-updates --testing-tag f{rawhide}-container-updates-testing --candidate-tag f{rawhide}-container-updates-candidate --pending-stable-tag f{rawhide}-container-updates-pending --pending-testing-tag f{rawhide}-container-updates-testing-pending --state pending --override-tag f{rawhide}-container-override `` -To create a flatpak release for branched in bodhi, you need to run +To create a flatpak release for branched in bodhi, you need to run: [attributes] `` @@ -452,12 +445,12 @@ $ bodhi releases create --name "F{branched}F" --long-name "Fedora {branched} Fla You need to run the `bodhi openshift` playbook, so that UI will know about the new release. Then, you need to restart *fm-consumer@config.service* and *bodhi-celery.service* services on -*bodhi-backend01.phx2.fedoraproject.org* +*bodhi-backend01.phx2.fedoraproject.org*: -`` +``` $ sudo rbac-playbook openshift-apps/bodhi.yml $ sudo systemctl restart fm-consumer@config.service bodhi-celery.service -`` +``` [NOTE] ==== @@ -576,9 +569,6 @@ And set current_rawhide variable. Use https://pagure.io/fedora-infra/ansible/pull-request/1527[this PR] for reference and add new version to the config. -= Consider Before Running +== Consider Before Running -[NOTE] -==== -FIXME: Need some love here -==== +NOTE: FIXME: Need some love here