Skip to content
This repository has been archived by the owner on Apr 26, 2024. It is now read-only.

Upload documentation PRs to Netlify #12947

Merged
merged 7 commits into from
Nov 4, 2022
Merged

Upload documentation PRs to Netlify #12947

merged 7 commits into from
Nov 4, 2022

Conversation

t3chguy
Copy link
Member

@t3chguy t3chguy commented Jun 2, 2022 •
edited by DMRobertson
Loading

Signed-off-by: Michael Telatynski [email protected]

Pull Request Checklist

  • Pull request is based on the develop branch
  • Pull request includes a changelog file. The entry should:
    • Be a short description of your change which makes sense to users. "Fixed a bug that prevented receiving messages from other servers." instead of "Moved X method from EventStore to EventWorkerStore.".
    • Use markdown where necessary, mostly for code blocks.
    • End with either a period (.) or an exclamation mark (!).
    • Start with a capital letter.
    • Feel free to credit yourself, by adding a sentence "Contributed by @github_username." or "Contributed by [Your Name]." to the end of the entry.
  • Pull request includes a sign off
  • Code style is correct
    (run the linters)

@t3chguy
Upload documentation PRs to Netlify
5ad76a0 
Signed-off-by: Michael Telatynski <[email protected]>
@DMRobertson
Copy link
Contributor

@matrix-org/synapse-core are we interested in this?

@DMRobertson DMRobertson marked this pull request as ready for review October 19, 2022 17:07
@DMRobertson DMRobertson requested a review from a team as a code owner October 19, 2022 17:07
@t3chguy
Copy link
Member Author

t3chguy commented Oct 20, 2022

I was told by @babolivier that it was desired, then later @erikjohnston was looking into it when I pointed him at this PR

@erikjohnston
Copy link
Member

I was told by @babolivier that it was desired, then later @erikjohnston was looking into it when I pointed him at this PR

Its taken me a while to remember why I was! The answer is that it would be useful to have the rust docs uploaded for things that touch the rust code

babolivier
babolivier suggested changes Oct 20, 2022
View reviewed changes
Copy link
Contributor

@babolivier babolivier left a comment •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just a couple of questions. Also has this been tested e.g. on a branch?

.github/workflows/docs-pr-netlify.yaml Show resolved Hide resolved
.github/workflows/docs-pr-netlify.yaml Show resolved Hide resolved
@t3chguy
Copy link
Member Author

t3chguy commented Oct 20, 2022

Also has this been tested e.g. on a branch?

No due to lack of access to add secrets to this repo, but it is basically a clone of how Element Web's Netlify works so it should work first time every time ™️

@babolivier
Copy link
Contributor

babolivier commented Oct 20, 2022 •
edited
Loading

No due to lack of access to add secrets to this repo, but it is basically a clone of how Element Web's Netlify works so it should work first time every time

Right, I would still like to see it working before we merge this though, just to ensure there isn't anything that's been missed while copying stuff over, or while setting up the secrets on the repo.

Next step is for me to figure out how to get these secrets in place.

@babolivier
Copy link
Contributor

From DMs with @t3chguy: this is relying on catching a workflow_run event from one of the new workflows, which only works if the workflow lives on the default branch. So I'm going to merge this PR, test that it works on a draft PR, and revert if this fails.

@babolivier babolivier enabled auto-merge (squash) November 4, 2022 16:38
@t3chguy
Copy link
Member Author

t3chguy commented Nov 4, 2022 •
edited
Loading

For context this is using workflow_run to be able to work on PRs from forks, using pull_request would not have access to the Netlify secrets in those PRs. pull_request_target could be used instead, but it would increase risk as it'd be executing PR code in the context which has the secrets. Here we build the docs in a safe secret-free workflow, then the workflow_run just downloads and deploys

@babolivier babolivier merged commit 79b6c19 into matrix-org:develop Nov 4, 2022
@babolivier babolivier mentioned this pull request Nov 4, 2022
Merged
babolivier added a commit that referenced this pull request Nov 4, 2022
@babolivier
Fix the trigger path for deploying documentation PRs (#14370)
bb39fc4 
This was missed from #12947
bradtgmurray added a commit to beeper/synapse-legacy-fork that referenced this pull request Nov 22, 2022
@bradtgmurray
Merge tag 'v1.72.0' into merge-v1.72
844c458 
Synapse 1.72.0 (2022-11-22)
===========================

Please note that Synapse now only supports PostgreSQL 11+, because PostgreSQL 10 has reached end-of-life, c.f. our [Deprecation Policy](https://github.com/matrix-org/synapse/blob/develop/docs/deprecation_policy.md).

Bugfixes
--------

- Update forgotten references to legacy metrics in the included Grafana dashboard. ([\matrix-org#14477](matrix-org#14477))

Synapse 1.72.0rc1 (2022-11-16)
==============================

Features
--------

- Add experimental support for [MSC3912](matrix-org/matrix-spec-proposals#3912): Relation-based redactions. ([\matrix-org#14260](matrix-org#14260))
- Build Debian packages for Ubuntu 22.10 (Kinetic Kudu). ([\matrix-org#14396](matrix-org#14396))
- Add an [Admin API](https://matrix-org.github.io/synapse/latest/usage/administration/admin_api/index.html) endpoint for user lookup based on third-party ID (3PID). Contributed by @ashfame. ([\matrix-org#14405](matrix-org#14405))
- Faster joins: include heroes' membership events in the partial join response, for rooms without a name or canonical alias. ([\matrix-org#14442](matrix-org#14442))

Bugfixes
--------

- Faster joins: do not block creation of or queries for room aliases during the resync. ([\matrix-org#14292](matrix-org#14292))
- Fix a bug introduced in Synapse 1.64.0rc1 which could cause log spam when fetching events from other homeservers. ([\matrix-org#14347](matrix-org#14347))
- Fix a bug introduced in 1.66 which would not send certain pushrules to clients. Contributed by Nico. ([\matrix-org#14356](matrix-org#14356))
- Fix a bug introduced in v1.71.0rc1 where the power level event was incorrectly created during initial room creation. ([\matrix-org#14361](matrix-org#14361))
- Fix the refresh token endpoint to be under /r0 and /v3 instead of /v1. Contributed by Tulir @ Beeper. ([\matrix-org#14364](matrix-org#14364))
- Fix a long-standing bug where Synapse would raise an error when encountering an unrecognised field in a `/sync` filter, instead of ignoring it for forward compatibility. ([\matrix-org#14369](matrix-org#14369))
- Fix a background database update, introduced in Synapse 1.64.0, which could cause poor database performance. ([\matrix-org#14374](matrix-org#14374))
- Fix PostgreSQL sometimes using table scans for queries against the `event_search` table, taking a long time and a large amount of IO. ([\matrix-org#14409](matrix-org#14409))
- Fix rendering of some HTML templates (including emails). Introduced in v1.71.0. ([\matrix-org#14448](matrix-org#14448))
- Fix a bug introduced in Synapse 1.70.0 where the background updates to add non-thread unique indexes on receipts could fail when upgrading from 1.67.0 or earlier. ([\matrix-org#14453](matrix-org#14453))

Updates to the Docker image
---------------------------

- Add all Stream Writer worker types to `configure_workers_and_start.py`. ([\matrix-org#14197](matrix-org#14197))
- Remove references to legacy worker types in the multi-worker Dockerfile. ([\matrix-org#14294](matrix-org#14294))

Improved Documentation
----------------------

- Upload documentation PRs to Netlify. ([\matrix-org#12947](matrix-org#12947), [\matrix-org#14370](matrix-org#14370))
- Add addtional TURN server configuration example based on [eturnal](https://github.com/processone/eturnal) and adjust general TURN server doc structure. ([\matrix-org#14293](matrix-org#14293))
- Add example on how to load balance /sync requests. Contributed by [aceArt](https://aceart.de). ([\matrix-org#14297](matrix-org#14297))
- Edit sample Nginx reverse proxy configuration to use HTTP/1.1. Contributed by Brad Jones. ([\matrix-org#14414](matrix-org#14414))

Deprecations and Removals
-------------------------

- Remove support for PostgreSQL 10. ([\matrix-org#14392](matrix-org#14392), [\matrix-org#14397](matrix-org#14397))

Internal Changes
----------------

- Run unit tests against Python 3.11. ([\matrix-org#13812](matrix-org#13812))
- Add TLS support for generic worker endpoints. ([\matrix-org#14128](matrix-org#14128), [\matrix-org#14455](matrix-org#14455))
- Switch to a maintained action for installing Rust in CI. ([\matrix-org#14313](matrix-org#14313))
- Add override ability to `complement.sh` command line script to request certain types of workers. ([\matrix-org#14324](matrix-org#14324))
- Enabling testing of [MSC3874](matrix-org/matrix-spec-proposals#3874) (filtering of `/messages` by relation type) in complement. ([\matrix-org#14339](matrix-org#14339))
- Concisely log a failure to resolve state due to missing `prev_events`. ([\matrix-org#14346](matrix-org#14346))
- Use a maintained Github action to install Rust. ([\matrix-org#14351](matrix-org#14351))
- Cleanup old worker datastore classes. Contributed by Nick @ Beeper (@Fizzadar). ([\matrix-org#14375](matrix-org#14375))
- Test against PostgreSQL 15 in CI. ([\matrix-org#14394](matrix-org#14394))
- Remove unreachable code. ([\matrix-org#14410](matrix-org#14410))
- Clean-up event persistence code. ([\matrix-org#14411](matrix-org#14411))
- Update docstring to clarify that `get_partial_state_events_batch` does not just give you completely arbitrary partial-state events. ([\matrix-org#14417](matrix-org#14417))
- Fix mypy errors introduced by bumping the locked version of `attrs` and `gitpython`. ([\matrix-org#14433](matrix-org#14433))
- Make Dependabot only bump Rust deps in the lock file. ([\matrix-org#14434](matrix-org#14434))
- Fix an incorrect stub return type for `PushRuleEvaluator.run`. ([\matrix-org#14451](matrix-org#14451))
- Improve performance of `/context` in large rooms. ([\matrix-org#14461](matrix-org#14461))
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@babolivier babolivier babolivier approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@t3chguy @DMRobertson @erikjohnston @babolivier