36 lines
2.0 KiB
Markdown
36 lines
2.0 KiB
Markdown
# Project instructions
|
|
|
|
## Mandatory Wiki updates for every release
|
|
|
|
A release is not complete until the published project Wiki reflects that release.
|
|
Apply this rule to every release, including patch releases and bug-fix-only releases.
|
|
|
|
Wiki: https://gitea.hrynco.com/hrynco/hrynco-kswitcher/wiki
|
|
|
|
1. Confirm the release version from `CMakeLists.txt`, the release tag and
|
|
`Release/README.md`. Use the complete version (for example, `v0.6.17`) and
|
|
preserve the release channel rules in `README.md`.
|
|
2. Update the latest-version information on the Wiki home pages and any other
|
|
pages identifying the current release. Update release dates, download links
|
|
and upgrade instructions where needed. Keep historical version references
|
|
and compatibility bridge instructions when they are still accurate.
|
|
3. Review the changes since the last release documented in the Wiki, not just
|
|
the immediately preceding release. Bring the relevant feature pages up to
|
|
date with the shipped behavior: new, changed and removed functionality,
|
|
settings, shortcuts, defaults, limitations and troubleshooting. Update
|
|
screenshots or examples when they no longer match the application.
|
|
For bug-fix-only releases, check whether documented behavior or workarounds
|
|
need correction; do not invent feature changes.
|
|
4. Keep English and Ukrainian pages synchronized, including `Home` and
|
|
`Home-uk`, and preserve working translation and navigation links.
|
|
5. Publish the Wiki changes as part of the release workflow. Read back the
|
|
published pages and verify the current version, feature descriptions,
|
|
download links and translation links. A local Wiki edit alone is not enough.
|
|
6. In the release completion report, link the updated Wiki pages and summarize
|
|
the documentation changes. If Wiki publication or verification is blocked,
|
|
explicitly report the outstanding step and do not claim the release workflow
|
|
is complete.
|
|
|
|
Updating only the release notes or changing only the Wiki version number does
|
|
not satisfy this rule; the current functionality must also be reviewed.
|