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.

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

Documentation snapshot for v4.10.0 #6098

Merged
merged 2 commits into from
Feb 7, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/Snapshots.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ layout: default

- [Current development version](https://dafny.org/dafny)
- [Latest release snapshot](https://dafny.org/latest)
- [v4.10.0](https://dafny.org/v4.10.0)
- [v4.9.1](https://dafny.org/v4.9.1)
- [v4.8.1](https://dafny.org/v4.8.1)
- [v4.6.0](https://dafny.org/v4.6.0)
Expand Down
17 changes: 11 additions & 6 deletions docs/make-snapshot
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
#! /usr/bin/env bash

# Make sure to exit the script if anything goes wrong
set -e

## This script copies the current development docs into the dafny.org
## user-facing web pages, making a snapshot of the current docs.
## It is intended to be run as part of a release procedure (so that
Expand All @@ -18,8 +21,8 @@
## It also takes one option: -b <branchname>
## (the branch used defaults to 'master')

if [ ! `which gh` ]; then echo "This script requires that gh is installed"; exit 1; fi
if [ ! `which git` ]; then echo "This script requires that git is installed"; exit 1; fi
if ! which gh >/dev/null 2>&1; then echo "This script requires that gh is installed"; exit 1; fi
if ! which git >/dev/null 2>&1; then echo "This script requires that git is installed"; exit 1; fi

## Check that gh is logged in by running gh auth status, and if not, run gh auth login
if [ -z "`gh auth status | grep -i logged`" ]; then
Expand Down Expand Up @@ -69,8 +72,10 @@ mkdir -p $P
CWD=`pwd`
cd $P
(git clone [email protected]:dafny-lang/dafny.git -b $branch --depth 1) || \
(echo "Retrying with the HTTPS protocol..." && git clone https://github.com/dafny-lang/dafny.git -b $branch --depth 1) || \
(echo FAILED to clone dafny; exit 1)
(git clone [email protected]:dafny-lang/dafny-lang.github.io.git -b main --depth 1) || \
(echo "Retrying with the HTTPS protocol..." && git clone https://github.com/dafny-lang/dafny-lang.github.io.git -b main --depth 1) || \
(echo FAILED to clone dafny-lang.github.io; exit 1)
cd $CWD

Expand All @@ -88,10 +93,10 @@ echo Branch is "$B"
## Changes locally
git checkout -b "$B" $branch
sed -i -e "szlatest)zlatest)\n- [$V](https://dafny.org/$V)z" Snapshots.md
rm Snapshots.md-e
rm Snapshots.md-e || echo "No Snapshots.md-e to remove"
git add Snapshots.md
git commit -m "Documentation snapshot for $V"
git push --set-upstream origin "$B"
git push --force --set-upstream origin "$B"
(gh pr create --fill -R https://github.com/dafny-lang/dafny -B $branch --head "$B" | tail -1 > $P/url1) || \
(echo FAILED to create PR with gh; exit 1)

Expand Down Expand Up @@ -121,7 +126,7 @@ sed -i -e "s/$M.*/${M}Latest release documentation snapshot/" $T/latest/index.ht

CWD=`pwd`
cd $T
rm `find . -name index.html-e`
rm `find . -name index.html-e` || echo "index.html-e not deleted because not found"

(git add -u \
&& git add "$V" \
Expand All @@ -130,7 +135,7 @@ rm `find . -name index.html-e`
) || ( echo FAILED to commit or push the snapshot ; exit 1 ) \

git status
git push --set-upstream origin "$B"
git push --force --set-upstream origin "$B"
gh pr create --fill -R https://github.com/dafny-lang/dafny-lang.github.io -B main --head "$B" | tail -1 > $P/url2
cd $CWD

Expand Down
Loading