Skip to content

Commit

Permalink
Merge branch 'master' into debug-server-plugins
Browse files Browse the repository at this point in the history
  • Loading branch information
azigler committed Jun 7, 2024
2 parents e763268 + 5d97341 commit 29bbb9b
Show file tree
Hide file tree
Showing 29 changed files with 672 additions and 255 deletions.
1 change: 1 addition & 0 deletions .github/workflows/preview-env-fork.yml
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@ jobs:
- name: Build Previews
run: |
rm -rf ./dist
make plugin-data
hugo -F -s site --baseURL http://mattermost-dev-docs-preview-pulls.s3-website-us-east-1.amazonaws.com/${{ steps.pr.outputs.id }}/ --destination ../dist/html
- uses: shallwefootball/s3-upload-action@master
Expand Down
1 change: 1 addition & 0 deletions .github/workflows/preview-env.yml
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ jobs:
- name: Build Previews
run: |
rm -rf ./dist
make plugin-data
hugo -F -s site --baseURL http://mattermost-dev-docs-preview-pulls.s3-website-us-east-1.amazonaws.com/${{ github.event.number }}/ --destination ../dist/html
- name: Run tests
Expand Down
4 changes: 2 additions & 2 deletions site/config.toml
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,8 @@ enableEmoji = true

[params.notification]
enable = true
url = "https://mattermost.com/webinar/cybersecurity-incident-response/"
text = "[WEBINAR] Learn how to secure mission-critical work"
url = "https://mattermost.com/webinar/ai-collaboration-landscape-of-tomorrow/"
text = "[WEBINAR] How AI is Transforming Mission-Critical Work"

[params.search]
enable = true
Expand Down
9 changes: 8 additions & 1 deletion site/content/contribute/developer-setup/docker.md
Original file line number Diff line number Diff line change
Expand Up @@ -117,12 +117,19 @@ From https://grafana.com/oss/loki/:
Just as Prometheus is for metrics, think of Loki being for logs. Combined with promtail scraping the logs from Mattermost and all these supporting Docker containers, and Grafana for the frontend, Loki effectively provides a powerful user interface for slicing and dicing your developer logs.

## keycloak

From https://www.keycloak.org/documentation:

> Keycloak is an open source identity and access management solution.
Keycloak can be used as a SAML identity provider with your local setup. See the setup instructions [here](https://github.com/mattermost/mattermost/blob/master/server/build/docker/keycloak/README.md).

# Other Docker services

Other Docker services supported by the development environment include:
* minio
* openldap
* dejavu
* keycloak
* elasticsearch

16 changes: 2 additions & 14 deletions site/content/contribute/more-info/desktop/developer-setup/macos.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,19 +3,7 @@
3. Install dependencies

```sh
brew install node@16 git python3
brew install nvm git python3
```

4. Add NodeJS to PATH:

```sh
echo 'export PATH="/usr/local/opt/node@16/bin:$PATH"' >> ~/.zshrc
source ~/.zshrc
```

---
For machines using the M1 architecture:
1. Use the latest NodeJS@16 (>=v16.16)

2. Update {{< newtabref href="https://developer.apple.com/xcode/" title="Xcode" >}} to latest version (>=v13.4.1)

4. Run `nvm install --lts` to install and use the latest LTS version.
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,8 @@
4. Install dependencies

```sh
choco install nodejs-lts git python3
choco install nvm git python3
```

5. Restart PowerShell (to refresh the environment variables)
6. Run `nvm install lts` and `nvm use lts` to install and use the latest NodeJS LTS version.
Original file line number Diff line number Diff line change
Expand Up @@ -83,18 +83,18 @@ To make it easier to customize your build, we've defined a few environment varia
| `GIT_LOCAL_BRANCH` | Defines the local branch to be created from `BRANCH_TO_BUILD` to ensure the base branch does not get any new commits on it. <br><br>**Make sure a branch with this name does not yet exist in your local Git repository**. | build | No |
| `RESET_GIT_BRANCH` | Defines if, once the build is done, the branch should be reset to the initial state before building and whether to also delete the branch created to build the app. <br><br>Valid values are: `true`, `false` | `false` | No |
| `VERSION_NUMBER ` | Set the version of the app at build time to a specific value, rather than using the one set in the project. | | No |
| `INCREMENT_VERSION_<br>NUMBER_MESSAGE` | Set the commit message when changing the app version number. | Bump app version number to | No |
| `INCREMENT_VERSION_NUMBER_MESSAGE` | Set the commit message when changing the app version number. | Bump app version number to | No |
| `INCREMENT_BUILD_NUMBER` | Defines if the app build number should be incremented. <br><br>Valid values are: `true`, `false` | `false` | No |
| `BUILD_NUMBER` | Set the build number of the app at build time to a specific value, rather than incrementing the last build number. | | No |
| `INCREMENT_BUILD_<br>NUMBER_MESSAGE` | Set the commit message when changing the app build number. | Bump app build number to | No |
| `INCREMENT_BUILD_NUMBER_MESSAGE` | Set the commit message when changing the app build number. | Bump app build number to | No |
| `ANDROID_BUILD_TASK` | The build tasks for Android. This is a comma-separated list of tasks that can have two values: 'assemble' and 'bundle'. <br><br>`assemble` is used for building `APK` file and `bundle` is used for building `AAB` file. | assemble | No |
| `APP_NAME` | The name of the app as it is going to be shown on the device home screen. | Mattermost Beta | Yes |
| `APP_SCHEME` | The URL naming scheme for the app as used in direct deep links to app content from outside the app. | mattermost | No |
| `REPLACE_ASSETS` | Override the assets as described in [White Labeling]({{< ref "/contribute/more-info/mobile/build-your-own/white-label" >}}). <br><br>Valid values are: `true`, `false` | `false` | No |
| `MAIN_APP_IDENTIFIER` | The package identifier for the app. | | Yes |
| `BUILD_FOR_RELEASE` | Defines if the app should be built in release mode. <br><br>Valid values are: `true`, `false` <br><br>**Make sure you set this value to true if you plan to submit this app Google Play or distribute it in any other way**. | `false` | Yes |
| `SEPARATE_APKS` | Build one APK per achitecture (armeabi-v7a, x86, arm64-v8a and x86_64) as well as a universal APK. The advantage is the size of the APK is reduced by about 4MB. <br><br>People will download the correct APK from the Play Store based on the CPU architecture of their device. | `false` | Yes |
| `SUBMIT_ANDROID_TO_<br>GOOGLE_PLAY` | Should the app be submitted to the Play Store once it finishes building, use along with `SUPPLY_TRACK`.<br><br>Valid values are: `true`, `false` | `false` | Yes |
| `SUBMIT_ANDROID_TO_GOOGLE_PLAY` | Should the app be submitted to the Play Store once it finishes building, use along with `SUPPLY_TRACK`.<br><br>Valid values are: `true`, `false` | `false` | Yes |
| `SUPPLY_TRACK` | The track of the application to use when submitting the app to Google Play Store. Valid values are: `alpha`, `beta`, `production` <br><br>**RIt is not recommended to submit the app to production. First try any of the other tracks and then promote your app using the Google Play console**. | `alpha` | Yes |
| `SUPPLY_PACKAGE_NAME` | The package Id of your application, make sure it matches `MAIN_APP_IDENTIFIER`. | | Yes |
| `SUPPLY_JSON_KEY` | The path to the service account `json` file used to authenticate with Google.<br><br>See the {{< newtabref href=" https://docs.fastlane.tools/actions/supply/#setup" title="Supply documentation" >}} to learn more. | | Yes |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -45,10 +45,10 @@ To make it easier to customize your build, we've defined a few environment varia
| `GIT_LOCAL_BRANCH` | Defines the local branch to be created from BRANCH\_TO\_BUILD to ensure the base branch does not get any new commits on it.<br><br>**Make sure a branch with this name does not yet exist in your local git**. | build | No |
| `RESET_GIT_BRANCH` | Defines if, once the build is done, the branch should be reset to the initial state before building and whether to also delete the branch created to build the app. <br><br>Valid values are: `true`, `false` | `false` | No |
| `VERSION_NUMBER` | Set the version of the app at build time to a specific value, rather than using the one set in the project. | | No |
| `INCREMENT_VERSION_<br>NUMBER_MESSAGE` | Set the commit message when changing the app version number. | Bump app version number to | No |
| `INCREMENT_VERSION_NUMBER_MESSAGE` | Set the commit message when changing the app version number. | Bump app version number to | No |
| `INCREMENT_BUILD_NUMBER` | Defines if the app build number should be incremented.<br><br>Valid values are: `true`, `false` | `false` | No |
| `BUILD_NUMBER` | Set the build number of the app at build time to a specific value, rather than incrementing the last build number. | | No |
| `INCREMENT_BUILD_<br>NUMBER_MESSAGE` | Set the commit message when changing the app build number. | Bump app build number to | No |
| `INCREMENT_BUILD_NUMBER_MESSAGE` | Set the commit message when changing the app build number. | Bump app build number to | No |
| `APP_NAME` | The name of the app as it is going to be shown in the device home screen. | Mattermost Beta | Yes |
| `APP_SCHEME` | The URL naming scheme for the app as used in direct deep links to app content from outside the app. | mattermost | No |
| `REPLACE_ASSETS` | Override the assets as described in [White Labeling]({{< ref "/contribute/more-info/mobile/build-your-own/white-label" >}}).<br><br>Valid values are: `true`, `false` | `false` | No |
Expand All @@ -68,7 +68,7 @@ To make it easier to customize your build, we've defined a few environment varia
| `MATCH_TYPE` | Define the provisioning profile type to sync. Valid values are: `appstore`, `adhoc`, `development`, `enterprise` <br><br>**Make sure you set this value to the same type as the `IOS_BUILD_EXPORT_METHOD` as you want to have the same provisioning profiles installed in the machine so they are found when signing the app**. | `adhoc` | Yes |
| `SUBMIT_IOS_TO_TESTFLIGHT` | Submit the app to TestFlight once the build finishes. Valid values are: `true`, `false` | `false` | No |
| `PILOT_USERNAME` | Your Apple ID Username used to deploy the app to TestFlight. | | No |
| `PILOT_SKIP_WAITING_<br>FOR_BUILD_PROCESSING` | Do not wait until TestFlight finishes processing the app.<br><br>Valid values are: `true`, `false` | `true` | No |
| `PILOT_SKIP_WAITING_FOR_BUILD_PROCESSING` | Do not wait until TestFlight finishes processing the app.<br><br>Valid values are: `true`, `false` | `true` | No |

---
{{<note "Note:">}}
Expand Down
2 changes: 1 addition & 1 deletion site/layouts/_default/list.html
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
<div class="container-fluid">
<div class="row">
{{ partial "sidebar-v2.html" .}}
<div class="col-lg-9 doc-content">
<div class="col-lg-9 mx-2 mx-lg-0 mt-4 mt-lg-5 doc-content">
{{ partial "page-edit.html" . }}
<h1 class="mt-0 doc-title">
{{ if .Params.heading }}
Expand Down
Loading

0 comments on commit 29bbb9b

Please sign in to comment.