Desktop: Keep comments when rendering Markdown to allow rendered note… #18636
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: Joplin Continuous Integration | |
| on: [push, pull_request] | |
| jobs: | |
| Main: | |
| # We always process server or desktop release tags, because they also publish the release | |
| if: github.repository == 'laurent22/joplin' | |
| runs-on: ${{ matrix.os }} | |
| strategy: | |
| matrix: | |
| # Do not use unbuntu-latest because it causes `The operation was canceled` failures: | |
| # https://github.com/actions/runner-images/issues/6709 | |
| os: [macos-13, ubuntu-20.04, windows-2019] | |
| steps: | |
| # Trying to fix random networking issues on Windows | |
| # https://github.com/actions/runner-images/issues/1187#issuecomment-686735760 | |
| - name: Disable TCP/UDP offload on Windows | |
| if: runner.os == 'Windows' | |
| run: Disable-NetAdapterChecksumOffload -Name * -TcpIPv4 -UdpIPv4 -TcpIPv6 -UdpIPv6 | |
| - name: Disable TCP/UDP offload on Linux | |
| if: runner.os == 'Linux' | |
| run: sudo ethtool -K eth0 tx off rx off | |
| - name: Disable TCP/UDP offload on macOS | |
| if: runner.os == 'macOS' | |
| run: | | |
| sudo sysctl -w net.link.generic.system.hwcksum_tx=0 | |
| sudo sysctl -w net.link.generic.system.hwcksum_rx=0 | |
| # Silence apt-get update errors (for example when a module doesn't | |
| # exist) since otherwise it will make the whole build fails, even though | |
| # it might work without update. libsecret-1-dev is required for keytar - | |
| # https://github.com/atom/node-keytar | |
| - name: Install Linux dependencies | |
| if: runner.os == 'Linux' | |
| run: | | |
| sudo apt-get update || true | |
| sudo apt-get install -y gettext | |
| sudo apt-get install -y libsecret-1-dev | |
| sudo apt-get install -y translate-toolkit | |
| sudo apt-get install -y rsync | |
| # Provides a virtual display on Linux. Used for Playwright integration | |
| # testing. | |
| sudo apt-get install -y xvfb | |
| - name: Install macOs dependencies | |
| if: runner.os == 'macOS' | |
| run: | | |
| # Required for building the canvas package | |
| brew install pango | |
| - name: Install Docker Engine | |
| # if: runner.os == 'Linux' && startsWith(github.ref, 'refs/tags/server-v') | |
| if: runner.os == 'Linux' | |
| run: | | |
| sudo apt-get install -y apt-transport-https | |
| sudo apt-get install -y ca-certificates | |
| sudo apt-get install -y curl | |
| sudo apt-get install -y gnupg | |
| sudo apt-get install -y lsb-release | |
| curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo gpg --dearmor -o /usr/share/keyrings/docker-archive-keyring.gpg | |
| echo \ | |
| "deb [arch=amd64 signed-by=/usr/share/keyrings/docker-archive-keyring.gpg] https://download.docker.com/linux/ubuntu \ | |
| $(lsb_release -cs) stable" | sudo tee /etc/apt/sources.list.d/docker.list > /dev/null | |
| sudo apt-get update || true | |
| sudo apt-get install -y docker-ce docker-ce-cli containerd.io | |
| - uses: actions/checkout@v4 | |
| - uses: olegtarasov/get-tag@v2.1.3 | |
| - uses: dtolnay/rust-toolchain@stable | |
| - uses: actions/setup-node@v4 | |
| with: | |
| # We need to pin the version to 18.15, because 18.16+ fails with this error: | |
| # https://github.com/facebook/react-native/issues/36440 | |
| node-version: '18.15.0' | |
| cache: 'yarn' | |
| - name: Install Yarn | |
| run: | | |
| # https://yarnpkg.com/getting-started/install | |
| corepack enable | |
| # Login to Docker only if we're on a server release tag. If we run this on | |
| # a pull request it will fail because the PR doesn't have access to | |
| # secrets | |
| - uses: docker/login-action@v3 | |
| if: runner.os == 'Linux' && startsWith(github.ref, 'refs/tags/server-v') | |
| with: | |
| username: ${{ secrets.DOCKERHUB_USERNAME }} | |
| password: ${{ secrets.DOCKERHUB_TOKEN }} | |
| # macos-latest ships with Python 3.12 by default, but this removes a | |
| # utility that's used by electron-builder (distutils) so we need to pin | |
| # Python to an earlier version. | |
| # Fixes error `ModuleNotFoundError: No module named 'distutils'` | |
| # Ref: https://github.com/nodejs/node-gyp/issues/2869 | |
| - uses: actions/setup-python@v5 | |
| with: | |
| python-version: '3.11' | |
| - name: Run tests, build and publish Linux and macOS apps | |
| if: runner.os == 'Linux' || runner.os == 'macOs' | |
| env: | |
| APPLE_ASC_PROVIDER: ${{ secrets.APPLE_ASC_PROVIDER }} | |
| APPLE_ID: ${{ secrets.APPLE_ID }} | |
| APPLE_ID_PASSWORD: ${{ secrets.APPLE_ID_PASSWORD }} | |
| APPLE_APP_SPECIFIC_PASSWORD: ${{ secrets.APPLE_APP_SPECIFIC_PASSWORD }} | |
| CSC_KEY_PASSWORD: ${{ secrets.APPLE_CSC_KEY_PASSWORD }} | |
| CSC_LINK: ${{ secrets.APPLE_CSC_LINK }} | |
| GH_TOKEN: ${{ secrets.GH_TOKEN }} | |
| IS_CONTINUOUS_INTEGRATION: 1 | |
| BUILD_SEQUENCIAL: 1 | |
| SERVER_REPOSITORY: joplin/server | |
| SERVER_TAG_PREFIX: server | |
| CROWDIN_PERSONAL_TOKEN: ${{ secrets.CROWDIN_PERSONAL_TOKEN }} | |
| run: | | |
| "${GITHUB_WORKSPACE}/.github/scripts/run_ci.sh" | |
| - name: Build and publish Windows app | |
| if: runner.os == 'Windows' && startsWith(github.ref, 'refs/tags/v') | |
| env: | |
| CSC_KEY_PASSWORD: ${{ secrets.WINDOWS_CSC_KEY_PASSWORD }} | |
| CSC_LINK: ${{ secrets.WINDOWS_CSC_LINK }} | |
| GH_TOKEN: ${{ secrets.GH_TOKEN }} | |
| IS_CONTINUOUS_INTEGRATION: 1 | |
| BUILD_SEQUENCIAL: 1 | |
| # To ensure that the operations stop on failure, all commands | |
| # should be on one line with "&&" in between. | |
| run: | | |
| yarn install && cd packages/app-desktop && yarn dist | |
| # Build and package the Windows app, without publishing it, just to | |
| # verify that the build process hasn't been broken. | |
| - name: Build Windows app (no publishing) | |
| if: runner.os == 'Windows' && !startsWith(github.ref, 'refs/tags/v') | |
| env: | |
| IS_CONTINUOUS_INTEGRATION: 1 | |
| BUILD_SEQUENCIAL: 1 | |
| SERVER_REPOSITORY: joplin/server | |
| SERVER_TAG_PREFIX: server | |
| run: | | |
| yarn install && cd packages/app-desktop && yarn dist --publish=never | |
| ServerDockerImage: | |
| if: github.repository == 'laurent22/joplin' | |
| runs-on: ${{ matrix.os }} | |
| strategy: | |
| matrix: | |
| # Do not use unbuntu-latest because it causes `The operation was canceled` failures: | |
| # https://github.com/actions/runner-images/issues/6709 | |
| os: [ubuntu-20.04] | |
| steps: | |
| - name: Install Docker Engine | |
| run: | | |
| sudo apt-get install -y apt-transport-https | |
| sudo apt-get install -y ca-certificates | |
| sudo apt-get install -y curl | |
| sudo apt-get install -y gnupg | |
| sudo apt-get install -y lsb-release | |
| curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo gpg --dearmor -o /usr/share/keyrings/docker-archive-keyring.gpg | |
| echo \ | |
| "deb [arch=amd64 signed-by=/usr/share/keyrings/docker-archive-keyring.gpg] https://download.docker.com/linux/ubuntu \ | |
| $(lsb_release -cs) stable" | sudo tee /etc/apt/sources.list.d/docker.list > /dev/null | |
| sudo apt-get update || true | |
| sudo apt-get install -y docker-ce docker-ce-cli containerd.io | |
| - uses: actions/checkout@v4 | |
| - uses: actions/setup-node@v4 | |
| with: | |
| node-version: '18' | |
| cache: 'yarn' | |
| - name: Install Yarn | |
| run: | | |
| # https://yarnpkg.com/getting-started/install | |
| corepack enable | |
| - name: Build Docker Image | |
| env: | |
| BUILD_SEQUENCIAL: 1 | |
| run: | | |
| yarn install | |
| yarn buildServerDocker --tag-name server-v0.0.0 --repository joplin/server | |
| # Basic test to ensure that the created build is valid. It should exit with | |
| # code 0 if it works. | |
| docker run joplin/server:0.0.0-beta node dist/app.js migrate list | |
| - name: Check HTTP request | |
| run: | | |
| # Need to pass environment variables: | |
| docker run -p 22300:22300 joplin/server:0.0.0-beta node dist/app.js --env dev & | |
| # Wait for server to start | |
| sleep 30 | |
| # Check if status code is correct | |
| # if the actual_status DOES NOT include the expected_status | |
| # it exits the process with code 1 | |
| expected_status="HTTP/1.1 200 OK" | |
| actual_status=$(curl -I -X GET http://localhost:22300/api/ping | head -n 1) | |
| if [[ ! "$actual_status" =~ "$expected_status" ]]; then | |
| echo 'Failed while checking the status code after request to /api/ping' | |
| echo 'expected: ' $expected_status | |
| echo 'actual: ' $actual_status | |
| exit 1; | |
| fi | |
| # Check if the body response is correct | |
| # if the actual_body is different of expected_body exit with code 1 | |
| expected_body='{"status":"ok","message":"Joplin Server is running"}' | |
| actual_body=$(curl http://localhost:22300/api/ping) | |
| if [[ "$actual_body" != "$expected_body" ]]; then | |
| echo 'Failed while checking the body response after request to /api/ping' | |
| exit 1; | |
| fi | |