diff --git a/contrib/source-control-tools/automated-commits.sh b/contrib/source-control-tools/automated-commits.sh index 7724aad1a..1256c7fa2 100755 --- a/contrib/source-control-tools/automated-commits.sh +++ b/contrib/source-control-tools/automated-commits.sh @@ -1,276 +1,302 @@ #!/usr/bin/env bash # Note: Any bot running this script must have the appropriate permissions to # push commits upstream. When running locally, this script will git push in a # dry run by default. export LC_ALL=C.UTF-8 set -euxo pipefail DEFAULT_PARENT_COMMIT="origin/master" help_message() { set +x echo "Generate a commit from available recipes." echo echo "Options:" echo "-p, --parent The parent commit to build ontop of. Default: '${DEFAULT_PARENT_COMMIT}'" echo " Note: This should only be used for testing since the behavior of setting" echo " this to a particular commit varies slightly from the default." echo "-h, --help Display this help message." echo echo "Environment Variables:" echo "COMMIT_TYPE (required) The commit recipe to run." echo "DRY_RUN If set to 'no', this script will push the generated changes upstream. Default: 'yes'" set -x } PARENT_COMMIT="${DEFAULT_PARENT_COMMIT}" # Parse command line arguments while [[ $# -gt 0 ]]; do case $1 in -p|--parent) PARENT_COMMIT=$(git rev-parse "$2") shift # shift past argument shift # shift past value ;; -h|--help) help_message exit 0 ;; *) echo "Unknown argument: $1" help_message exit 1 ;; esac done : "${COMMIT_TYPE:=}" if [ -z "${COMMIT_TYPE}" ]; then echo "Error: Environment variable COMMIT_TYPE must be set" exit 2 fi GIT_PUSH_OPTIONS=("--verbose") case ${DRY_RUN:=yes} in no|NO|false|FALSE) if [ "${PARENT_COMMIT}" != "${DEFAULT_PARENT_COMMIT}" ]; then echo "Error: Running with DRY_RUN=no on a commit parent other than '${DEFAULT_PARENT_COMMIT}'" exit 3 fi ;; *) GIT_PUSH_OPTIONS+=("--dry-run") ;; esac echo "Building automated commit '${COMMIT_TYPE}'..." BOT_PREFIX="[Automated]" TOPLEVEL=$(git rev-parse --show-toplevel) BUILD_DIR="${TOPLEVEL}/abc-ci-builds/automated-commit-${COMMIT_TYPE}" mkdir -p "${BUILD_DIR}" export BUILD_DIR DEVTOOLS_DIR="${TOPLEVEL}"/contrib/devtools # Make sure tree is clean git checkout master git reset --hard "${PARENT_COMMIT}" # Utility functions to compare version strings version_greater_equal() { printf '%s\n%s\n' "$2" "$1" | sort -V -C } version_greater() { [ "$1" != "$2" ] && version_greater_equal "$1" "$2" } version_less_equal() { ! version_greater "$1" "$2" } version_less() { ! version_greater_equal "$1" "$2" } # Common script to update the AUR packages. # Usage: update-aur-version update-aur-version() { PACKAGE="$1" # Get the current version of the software "${DEVTOOLS_DIR}"/build_cmake.sh --no-build CURRENT_VERSION="$(ninja print-version | grep -E '^[0-9]+\.[0-9]+\.[0-9]+$')" # Get the current version of the AUR package PKGBUILD="${TOPLEVEL}"/contrib/aur/${PACKAGE}/PKGBUILD # shellcheck source=../aur/bitcoin-abc/PKGBUILD source "${PKGBUILD}" # Compare the versions. We only want to update if # (software version > package version) to prevent downgrades. if version_less_equal "${CURRENT_VERSION}" "${pkgver}" then echo "Current version ${CURRENT_VERSION} <= ${PACKAGE} AUR package version ${pkgver}, skip the update" exit 0 fi # Reset the release version to 0 and update the package version in the # PKGBUILD file. # Note that this pattern is very safe: because of the shell script syntax, # no whitespace can occur and we have the original value as a variable. sed -i "s/pkgrel=${pkgrel}/pkgrel=0/" "${PKGBUILD}" sed -i "s/pkgver=${pkgver}/pkgver=${CURRENT_VERSION}/" "${PKGBUILD}" git add "${PKGBUILD}" git commit -m "Bump ${PACKAGE} AUR package version to ${CURRENT_VERSION}" } case "${COMMIT_TYPE}" in + archive-release-notes) + RELEASE_NOTES_FILE="${TOPLEVEL}/doc/release-notes.md" + RELEASE_NOTES_VERSION=$(sed -n "1s/^Bitcoin ABC version \([0-9]\+\.[0-9]\+\.[0-9]\+\).\+$/\1/p" "${RELEASE_NOTES_FILE}") + RELEASE_NOTES_ARCHIVE="${TOPLEVEL}/doc/release-notes/release-notes-${RELEASE_NOTES_VERSION}.md" + + "${DEVTOOLS_DIR}"/build_cmake.sh --no-build + CURRENT_VERSION="$(ninja print-version | grep -E '^[0-9]+\.[0-9]+\.[0-9]+$')" + + # Compare the versions. We only want to archive the release notes if the + # current version is greater the our release notes version. + if version_less_equal "${CURRENT_VERSION}" "${RELEASE_NOTES_VERSION}" + then + echo "Current version ${CURRENT_VERSION} <= release-notes version ${RELEASE_NOTES_VERSION}, skip the update" + exit 0 + fi + + # Archive the release notes + cp "${RELEASE_NOTES_FILE}" "${RELEASE_NOTES_ARCHIVE}" + + # Generate a fresh blank release notes file for the new version + PROJECT_VERSION="${CURRENT_VERSION}" envsubst < "${TOPLEVEL}/doc/release-notes/release-notes.md.in" > "${RELEASE_NOTES_FILE}" + + git add "${RELEASE_NOTES_FILE}" "${RELEASE_NOTES_ARCHIVE}" + git commit -m "${BOT_PREFIX} Archive release notes for version ${RELEASE_NOTES_VERSION}" + ;; + update-aur-version-bitcoin-abc) update-aur-version "bitcoin-abc" ;; update-aur-version-bitcoin-abc-qt) update-aur-version "bitcoin-abc-qt" ;; update-chainparams) CHAINPARAMS_SCRIPTS_DIR="${DEVTOOLS_DIR}"/chainparams # Assumes bitcoind instances are already running on mainnet and testnet pushd "${CHAINPARAMS_SCRIPTS_DIR}" CHAINPARAMS_MAINNET_TXT="chainparams_main.txt" ./make_chainparams.py > "${CHAINPARAMS_MAINNET_TXT}" git add "${CHAINPARAMS_MAINNET_TXT}" CHAINPARAMS_TESTNET_TXT="chainparams_test.txt" ./make_chainparams.py -a 127.0.0.1:18332 > "${CHAINPARAMS_TESTNET_TXT}" git add "${CHAINPARAMS_TESTNET_TXT}" CHAINPARAMS_CONSTANTS="${TOPLEVEL}"/src/chainparamsconstants.h ./generate_chainparams_constants.py . > "${CHAINPARAMS_CONSTANTS}" git add "${CHAINPARAMS_CONSTANTS}" popd git commit -m "${BOT_PREFIX} Update chainparams" ;; update-manpages) # Unfortunately bitcoin-qt requires a handle on the DISPLAY, even for the # --help option. We can spoof an X window using xvfb. command -v xvfb-run > /dev/null || (echo "Error: Package 'xvfb' is needed to run bitcoin-qt headlessly." && exit 11) "${DEVTOOLS_DIR}"/build_cmake.sh BUILDDIR="${BUILD_DIR}" xvfb-run "${DEVTOOLS_DIR}"/gen-manpages.sh MANPAGES_DIR="${TOPLEVEL}"/doc/man # Sanity check that the current bitcoind version is in the manpages. # Note that this check could be more complex, checking that all version # instances match the current bitcoind version. But, it's impossible to # know if some other version number will appear in the help text due to # deprecation notices or otherwise. EXPECTED_VERSION=$("${BUILD_DIR}"/src/bitcoind --version | head -1 | grep -oE "v[0-9]+\.[0-9]+\.[0-9]+") grep "${EXPECTED_VERSION}" "${MANPAGES_DIR}"/*\.1 # Sanity check that the version string was not dirty or that something # unexpected occurred. grep "${EXPECTED_VERSION}-dirty" "${MANPAGES_DIR}"/*\.1 && { echo "Error: Unexpected dirty version string." exit 12 } grep "${EXPECTED_VERSION}-unk" "${MANPAGES_DIR}"/*\.1 && { echo "Error: Unknown error detected in version string." exit 13 } # If there is no change, we're done. if [ -z "$(git status --porcelain)" ] then echo "No update to perform on the man pages" exit 0 fi git add "${MANPAGES_DIR}"/*\.1 git commit -m "${BOT_PREFIX} Update manpages" ;; update-seeds) # Assumes seeder instances are already running on mainnet and testnet pushd "${TOPLEVEL}"/contrib/seeds : "${SEEDS_MAIN:=seeds_main.txt}" ./makeseeds.py < "${SEEDS_MAIN}" > nodes_main.txt git add nodes_main.txt : "${SEEDS_TEST:=seeds_test.txt}" ./makeseeds.py < "${SEEDS_TEST}" > nodes_test.txt git add nodes_test.txt SEEDS_HEADER="${TOPLEVEL}"/src/chainparamsseeds.h ./generate-seeds.py . > "${SEEDS_HEADER}" git add "${SEEDS_HEADER}" popd # Check that seeds have good connectivity "${DEVTOOLS_DIR}"/build_cmake.sh SEEDS_DIR="${TOPLEVEL}"/contrib/seeds RPC_PORT=18832 "${SEEDS_DIR}"/check-seeds.sh main 80 RPC_PORT=18833 "${SEEDS_DIR}"/check-seeds.sh test 70 git commit -m "${BOT_PREFIX} Update seeds" ;; update-timings) "${DEVTOOLS_DIR}"/build_cmake.sh pushd "${BUILD_DIR}" ninja check-functional-extended TIMING_SRC_FILE="${TOPLEVEL}"/test/functional/timing.json mv timing.json "${TIMING_SRC_FILE}" popd # Check that all tests are included in timing.json pushd "${TOPLEVEL}"/test/functional NON_TESTS=$(python3 -c 'from test_runner import NON_SCRIPTS; print(" ".join(NON_SCRIPTS))') export NON_TESTS check_missing() { # Exclude non-tests from the check if [[ "${NON_TESTS}" =~ $1 ]]; then exit 0 fi if ! grep -q $1 timing.json ; then echo "Error: Test file '$1' is missing from timing.json" exit 1 fi } export -f check_missing find . -maxdepth 1 -name '*.py' | cut -c 3- | xargs -I'{}' -n1 bash -c 'check_missing {}' popd git add "${TIMING_SRC_FILE}" git commit -m "${BOT_PREFIX} Update timing.json" ;; *) echo "Error: Invalid commit name '${COMMIT_TYPE}'" exit 10 ;; esac # Smoke tests to give some confidence that master won't be put into a bad state "${DEVTOOLS_DIR}"/smoke-tests.sh echo "Pushing automated commit '${COMMIT_TYPE}'..." # Make sure master is up-to-date. If there is a merge conflict, this script # will not attempt to resolve it and simply fail. git fetch origin master git rebase "${PARENT_COMMIT}" git push "${GIT_PUSH_OPTIONS[@]}" origin master diff --git a/doc/release-notes/release-notes.md.in b/doc/release-notes/release-notes.md.in new file mode 100644 index 000000000..680c37e03 --- /dev/null +++ b/doc/release-notes/release-notes.md.in @@ -0,0 +1,5 @@ +Bitcoin ABC version ${PROJECT_VERSION} is now available from: + + + +This release includes the following features and fixes: