diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d7c530b17b..8f628628ce 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -71,25 +71,6 @@ the default for PRs labelled with `T-Task`): _Remove outdated comment from `Ungulates.ts`_ -``` -Notes: none -``` - -Sometimes, you're fixing a bug in a downstream project, in which case you want -an entry in that project's changelog. You can do that too: - -_Fix another herding bug_ - -``` -Notes: Fix a bug where the `herd()` function would only work on Tuesdays -element-web notes: Fix a bug where the 'Herd' button only worked on Tuesdays -``` - -This example is for Element Web. You can specify: - -- element-web -- element-desktop - If your PR introduces a breaking change, use the `Notes` section in the same way, additionally adding the `X-Breaking-Change` label (see below). There's no need to specify in the notes that it's a breaking change - this will be added diff --git a/apps/desktop/README.md b/apps/desktop/README.md index d9b46ca052..e502355a12 100644 --- a/apps/desktop/README.md +++ b/apps/desktop/README.md @@ -1,4 +1,4 @@ -![Build](https://github.com/vector-im/element-desktop/actions/workflows/build.yaml/badge.svg) +![Build](https://github.com/vector-im/element-desktop/actions/workflows/build_desktop_and_deploy.yaml/badge.svg) ![Static Analysis](https://github.com/vector-im/element-desktop/actions/workflows/static_analysis.yaml/badge.svg) [![Localazy](https://img.shields.io/endpoint?url=https%3A%2F%2Fconnect.localazy.com%2Fstatus%2Felement-web%2Fdata%3Fcontent%3Dall%26title%3Dlocalazy%26logo%3Dtrue)](https://localazy.com/p/element-web) [![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=element-desktop&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=element-desktop) @@ -52,10 +52,7 @@ If you only want to run the app locally and don't need to build packages, you ca provide the `webapp` directory directly: ``` -# Assuming you've checked out and built a copy of element-web in ../element-web. -# Note that you will not be able to `pnpm build` after this, but `pnpm start` -# will work fine. -ln -s ../element-web/webapp ./ +ln -s ../web/webapp ./ ``` [TODO: add support for fetching develop builds, arbitrary URLs and arbitrary paths] diff --git a/apps/desktop/docs/packaging.md b/apps/desktop/docs/packaging.md index ba6c42afdc..5ec079c204 100644 --- a/apps/desktop/docs/packaging.md +++ b/apps/desktop/docs/packaging.md @@ -1,11 +1,11 @@ ## Packaging nightlies -Element Desktop nightly builds are build automatically by the [Github Actions workflow](https://github.com/vector-im/element-desktop/blob/develop/.github/workflows/build_and_deploy.yaml). +Element Desktop nightly builds are build automatically by the [Github Actions workflow](https://github.com/vector-im/element-web/blob/develop/.github/workflows/build_desktop_and_deploy.yaml). The schedule is currently set for once a day at 9am UTC. It will deploy to packages.element.io upon completion. ## Triggering a manual nightly build -Simply go to https://github.com/vector-im/element-desktop/actions/workflows/build_and_deploy.yaml +Simply go to https://github.com/vector-im/element-web/actions/workflows/build_desktop_and_deploy.yaml 1. Click `Run workflow` 1. Feel free to make changes to the checkboxes depending on the circumstances diff --git a/apps/desktop/docs/updates.md b/apps/desktop/docs/updates.md index 29b05dc453..5f963cda93 100644 --- a/apps/desktop/docs/updates.md +++ b/apps/desktop/docs/updates.md @@ -2,7 +2,7 @@ The Desktop app is capable of self-updating on macOS and Windows. The update server base url is configurable as `update_base_url` in config.json and can be served by a static file host, CDN or object storage. -Currently all packaging & deployment is handled by [Github actions](https://github.com/vector-im/element-desktop/blob/develop/.github/workflows/build_and_deploy.yaml) +Currently all packaging & deployment is handled by [Github actions](https://github.com/vector-im/element-web/blob/develop/.github/workflows/build_desktop_and_deploy.yaml) # Windows diff --git a/code_style.md b/code_style.md index bd1fb4371c..b86df77d1e 100644 --- a/code_style.md +++ b/code_style.md @@ -1,10 +1,7 @@ # Element Web/Desktop code style guide This code style applies to projects which the element-web team directly maintains or is reasonably -adjacent to. As of writing, these are: - -- element-desktop -- element-web +adjacent to. ## Guiding principles