publish from project repos, not this repo anymore
Do not publish PDFs for all projects anymore with jenkins.sh --publish or "make publish". Extract known_hosts from jenkins.sh, and install it along with the other shared files in OSMO_GSM_MANUALS_DIR. Add a "publish" target to Makefile.common.inc, so we can use it from the project repositories. Document its usage in INSTALL.txt. No automatism for building and publishing the documentation of all projects will be implemented in this patch series, as discussed here: https://osmocom.org/issues/3385#note-7 (moving manuals to project repositories 19/19) Related: OS#3385 Change-Id: Ibe0424ceace151115985896b6d43035c69067c50
This commit is contained in:
parent
aec8d2b3d8
commit
e7446e8810
21
INSTALL.txt
21
INSTALL.txt
|
@ -14,13 +14,26 @@ apt-get install \
|
|||
|
||||
(Note that asciidoc-dblatex is required from debian 9 on and did not exist before.)
|
||||
|
||||
Build PDFs, run:
|
||||
Prepare your build dir:
|
||||
autoreconf -fi
|
||||
./configure
|
||||
make
|
||||
|
||||
or for a parallel build using more CPU cores, replace make with:
|
||||
make -j 5
|
||||
Optionally test building all shared content (use -j for parallel building):
|
||||
make # generate test PDFs
|
||||
make check # test for asciidoc errors
|
||||
|
||||
Install osmo-gsm-manuals:
|
||||
make install
|
||||
|
||||
Build the manuals of a specific Osmocom project:
|
||||
cd ../osmo-msc # enter the project dir, clone first if needed
|
||||
./configure --enable-manuals
|
||||
make
|
||||
ls doc/manuals/*.pdf # find the PDFs here
|
||||
|
||||
Publish PDFs to the Osmocom server:
|
||||
cd ../osmo-msc # enter the project dir
|
||||
make -C doc/manuals publish
|
||||
|
||||
To update the VTY reference for a given program, use 'osmo_interact_vty.py -X',
|
||||
available from git.osmocom.org/python/osmo-python-tests:
|
||||
|
|
|
@ -5,6 +5,7 @@
|
|||
#
|
||||
# Include this file at the end to have the common targets (upload, clean etc.).
|
||||
|
||||
SSH_COMMAND = ssh -o 'UserKnownHostsFile=$(OSMO_GSM_MANUALS_DIR)/build/known_hosts' -p 48
|
||||
UPLOAD_PATH ?= generic@sysmocom-downloads:documents
|
||||
SYMLINKS = common build
|
||||
CLEAN_FILES += $(SYMLINKS)
|
||||
|
@ -19,3 +20,8 @@ clean:
|
|||
-rm -rf $(CLEAN_FILES)
|
||||
|
||||
distclean: clean
|
||||
|
||||
publish: all check
|
||||
mkdir -p out
|
||||
cp *.pdf out
|
||||
rsync -avz -e "$(SSH_COMMAND)" ./out/ docs@rita.osmocom.org:web-files/latest/
|
||||
|
|
|
@ -0,0 +1,3 @@
|
|||
[rita.osmocom.org]:48 ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDDgQ9HntlpWNmh953a2Gc8NysKE4orOatVT1wQkyzhARnfYUerRuwyNr1GqMyBKdSI9amYVBXJIOUFcpV81niA7zQRUs66bpIMkE9/rHxBd81SkorEPOIS84W4vm3SZtuNqa+fADcqe88Hcb0ZdTzjKILuwi19gzrQyME2knHY71EOETe9Yow5RD2hTIpB5ecNxI0LUKDq+Ii8HfBvndPBIr0BWYDugckQ3Bocf+yn/tn2/GZieFEyFpBGF/MnLbAAfUKIdeyFRX7ufaiWWz5yKAfEhtziqdAGZaXNaLG6gkpy3EixOAy6ZXuTAk3b3Y0FUmDjhOHllbPmTOcKMry9
|
||||
[rita.osmocom.org]:48 ecdsa-sha2-nistp256 AAAAE2VjZHNhLXNoYTItbmlzdHAyNTYAAAAIbmlzdHAyNTYAAABBBPdWn1kEousXuKsZ+qJEZTt/NSeASxCrUfNDW3LWtH+d8Ust7ZuKp/vuyG+5pe5pwpPOgFu7TjN+0lVjYJVXH54=
|
||||
[rita.osmocom.org]:48 ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIK8iivY70EiR5NiGChV39gRLjNpC8lvu1ZdHtdMw2zuX
|
|
@ -2,7 +2,12 @@
|
|||
|
||||
set -ex
|
||||
|
||||
publish="$1"
|
||||
if [ -n "$1" ]; then
|
||||
echo "ERROR: --publish has been deprecated!"
|
||||
echo "Manuals have been moved to the projects, and need to be published from there."
|
||||
echo "See INSTALL.txt for more information."
|
||||
exit 1
|
||||
fi
|
||||
|
||||
osmo-clean-workspace.sh
|
||||
|
||||
|
@ -12,17 +17,4 @@ $MAKE $PARALLEL_MAKE
|
|||
$MAKE $PARALLEL_MAKE check
|
||||
$MAKE $PARALLEL_MAKE distcheck
|
||||
|
||||
if [ "x$publish" = "x--publish" ]; then
|
||||
mkdir out/
|
||||
cp */*.pdf out/
|
||||
|
||||
cat > "$WORKSPACE/known_hosts" <<EOF
|
||||
[rita.osmocom.org]:48 ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDDgQ9HntlpWNmh953a2Gc8NysKE4orOatVT1wQkyzhARnfYUerRuwyNr1GqMyBKdSI9amYVBXJIOUFcpV81niA7zQRUs66bpIMkE9/rHxBd81SkorEPOIS84W4vm3SZtuNqa+fADcqe88Hcb0ZdTzjKILuwi19gzrQyME2knHY71EOETe9Yow5RD2hTIpB5ecNxI0LUKDq+Ii8HfBvndPBIr0BWYDugckQ3Bocf+yn/tn2/GZieFEyFpBGF/MnLbAAfUKIdeyFRX7ufaiWWz5yKAfEhtziqdAGZaXNaLG6gkpy3EixOAy6ZXuTAk3b3Y0FUmDjhOHllbPmTOcKMry9
|
||||
[rita.osmocom.org]:48 ecdsa-sha2-nistp256 AAAAE2VjZHNhLXNoYTItbmlzdHAyNTYAAAAIbmlzdHAyNTYAAABBBPdWn1kEousXuKsZ+qJEZTt/NSeASxCrUfNDW3LWtH+d8Ust7ZuKp/vuyG+5pe5pwpPOgFu7TjN+0lVjYJVXH54=
|
||||
[rita.osmocom.org]:48 ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIK8iivY70EiR5NiGChV39gRLjNpC8lvu1ZdHtdMw2zuX
|
||||
EOF
|
||||
SSH_COMMAND="ssh -o 'UserKnownHostsFile=$WORKSPACE/known_hosts' -p 48"
|
||||
rsync -avz --delete -e "$SSH_COMMAND" ./out/ docs@rita.osmocom.org:web-files/latest/
|
||||
fi
|
||||
|
||||
osmo-clean-workspace.sh
|
||||
|
|
Loading…
Reference in New Issue