35 Commits

Author SHA1 Message Date
Jay Faulkner
f6191f2969 Fix lint issues with documentation
The doc8 linter found several syntax problems in our docs; primarily a
large number of places we used single-backticks to surround something
when we should've used double-backticks.

This is frontrunning a change that will add these checks to CI.

Change-Id: Ib23b5728c072f2008cb3b19e9fb7192ee5d82413
2024-10-29 14:59:28 -07:00
Riccardo Pittau
2a6abc8107 [docs] Add procedure to EoL and delete old bugfix branch
The process is currently manual and requires some precise steps.

Change-Id: I25c1c03426fa306681b48c4a5cfb53ff47c8c027
2024-08-22 10:13:05 +02:00
Riccardo Pittau
816a7dfe8b Remove ironic-inspector from bugfix branches
Change-Id: Ic54c5da159e05b20686ef4fbb54f6690abc32a22
2024-07-30 15:05:09 +02:00
Riccardo Pittau
c0643e9d05 Be explicit about bugfix branches support lifetime
Also fix new release model link

Change-Id: I1c9b3b1c8481a315199070468298a73936ae93a7
2023-05-31 15:57:38 +02:00
Jay Faulkner
5b56cbe8c3 Minor spelling/grammar fixes for release docs
Fix spelling, make Ironic capitalized throughout.

Change-Id: Ia689954279034d21c60dea4bca73ee5b1bb41d81
2023-01-26 11:32:35 -08:00
Jay Faulkner
38777e5030 Clarify release docs: bugfix releases optional
Bugfix releases are optional in practice; document that truth in
our release documents.

Change-Id: Ie24e959fdb338fafeafdf0e064eede273f2011f4
2023-01-24 16:13:34 +00:00
Riccardo Pittau
59d4cc666b Update bugfix section
Remove bifrost mention
Add a note to remind to update the u-c links in tox.ini

Change-Id: I4ae4bfca87c19183d26b9928a3496c63b9f4aab3
2022-05-30 11:06:07 +02:00
Iury Gregory Melo Ferreira
c52e685e5f Update release doc
- move ipa-builder to projects that follow normal release
- add a new section Manual release for ironic-staging-driver
- update Things to do after releasing.

Change-Id: Ie6d02096dc15fc8c3f881556f1638d94ba2d8ece
2021-09-24 16:09:13 +02:00
Julia Kreger
ea8c10cc8b Allow initial versions to not be created yet
The database schema upgrade check had support for an
explicit list of known versions to handle the upgrade.

who knew!

Anyhow, we haven't used it in three years since the addition,
and it seems to make more sense to just be able to indicate
"we know initial field versions may not be able to be retrieved
and act accordingly". As such, when no table is found, the
pre-upgrade version check execution will continue onward fearlessly!

Call it a spiritual successor to Ibcf0728bc5d1b0cbdd78796526f9c93fc99e8c08

Change-Id: Icae5162c2501b0d1217ad0e6ee34ebef40e95204
2021-08-11 23:09:36 +00:00
Dmitry Tantsur
1e041bea3b Document making bugfix releases and branches
Change-Id: Id87da43caa33ee5f5e547497599b1f358a22b4ae
2021-07-22 18:16:35 +02:00
kkillsfirst
fe419bac1c Changes made to release documentation:
* Removed sushy-cli from Client libraries
* Removed molteniron from Independent

Change-Id: I2c2f87e372348760654563d34906829082f93d9f
2021-06-02 16:32:34 -06:00
Zuul
1c7b5f8259 Merge "docs: Add information on post-branch release tasks for bifrost" 2021-01-08 15:25:17 +00:00
Riccardo Pittau
4e9c6184c4 Fix release guide and include intermediate branches
Fix the command to submit new releases and adds command reference
for the intermediate bugfix branches.

Change-Id: I79a039a6effcf8bd13e5c3ab5a231d5b515c8297
2020-12-15 10:37:06 +01:00
Mark Goddard
a0728ad657 docs: Add information on post-branch release tasks for bifrost
Change-Id: Ieabbc024d4afc82670d7cee8e39b839b2b7a21df
2020-10-09 15:35:08 +00:00
Riccardo Pittau
271d85e998 Update how to release section
Based on latest changes [1] in the releases project that changed the
behavior of list_unreleased_changes.

[1] 4912f7d5d0

Change-Id: If5fd848bf3fddeb1ae66dc9aafa882588b83f41a
2020-07-23 16:18:31 +02:00
Riccardo Pittau
759b722a59 Add documentation on how to propose a release
Change-Id: I8f6abbad1612311887f16a88c0fd3b7de8659e27
2020-07-08 06:57:42 +00:00
Mark Goddard
335895a8e7 Add sushy-cli to client libraries release list
Change-Id: I3f627d3811f2840cd630ebc5746b8d9c5de179e9
2020-04-08 15:08:41 +01:00
Iury Gregory Melo Ferreira
3fa0397241 Update release with information about zuul job
After a release we need to update the `templates` for zuul
in master to have the job for the new cycle.

Change-Id: Ic275ea9ec97f74732f4bafa99037c2d8a8229b91
2019-10-23 12:50:12 +02:00
Mark Goddard
f533f42ca6 Remove earliest version from releasing docs, update examples
The bug in reno is now fixed.

Change-Id: I803ec65157fce93a453b2b994e117a542aaad847
2019-09-26 15:49:35 +01:00
Mark Goddard
f2c2437329 Improve documentation about releasing deliverables
Groups together the various types of deliverable, from the perspective
of the release schedule.

Change-Id: Ic6703c17fcd931636c31841637b450e3fb59e19f
2019-09-25 13:36:17 +00:00
ZhongShengping
a280696a03 Replace git.openstack.org URLs with opendev.org URLs
Thorough replacement of git.openstack.org URLs with their opendev.org
counterparts.

Change-Id: Ic19e45986e9f650c1deb297f463e679fd268ad97
2019-04-24 16:13:58 +08:00
Dmitry Tantsur
78d6d95033 Ignore newly introduced tables in pre-upgrade versions check
The version check is run before tables are created, so it cannot
succeed for them.

Change-Id: Ibcf0728bc5d1b0cbdd78796526f9c93fc99e8c08
Story: #2004589
Task: #28467
2018-12-13 16:44:33 +01:00
Ruby Loo
85581f3bb9 Update release instructions wrt grenade
This updates the release documentation to indicate that we have
to wait until grenade is testing the latest release against master,
before making code changes related to rolling upgrades.

Change-Id: I60a3343cfb4565da725a7b39c6ee8b04e4389dec
2018-02-20 11:42:36 -05:00
Zuul
d63b2756b5 Merge "Remove test_contains_current_release_entry" 2018-02-15 16:52:46 +00:00
Dmitry Tantsur
338c22b401 releasing docs: document stable jobs for the tempest plugin
Depends-On: I7705777e2278a0ca6492fcf3ab19b13ee0fbd3e8
Change-Id: I7d4285141e72c7c0780f7d87a829ba643d8105c1
2018-02-12 18:25:00 +01:00
Dmitry Tantsur
a0a4796d00 Remove test_contains_current_release_entry
This test is not helpful for development at all - it only fails
after the version is issued, when it's too late to fix. Furthermore,
it blocks using the sem-ver tag in a commit message to bump minor or
major pre-version, as it expects the future release to exist.

Change-Id: I48034d1433b7e67f1ce2853227dd5a539e15a360
2018-02-09 10:27:36 +01:00
Dmitry Tantsur
534f7bd077 Add 10.1 and queens to the release mapping
Also remove mentioning of the example configuration file from the
releasing docs, as we've removed it.

Change-Id: I8e2a2adcac7de69c3a03ddd560de96b0972b99e1
2018-02-07 13:22:16 +01:00
Jim Rollenhagen
3b8c3879a5 Explicitly mark earliest-version for release notes
This uses reno's `earliest-version` directive to explicitly point out
where the release notes for a given branch should begin. There is a bug
in reno when dealing with stable branches, where it does not always find
the correct version to begin with.

It also updates our release docs to indicate we should continue marking
this. This step can be removed when the reno bug is fixed, though it
doesn't hurt to continue marking this explicitly.

Change-Id: I6502ff95a52c2c855356e9875291f27ec44e7ffa
Related-Bug: #1746076
2018-01-29 14:15:01 -05:00
Ruby Loo
dec24765ae [doc] Non-word updates to releasing doc
This updates the Releasing Ironic Projects documentation to
highlight (in red) anything code-related or file paths.

It also fixes a typo.

This is a follow-up to 7e4857851dc8945eff935da351b7a56c923aff52.

Change-Id: If17be2fa4c20c32740b1b32766abf54897d3370b
2017-09-05 16:02:28 -04:00
Ruby Loo
7e4857851d [docs] Update Releasing Ironic Projects
This updates our releasing documention to reflect the releasing
process we went through for the Pike release.

Change-Id: I4e74f8bfe56e859d68ad7e9f81525a72db424ff5
2017-08-29 21:12:21 -04:00
Shivanand Tendulker
cb793d0136 Fix indentation in few of the documentation pages
Partial-Bug: #1712860
Change-Id: Id467f5a917e61643823a9d82faa94516ea250f43
2017-08-29 05:49:52 -04:00
Ruby Loo
ca1fe6cc84 correct URLs in contributor docs & main index
This corrects the URLs in the contributor documentation as well as the
main index. The changes include:
- changing http to https
- changing absolute links to relative links (where applicable)

Change-Id: Iea392f8108ca4b5203682609dd78b980c1540b89
2017-08-22 23:54:18 +00:00
gaozx
1df3dff00b Fix incorrect documentation urls
Change-Id: Ifc39a856251c18077bc1c3820bffd3c2e9eed9a1
2017-08-22 15:59:43 +01:00
Grzegorz Grasza
54efd31239 Add new dbsync command with first online data migration
This adds the new command 'ironic-dbsync online_data_migrations'.
To limit downtime during upgrades, data migrations will be done online
with migration scripts that could be run during normal operation of an
ironic cluster, after the upgrade but before the next one.

Each migration script should ensure that all related DB records are
migrated to the new format. Scripts can detect the format based on
the object version which is stored in the version column.

The online data migration has one script; a function that backfills
the new version column, using versions of objects from the release
prior to this.

This includes code to check the object versions for compatibility with
an ironic release. However, the check is turned off (and will be turned on
in Queens), since we need to boot-strap the new version column before
we can turn the check on. To do this check, we need to keep a list of all
supported versions for every object; release_mapping.RELEASE_MAPPING was
modified so that the object versions is now a list instead of one value.

Change-Id: I1a9fa829951ecf98cae6896d82ba20cf89062394
Closes-Bug: #1585141
Partial-bug: #1526283
Co-Authored-By: Ruby Loo <ruby.loo@intel.com>
2017-08-02 13:33:37 -04:00
Sam Betts
5647bfc246 Move doc/source/dev to doc/source/contributor
Change-Id: I6a3d143cff31348c62d8825f29f7484bafb9c8f0
2017-07-06 12:59:24 +01:00