shaba/systemd
1
0
Fork 0
mirror of https://github.com/systemd/systemd.git synced 2024-10-31 16:21:26 +03:00
Code
07335f7f1f
systemd/docs/RELEASE.md

23 lines
1.3 KiB
Markdown
Raw Normal View History

docs: add a "front matter" snippet to our markdown pages It turns out Jekyll (the engine behind GitHub Pages) requires that pages include a "Front Matter" snippet of YAML at the top for proper rendering. Omitting it will still render the pages, but including it opens up new possibilities, such as using a {% for %} loop to generate index.md instead of requiring a separate script. I'm hoping this will also fix the issue with some of the pages (notably CODE_OF_CONDUCT.html) not being available under systemd.io Tested locally by rendering the website with Jekyll. Before this change, the *.md files were kept unchanged (so not sure how that even works?!), after this commit, proper *.html files were generated from it.
2019-01-03 01:16:34 +03:00
---
title: Steps to a Successful Release
docs: place all our markdown docs in rough categories
2019-12-11 12:49:28 +03:00
category: Contributing
docs: make it pretty Add custom Jekyll theme, logo, webfont and .gitignore FIXME: the markdown files have some H1 headers which need to be replaced with H2
2019-12-11 19:01:46 +03:00
layout: default
docs: add a "front matter" snippet to our markdown pages It turns out Jekyll (the engine behind GitHub Pages) requires that pages include a "Front Matter" snippet of YAML at the top for proper rendering. Omitting it will still render the pages, but including it opens up new possibilities, such as using a {% for %} loop to generate index.md instead of requiring a separate script. I'm hoping this will also fix the issue with some of the pages (notably CODE_OF_CONDUCT.html) not being available under systemd.io Tested locally by rendering the website with Jekyll. Before this change, the *.md files were kept unchanged (so not sure how that even works?!), after this commit, proper *.html files were generated from it.
2019-01-03 01:16:34 +03:00
---
docs: uppercase the title of our Markdown docs
2018-11-29 13:09:09 +03:00
# Steps to a Successful Release
Add RELEASE.md file which lists the steps needed for release I put it in .github, so it doesn't stand out too much; after all it's not interesting to most people.
2016-05-31 20:43:41 +03:00
1. Add all items to NEWS
tree-wide: suggest meson command lines instead of ninja ones This only changes documentation. In various places we call "ninja" directly. I figured it would be safer to leave those in place for now, given the meson replacement commands lines appears to be supported in newer meson versions only.
2020-12-11 13:33:39 +03:00
2. Update the contributors list in NEWS (`meson compile -C build git-contrib`)
Add RELEASE.md file which lists the steps needed for release I put it in .github, so it doesn't stand out too much; after all it's not interesting to most people.
2016-05-31 20:43:41 +03:00
3. Update the time and place in NEWS
docs/RELEASE: clarify which steps are done when
2020-11-26 15:48:35 +03:00
4. [RC1] Update version and library numbers in `meson.build`
meson: rename target to update-dbus-docs Very old versions of meson did not include the subdirectory name in the target name, so we started adding various "top-level" custom targets in subdirectories. This was nice because the main meson.build file wasn't as cluttered. But then meson started including the subdir name in the target name. So let's move the definition to the root so we can have all targets named uniformly.
2021-01-27 10:46:42 +03:00
5. Check dbus docs with `meson compile -C build update-dbus-docs`
docs: add man/update-dbus-docs step to release instructions
2020-08-22 13:28:15 +03:00
6. Tag the release: `version=vXXX-rcY && git tag -s "${version}" -m "systemd ${version}"`
tree-wide: suggest meson command lines instead of ninja ones This only changes documentation. In various places we call "ninja" directly. I figured it would be safer to leave those in place for now, given the meson replacement commands lines appears to be supported in newer meson versions only.
2020-12-11 13:33:39 +03:00
7. Do `meson compile -C build`
docs: add man/update-dbus-docs step to release instructions
2020-08-22 13:28:15 +03:00
8. Make sure that the version string and package string match: `build/systemctl --version`
tree-wide: suggest meson command lines instead of ninja ones This only changes documentation. In various places we call "ninja" directly. I figured it would be safer to leave those in place for now, given the meson replacement commands lines appears to be supported in newer meson versions only.
2020-12-11 13:33:39 +03:00
9. Upload the documentation: `meson compile -C build doc-sync`
docs/RELEASE: clarify which steps are done when
2020-11-26 15:48:35 +03:00
10. [FINAL] Close the github milestone and open a new one (https://github.com/systemd/systemd/milestones)
docs: add man/update-dbus-docs step to release instructions
2020-08-22 13:28:15 +03:00
11. "Draft" a new release on github (https://github.com/systemd/systemd/releases/new), mark "This is a pre-release" if appropriate.
12. Check that announcement to systemd-devel, with a copy&paste from NEWS, was sent. This should happen automatically.
13. Update IRC topic (`/msg chanserv TOPIC #systemd Version NNN released`)
docs/RELEASE: clarify which steps are done when
2020-11-26 15:48:35 +03:00
14. [FINAL] Push commits to stable, create an empty -stable branch: `git push systemd-stable origin/master:master origin/master:refs/heads/${version}-stable`, and change the default branch to latest release (https://github.com/systemd/systemd-stable/settings/branches).
Copy Permalink