summary refs log tree commit diff
path: root/.github (follow)
Commit message (Collapse)AuthorAgeFilesLines
* Merge branch 'master' into release-v1.38Richard van der Hoff2021-07-071-30/+27
|\
| * build the docs for master (#10323)Richard van der Hoff2021-07-071-31/+28
| |
* | Create an index.html file when generating a docs build (#10242)Andrew Morgan2021-06-241-1/+6
|/ | | | | | | | | Currently when a new build of the docs is created, an `index.html` file does not exist. Typically this would be generated from a`docs/README.md` file - which we have - however we're currently using [docs/README.md](https://github.com/matrix-org/synapse/blob/394673055db4df49bfd58c2f6118834a6d928563/docs/README.md) to explain the docs and point to the website. It is not part of the content of the website. So we end up not having an `index.html` file, which will result in a 404 page if one tries to navigate to `https://matrix-org.github.io/synapse/<docs_version>/index.html`. This isn't a really problem for the default version of the documentation (currently `develop`), as [navigating to the top-level root](https://matrix-org.github.io/synapse/) of the website (without specifying a version) will [redirect](https://github.com/matrix-org/synapse/blob/a77e6925f26597958eccf0ef9956cb13c536e57e/index.html#L2) you to the Welcome and Overview page of the `develop` docs version. However, ideally once we add a GUI for switching between versions, we'll want to send the user to `matrix-org.github.io/synapse/<version>/index.html`, which currently isn't generated. This PR modifies the CI that builds the docs to simply copy the rendered [Welcome & Overview page](https://matrix-org.github.io/synapse/develop/welcome_and_overview.html) to `index.html`.
* Deploy a documentation version for each new Synapse release (#10198)Andrew Morgan2021-06-181-0/+33
| | | | | | | | | This PR will run a new "Deploy release-specific documentation" job whenever a push to a branch name matching `release-v*` occurs. Doing so will create/add to a folder named `vX.Y` on the `gh-pages` branch. Doing so will allow us to build up `major.minor` releases of the docs as we release Synapse. This is especially useful for having a mechanism for keeping around documentation of old/removed features (for those running older versions of Synapse), without needing to clutter the latest copy of the docs. After a [discussion](https://matrix.to/#/!XaqDhxuTIlvldquJaV:matrix.org/$rKmkBmQle8OwTlGcoyu0BkcWXdnHW3_oap8BMgclwIY?via=matrix.org&via=vector.modular.im&via=envs.net) in #synapse-dev, we wanted to use tags to trigger the documentation deployments, which I agreed with. However, I soon realised that the bash-foo required to turn a tag of `v1.2.3rc1` into `1.2` was a lot more complex than the branch's `release-v1.2`. So, I've gone with the latter for simplicity. In the future we'll have some UI on the website to switch between versions, but for now you can simply just change 'develop' to 'v1.2' in the URL.
* Use the matching complement branch when running tests in CI. (#10160)Patrick Cloke2021-06-111-5/+23
| | | | | | | | | | | This implements similar behavior to sytest where a matching branch is used, if one exists. This is useful when needing to modify both application code and tests at the same time. The following rules are used to find a matching complement branch: 1. Search for the branch name of the pull request. (E.g. feature/foo.) 2. Search for the base branch of the pull request. (E.g. develop or release-vX.Y.) 3. Search for the reference branch of the commit. (E.g. master or release-vX.Y.) 4. Fallback to 'master', the default complement branch name.
* Update Complement run with Synapse-supported MSC-related build tags (#10155)Andrew Morgan2021-06-091-1/+1
| | | | | This PR updates the build tags that we perform Complement runs with to match our [buildkite pipeline](https://github.com/matrix-org/pipelines/blob/618b3e90bcae8efd1a71502ae95b7913e6e24665/synapse/pipeline.yml#L570), as well as adding `msc2403` (as it will be required once #9359 is merged). Build tags are what we use to determine which tests to run in Complement (really it determines which test files are compiled into the final binary). I haven't put in a comment about updating the buildkite side here, as we've decided to migrate fully to GitHub Actions anyhow.
* Compile and render Synapse's docs into a browsable, mobile-friendly and ↵Andrew Morgan2021-06-031-0/+31
| | | | searchable website (#10086)
* github actions: summarize Sytest results in an easy-to-read format (#10094)Richard van der Hoff2021-06-021-2/+2
| | | ... using the script from matrix-org/sytest#1052
* Fix GitHub Actions lint for newsfragments (#10069)Dan Callahan2021-05-261-0/+6
| | | | | * Fix GitHub Actions lint for newsfragments Signed-off-by: Dan Callahan <danc@element.io>
* Fix port_db on empty db (#9930)Richard van der Hoff2021-05-101-1/+1
| | | | ... and test it.
* Proof of concept for GitHub Actions (#9661)Dan Callahan2021-04-091-0/+322
| | | Signed-off-by: Dan Callahan <danc@element.io>
* bug report template: move comments into comment (#8030)Richard van der Hoff2020-08-051-2/+2
|
* Make it clearer that #synapse:matrix.org is our support channel (#7379)Brendan Abolivier2020-05-012-3/+10
| | | | | | | This PR moves the "support is in #synapse:matrix.org" in the bug report template outside of the comment as some people seem to ignore what's in the comments, and phrase it a bit more like the support request template. It also adds a default issue template that says the same thing. It's also adding a notice about the security disclosure to both the default template and the bug report one. It also adds a badge to the top of the README with an alt text saying about the same message if the badge doesn't load (e.g. if matrix.org is slow). Fixes #6826
* Add tips for the changelog to the pull request template (#6663)Andrew Morgan2020-01-161-1/+5
|
* Markdownification and other fixes to CONTRIBUTING (#6461)Andrew Morgan2019-12-041-4/+4
|
* Add contributer docs for using the provided linters script (#6164)Jason Robinson2019-11-021-0/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | * Add lint dependencies black, flake8 and isort These are required when running the `lint.sh` dev scripts. Signed-off-by: Jason Robinson <jasonr@matrix.org> * Add contributer docs for using the providers linters script Add also to the pull request template to avoid build failures due to people not knowing that linters need running. Signed-off-by: Jason Robinson <jasonr@matrix.org> * Fix mention of linter errors correction Co-Authored-By: Andrew Morgan <1342360+anoadragon453@users.noreply.github.com> * Add mention for installing linter dependencies Co-Authored-By: Andrew Morgan <1342360+anoadragon453@users.noreply.github.com> * Remove linters from python dependencies as per PR review Signed-off-by: Jason Robinson <jasonr@matrix.org>
* Update the issue template for new way of getting server version (#6051)Richard van der Hoff2019-09-191-9/+13
| | | | | | cf #4878
* Merge remote-tracking branch 'origin/master' into release-v1.1.0Richard van der Hoff2019-07-022-5/+6
|\
| * Update github templatesRichard van der Hoff2019-06-251-2/+3
| |
| * Update SUPPORT.mdRichard van der Hoff2019-06-251-3/+3
| |
* | Liberapay is now officially recognised, update FUNDING.yml (#5386)Andrew Morgan2019-06-091-1/+2
| |
* | Add a sponsor button (#5382)Andrew Morgan2019-06-071-0/+3
|/ | | Add a sponsor button with links to matrixdotorg's patreon and liberapay accounts.
* Add zwsp in bug report template (#4811)Richard van der Hoff2019-03-061-6/+6
| | | | | Inserts a zero-width space in the `-->` which isn't supposed to close a comment. This used to be here but it got lost in d86826277d764217311d0d34a8e6143d09237a94.
* Update PR template to use absolute links (#4341)Aaron Raimist2019-01-021-2/+2
| | | | | | | | | | * Update PR template to use absolute links Signed-off-by: Aaron Raimist <aaron@raim.ist> * Add changelog Signed-off-by: Aaron Raimist <aaron@raim.ist>
* Fix caseAaron Raimist2018-11-131-1/+1
| | | | Signed-off-by: Aaron Raimist <aaron@raim.ist>
* Add SUPPORT.mdAaron Raimist2018-11-131-0/+3
| | | | https://help.github.com/articles/adding-support-resources-to-your-project/
* Add a pull request template and add multiple issue templatesAaron Raimist2018-11-134-10/+53
| | | | Signed-off-by: Aaron Raimist <aaron@raim.ist>
* Update ISSUE_TEMPLATE.mdRichard van der Hoff2018-07-241-2/+3
| | | request backticks for logs
* Exclude the github issue template from our sdist (#2440)Richard van der Hoff2017-09-051-0/+47
PR #2413 added an issue template, but just adding files to the project directory upsets the packaging scripts: we need to explicitly include or exclude them. Move the template into a .github directory to make that easy, and to de-clutter the root a bit.