Synapse module that protects users and rooms from accidental deletion.
  • Python 92.8%
  • Shell 7.2%
Find a file
Repository files (latest commit first)
Filename Latest commit message Latest commit date
Half-Shot 413ba0c7a3 v1.0.0
2022-05-23 13:19:07 +01:00
.github/workflows Initial version 2022-05-23 13:17:51 +01:00
scripts-dev Initial version 2022-05-23 13:17:51 +01:00
synapse_protector Initial version 2022-05-23 13:17:51 +01:00
tests Initial version 2022-05-23 13:17:51 +01:00
.gitignore Initial version 2022-05-23 13:17:51 +01:00
LICENSE Initial version 2022-05-23 13:17:51 +01:00
mypy.ini Initial version 2022-05-23 13:17:51 +01:00
pyproject.toml Initial version 2022-05-23 13:17:51 +01:00
README.md v1.0.0 2022-05-23 13:19:07 +01:00
setup.cfg v1.0.0 2022-05-23 13:19:07 +01:00
tox.ini Initial version 2022-05-23 13:17:51 +01:00

Protector

Synapse module that protects users and rooms from accidental deletion.

Installation

From the virtual environment that you use for Synapse, install this module with:

pip install path/to/synapse-protector

(If you run into issues, you may need to upgrade pip first, e.g. by running pip install --upgrade pip)

Then alter your homeserver configuration, adding to your modules configuration:

modules:
  - module: synapse_protector.Protector
    config:
      users: 
         - "@foo:bar"
      rooms:
         - "!foo:bar"

Development

In a virtual environment with pip ≥ 21.1, run

pip install -e .[dev]

To run the unit tests, you can either use:

tox -e py

or

trial tests

To run the linters and mypy type checker, use ./scripts-dev/lint.sh.

Releasing

The exact steps for releasing will vary; but this is an approach taken by the Synapse developers (assuming a Unix-like shell):

  1. Set a shell variable to the version you are releasing (this just makes subsequent steps easier):

    version=X.Y.Z
    
  2. Update setup.cfg so that the version is correct.

  3. Stage the changed files and commit.

    git add -u
    git commit -m v$version -n
    
  4. Push your changes.

    git push
    
  5. When ready, create a signed tag for the release:

    git tag -s v$version
    

    Base the tag message on the changelog.

  6. Push the tag.

    git push origin tag v$version
    
  7. Create a release based on the tag you just pushed, on GitHub.