Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add Instruction for release to check external documentation links #1218

Merged
merged 2 commits into from Aug 11, 2022
Merged

Add Instruction for release to check external documentation links #1218

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b1e3ec5
scripts: Add instruction to check external documentation links
bruno-at-bareos Aug 10, 2022
76acbf0
update CHANGELOG.md
bruno-at-bareos Aug 10, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Open in desktop
Expand Up @@ -135,6 +135,7 @@ and since Bareos version 20 this project adheres to [Semantic Versioning](https:
- clarifies CheckFileChanges option not intended to be used with plugin [BUG #1452][PR #1180]
- Fix broken links with sphinx linkcheck [PR #1200]
- add Security FIPS section [PR #1181]
- add instruction to run sphinx linkcheck before release [PR #1218]

[PR #698]: https://github.com/bareos/bareos/pull/698
[PR #768]: https://github.com/bareos/bareos/pull/768
Expand Down
8 changes: 7 additions & 1 deletion devtools/prepare-release.sh
View file
Open in desktop
@@ -1,7 +1,7 @@
#!/bin/bash
# BAREOS® - Backup Archiving REcovery Open Sourced
#
# Copyright (C) 2019-2021 Bareos GmbH & Co. KG
# Copyright (C) 2019-2022 Bareos GmbH & Co. KG
#
# This program is Free Software; you can redistribute it and/or
# modify it under the terms of version three of the GNU Affero General Public
Expand Down Expand Up @@ -196,6 +196,12 @@ the commits, tags and branch pointers before you push!
For a major release you should be on the release-branch, not the master
branch. While you can move around branch pointers later, it is a lot
easier to branch first.

Verify the documentation external links by calling:
* sphinx-build -M linkcheck docs/manuals/source out/ -j2
or (outside the docbuild container):
* make docs-check-urls

EOT

if ! confirm "Do you want to proceed?"; then
Expand Down