diff --git a/scripts-dev/lint.sh b/scripts-dev/lint.sh
index 809eff166a..b6554a73c1 100755
--- a/scripts-dev/lint.sh
+++ b/scripts-dev/lint.sh
@@ -90,10 +90,10 @@ else
"scripts/hash_password"
"scripts/register_new_matrix_user"
"scripts/synapse_port_db"
+ "scripts/update_synapse_database"
"scripts-dev"
"scripts-dev/build_debian_packages"
"scripts-dev/sign_json"
- "scripts-dev/update_database"
"contrib" "synctl" "setup.py" "synmark" "stubs" ".ci"
)
fi
diff --git a/scripts-dev/make_full_schema.sh b/scripts-dev/make_full_schema.sh
index 39bf30d258..c3c90f4ec6 100755
--- a/scripts-dev/make_full_schema.sh
+++ b/scripts-dev/make_full_schema.sh
@@ -147,7 +147,7 @@ python -m synapse.app.homeserver --generate-keys -c "$SQLITE_CONFIG"
# Make sure the SQLite3 database is using the latest schema and has no pending background update.
echo "Running db background jobs..."
-scripts-dev/update_database --database-config "$SQLITE_CONFIG"
+scripts/update_synapse_database --database-config --run-background-updates "$SQLITE_CONFIG"
# Create the PostgreSQL database.
echo "Creating postgres database..."
diff --git a/scripts-dev/release.py b/scripts-dev/release.py
index ab2d860ab8..4e1f99fee4 100755
--- a/scripts-dev/release.py
+++ b/scripts-dev/release.py
@@ -35,6 +35,19 @@ from github import Github
from packaging import version
+def run_until_successful(command, *args, **kwargs):
+ while True:
+ completed_process = subprocess.run(command, *args, **kwargs)
+ exit_code = completed_process.returncode
+ if exit_code == 0:
+ # successful, so nothing more to do here.
+ return completed_process
+
+ print(f"The command {command!r} failed with exit code {exit_code}.")
+ print("Please try to correct the failure and then re-run.")
+ click.confirm("Try again?", abort=True)
+
+
@click.group()
def cli():
"""An interactive script to walk through the parts of creating a release.
@@ -197,7 +210,7 @@ def prepare():
f.write(parsed_synapse_ast.dumps())
# Generate changelogs
- subprocess.run("python3 -m towncrier", shell=True)
+ run_until_successful("python3 -m towncrier", shell=True)
# Generate debian changelogs
if parsed_new_version.pre is not None:
@@ -209,11 +222,11 @@ def prepare():
else:
debian_version = new_version
- subprocess.run(
+ run_until_successful(
f'dch -M -v {debian_version} "New synapse release {debian_version}."',
shell=True,
)
- subprocess.run('dch -M -r -D stable ""', shell=True)
+ run_until_successful('dch -M -r -D stable ""', shell=True)
# Show the user the changes and ask if they want to edit the change log.
repo.git.add("-u")
@@ -224,7 +237,7 @@ def prepare():
# Commit the changes.
repo.git.add("-u")
- repo.git.commit(f"-m {new_version}")
+ repo.git.commit("-m", new_version)
# We give the option to bail here in case the user wants to make sure things
# are OK before pushing.
@@ -239,6 +252,8 @@ def prepare():
# Otherwise, push and open the changelog in the browser.
repo.git.push("-u", repo.remote().name, repo.active_branch.name)
+ print("Opening the changelog in your browser...")
+ print("Please ask others to give it a check.")
click.launch(
f"https://github.com/matrix-org/synapse/blob/{repo.active_branch.name}/CHANGES.md"
)
@@ -290,7 +305,19 @@ def tag(gh_token: Optional[str]):
# If no token was given, we bail here
if not gh_token:
+ print("Launching the GitHub release page in your browser.")
+ print("Please correct the title and create a draft.")
+ if current_version.is_prerelease:
+ print("As this is an RC, remember to mark it as a pre-release!")
+ print("(by the way, this step can be automated by passing --gh-token,")
+ print("or one of the GH_TOKEN or GITHUB_TOKEN env vars.)")
click.launch(f"https://github.com/matrix-org/synapse/releases/edit/{tag_name}")
+
+ print("Once done, you need to wait for the release assets to build.")
+ if click.confirm("Launch the release assets actions page?", default=True):
+ click.launch(
+ f"https://github.com/matrix-org/synapse/actions?query=branch%3A{tag_name}"
+ )
return
# Create a new draft release
@@ -305,6 +332,7 @@ def tag(gh_token: Optional[str]):
)
# Open the release and the actions where we are building the assets.
+ print("Launching the release page and the actions page.")
click.launch(release.html_url)
click.launch(
f"https://github.com/matrix-org/synapse/actions?query=branch%3A{tag_name}"
diff --git a/scripts-dev/update_database b/scripts-dev/update_database
deleted file mode 100755
index 87f709b6ed..0000000000
--- a/scripts-dev/update_database
+++ /dev/null
@@ -1,100 +0,0 @@
-#!/usr/bin/env python
-# Copyright 2019 The Matrix.org Foundation C.I.C.
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-# http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-import argparse
-import logging
-import sys
-
-import yaml
-
-from twisted.internet import defer, reactor
-
-import synapse
-from synapse.config.homeserver import HomeServerConfig
-from synapse.metrics.background_process_metrics import run_as_background_process
-from synapse.server import HomeServer
-from synapse.storage import DataStore
-from synapse.util.versionstring import get_version_string
-
-logger = logging.getLogger("update_database")
-
-
-class MockHomeserver(HomeServer):
- DATASTORE_CLASS = DataStore
-
- def __init__(self, config, **kwargs):
- super(MockHomeserver, self).__init__(
- config.server_name, reactor=reactor, config=config, **kwargs
- )
-
- self.version_string = "Synapse/" + get_version_string(synapse)
-
-
-if __name__ == "__main__":
- parser = argparse.ArgumentParser(
- description=(
- "Updates a synapse database to the latest schema and runs background updates"
- " on it."
- )
- )
- parser.add_argument("-v", action="store_true")
- parser.add_argument(
- "--database-config",
- type=argparse.FileType("r"),
- required=True,
- help="A database config file for either a SQLite3 database or a PostgreSQL one.",
- )
-
- args = parser.parse_args()
-
- logging_config = {
- "level": logging.DEBUG if args.v else logging.INFO,
- "format": "%(asctime)s - %(name)s - %(lineno)d - %(levelname)s - %(message)s",
- }
-
- logging.basicConfig(**logging_config)
-
- # Load, process and sanity-check the config.
- hs_config = yaml.safe_load(args.database_config)
-
- if "database" not in hs_config:
- sys.stderr.write("The configuration file must have a 'database' section.\n")
- sys.exit(4)
-
- config = HomeServerConfig()
- config.parse_config_dict(hs_config, "", "")
-
- # Instantiate and initialise the homeserver object.
- hs = MockHomeserver(config)
-
- # Setup instantiates the store within the homeserver object and updates the
- # DB.
- hs.setup()
- store = hs.get_datastore()
-
- async def run_background_updates():
- await store.db_pool.updates.run_background_updates(sleep=False)
- # Stop the reactor to exit the script once every background update is run.
- reactor.stop()
-
- def run():
- # Apply all background updates on the database.
- defer.ensureDeferred(
- run_as_background_process("background_updates", run_background_updates)
- )
-
- reactor.callWhenRunning(run)
-
- reactor.run()
|
