summaryrefslogtreecommitdiffstats
path: root/js/src/doc/publish.sh
blob: fad0b27d94d534254fd85fabd3dd74fba01c3de5 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
#!/usr/bin/env bash

# Format js/src/doc documentation in SOURCEDIR, place formatted files in OUTPUTDIR,
# and post all changed pages to MDN using KEYID and SECRET to identify the poster.
# See js/src/doc/README.md for general usage information.
#
# Usage:
#
#   ./publish.sh SOURCEDIR OUTPUTDIR KEYID SECRET
#
# Pages are tagged with the current Mercurial parent changeset ID.

set -eu

progname=$(basename $0)
doc=$(cd $(dirname $0); pwd)
lib=$doc/lib

sourcedir=$1
outputdir=$2
keyid=$3
secret=$4

$doc/format.sh --mdn "$sourcedir" "$outputdir"

config=$sourcedir/config.sh

watermark=$lib/extract-watermark.sh

# Fetch a URL, with caching disabled.
fetch() {
    curl --silent -XGET "$1"                                    \
         -H"Cache-Control: no-cache, no-store, must-revalidate" \
         -H"Pragma: no-cache"                                   \
         -H"Expires: 0"
}

source $lib/dummy-config.sh

markdown() {
    INPUT_FILE=$1
    URL=$BASE_URL$2

    local formatted_file=$outputdir/${INPUT_FILE/md/html}

    # Extract the watermark from the formatted file.
    local local_watermark=$("$watermark" < "$formatted_file")

    # Get the existing page, and extract its watermark, if any.
    local public_watermark=$(fetch "$URL?raw" | "$watermark")

    if [ "$local_watermark" != "$public_watermark" ]; then
        echo "$progname: Updating: $URL" >&2
        local status
        status=$(curl --silent -X PUT -H"Content-Type: text/html" --upload-file "$formatted_file" -u "$keyid:$secret" "$URL")
        case "$status" in
            CREATED | RESET)
                ;;
            *)
                echo "$progname: Error posting $URL, from $config: $status" >&2
                exit 1
                ;;
        esac
    else
        echo "$progname: Unchanged: $URL" >&2
    fi
}

# MDN can't currently update attached resources. But we can verify that the current
# published versions match what we have.
resource() {
    local label=$1
    local file=$sourcedir/$2
    local url=$3

    if cmp "$file" <(fetch "$url") > /dev/null; then
        echo "$progname: Unchanged: $url" >&2
    else
        echo "$progname: Warning: resource out of date: $url" >&2
    fi
}

source $config