Skip to content

Commit

Permalink
Change 'master' branch to 'main' across the project
Browse files Browse the repository at this point in the history
  • Loading branch information
ehfd committed Sep 6, 2023
1 parent 587ec41 commit 3889685
Show file tree
Hide file tree
Showing 9 changed files with 21 additions and 21 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/build_and_publish_all_images.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ name: Build & publish all images
on:
push:
branches:
- master
- main
paths:
- ".github/workflows/build_and_publish_all_images.yaml"
- ".github/actions/build_and_publish_image/action.yaml"
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/build_and_publish_changed_images.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@ name: Build & publish changed images
on:
push:
branches:
- master
- main
pull_request:
branches: master
branches: main
paths-ignore:
- README.md
- .devconttainer/**
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/publish_release.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ jobs:
RELEASE_VERSION: ${{ github.ref_name }}
run: |
# If ref name does not match semver, default to 0.0.0.
# This happens when running from a branch name like master.
# This happens when running from a branch name like main.
if [[ ${RELEASE_VERSION} =~ ^v[0-9]+\.[0-9]+\.[0-9]+ ]]; then
echo semver=${RELEASE_VERSION/v/} >> $GITHUB_OUTPUT
else
Expand Down
6 changes: 3 additions & 3 deletions Dockerfile.example
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@
# Supported base images: ubuntu:22.04, ubuntu:20.04
ARG UBUNTU_RELEASE=22.04
ARG GSTREAMER_BASE_IMAGE=ghcr.io/selkies-project/selkies-gstreamer/gstreamer
ARG GSTREAMER_BASE_IMAGE_RELEASE=master
ARG PY_BUILD_IMAGE=ghcr.io/selkies-project/selkies-gstreamer/py-build:master
ARG WEB_IMAGE=ghcr.io/selkies-project/selkies-gstreamer/gst-web:master
ARG GSTREAMER_BASE_IMAGE_RELEASE=main
ARG PY_BUILD_IMAGE=ghcr.io/selkies-project/selkies-gstreamer/py-build:main
ARG WEB_IMAGE=ghcr.io/selkies-project/selkies-gstreamer/gst-web:main
FROM ${GSTREAMER_BASE_IMAGE}:${GSTREAMER_BASE_IMAGE_RELEASE}-ubuntu${UBUNTU_RELEASE} as selkies-gstreamer
FROM ${PY_BUILD_IMAGE} as selkies-build
FROM ${WEB_IMAGE} as selkies-web
Expand Down
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ Example Google Compute Engine/Google Kubernetes Engine deployment configurations

An example image [`ghcr.io/selkies-project/selkies-gstreamer/gst-py-example`](https://github.com/selkies-project/selkies-gstreamer/pkgs/container/selkies-gstreamer%2Fgst-py-example) from the base [example Dockerfile](./Dockerfile.example) is available.

Run the Docker container built from the [`Dockerfile.example`](./Dockerfile.example), then connect to port **8080** of your Docker host to access the web interface (**replace `latest` to `master` for the development build instead of the release build, and choose the Ubuntu versions `20.04`, or `22.04`**):
Run the Docker container built from the [`Dockerfile.example`](./Dockerfile.example), then connect to port **8080** of your Docker host to access the web interface (**replace `latest` to `main` for the development build instead of the release build, and choose the Ubuntu versions `20.04`, or `22.04`**):

```bash
docker run --name selkies -it --rm -p 8080:8080 ghcr.io/selkies-project/selkies-gstreamer/gst-py-example:latest-ubuntu20.04
Expand Down Expand Up @@ -138,7 +138,7 @@ selkies-gstreamer &

### Install the latest build on a standalone machine or cloud instance

Docker (or an equivalent) is required if you are to use builds from the latest commit. Refer to the above section for more granular informations. This method can be also used when building a new container image with the `FROM [--platform=<platform>] <image> [AS <name>]` and `COPY [--from=<name>] <src_path> <dest_path>` instruction instead of using the `docker` CLI. **Change `master` to `latest` if you want the latest release version instead of the latest development version.**
Docker (or an equivalent) is required if you are to use builds from the latest commit. Refer to the above section for more granular informations. This method can be also used when building a new container image with the `FROM [--platform=<platform>] <image> [AS <name>]` and `COPY [--from=<name>] <src_path> <dest_path>` instruction instead of using the `docker` CLI. **Change `main` to `latest` if you want the latest release version instead of the latest development version.**

**NOTE: You will need to use an external STUN/TURN server capable of `srflx` or `relay` type ICE connections if both your server and client have ports closed or are under a restrictive firewall. Either open the TCP and UDP port ranges 49152-65535 of your server, or follow the instructions from [Using a TURN server](#using-a-turn-server) in order to make the container work using an external TURN server.**

Expand All @@ -161,8 +161,8 @@ If using supported NVIDIA GPUs, install NVENC (bundled with the GPU driver) and
2. Copy the GStreamer build from the container image and move it to `/opt/gstreamer` (change the OS version `UBUNTU_RELEASE` as needed):

```bash
docker pull ghcr.io/selkies-project/selkies-gstreamer/gstreamer:master-ubuntu${UBUNTU_RELEASE}
docker create --name gstreamer ghcr.io/selkies-project/selkies-gstreamer/gstreamer:master-ubuntu${UBUNTU_RELEASE}
docker pull ghcr.io/selkies-project/selkies-gstreamer/gstreamer:main-ubuntu${UBUNTU_RELEASE}
docker create --name gstreamer ghcr.io/selkies-project/selkies-gstreamer/gstreamer:main-ubuntu${UBUNTU_RELEASE}
sudo docker cp gstreamer:/opt/gstreamer /opt/gstreamer
docker rm gstreamer
```
Expand All @@ -172,8 +172,8 @@ This will install the GStreamer components to the default directory of `/opt/gst
3. Copy the Python Wheel file from the container image and install it:

```bash
docker pull ghcr.io/selkies-project/selkies-gstreamer/py-build:master
docker create --name selkies-py ghcr.io/selkies-project/selkies-gstreamer/py-build:master
docker pull ghcr.io/selkies-project/selkies-gstreamer/py-build:main
docker create --name selkies-py ghcr.io/selkies-project/selkies-gstreamer/py-build:main
docker cp selkies-py:/opt/pypi/dist/selkies_gstreamer-0.0.0.dev0-py3-none-any.whl /tmp/selkies_gstreamer-0.0.0.dev0-py3-none-any.whl
docker rm selkies-py
sudo pip3 install /tmp/selkies_gstreamer-0.0.0.dev0-py3-none-any.whl
Expand All @@ -183,8 +183,8 @@ rm -f /tmp/selkies_gstreamer-0.0.0.dev0-py3-none-any.whl
4. Install the HTML5 components to the container image:

```bash
docker pull ghcr.io/selkies-project/selkies-gstreamer/gst-web:master
docker create --name gst-web ghcr.io/selkies-project/selkies-gstreamer/gst-web:master
docker pull ghcr.io/selkies-project/selkies-gstreamer/gst-web:main
docker create --name gst-web ghcr.io/selkies-project/selkies-gstreamer/gst-web:main
sudo docker cp gst-web:/usr/share/nginx/html /opt/gst-web
docker rm gst-web
```
Expand Down
4 changes: 2 additions & 2 deletions addons/gst-web/src/signalling.js
Original file line number Diff line number Diff line change
Expand Up @@ -36,13 +36,13 @@
class WebRTCDemoSignalling {
/**
* Interface to WebRTC demo signalling server.
* Protocol: https://github.com/centricular/gstwebrtc-demos/blob/master/signalling/Protocol.md
* Protocol: https://github.com/GStreamer/gstreamer/blob/main/subprojects/gst-examples/webrtc/signalling/Protocol.md
*
* @constructor
* @param {URL} [server]
* The URL object of the signalling server to connect to, created with `new URL()`.
* Signalling implementation is here:
* https://github.com/centricular/gstwebrtc-demos/tree/master/signalling
* https://github.com/GStreamer/gstreamer/tree/main/subprojects/gst-examples/webrtc/signalling
* @param {number} [peer_id]
* The peer ID established during signalling that the sending peer (server) will connect to.
* This can be anything, but must match what the server will attempt to connect to.
Expand Down
2 changes: 1 addition & 1 deletion docker-compose.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ services:
# 2. export GSTREAMER_BASE_IMAGE=gstreamer
# 3. docker-compose build test
GSTREAMER_BASE_IMAGE: ${GSTREAMER_BASE_IMAGE:-ghcr.io/selkies-project/selkies-gstreamer/gstreamer}
GSTREAMER_BASE_IMAGE_RELEASE: ${GSTREAMER_BASE_IMAGE_RELEASE:-master}
GSTREAMER_BASE_IMAGE_RELEASE: ${GSTREAMER_BASE_IMAGE_RELEASE:-main}

PY_BUILD_IMAGE: selkies-gstreamer-py-build:latest
WEB_IMAGE: gst-web:latest
Expand Down
4 changes: 2 additions & 2 deletions infra/gke/manifests/coturn/kustomization.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ resources:
images:
- name: ghcr.io/selkies-project/selkies-gstreamer/coturn
newName: ghcr.io/selkies-project/selkies-gstreamer/coturn
newTag: master
newTag: main
- name: ghcr.io/selkies-project/selkies-gstreamer/coturn-web
newName: ghcr.io/selkies-project/selkies-gstreamer/coturn-web
newTag: master
newTag: main
2 changes: 1 addition & 1 deletion src/selkies_gstreamer/webrtc_signalling.py
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@
"""Signalling API for Gstreamer WebRTC demo
Interfaces with signalling server found at:
https://github.com/centricular/gstwebrtc-demos/tree/master/signalling
https://github.com/GStreamer/gstreamer/tree/main/subprojects/gst-examples/webrtc/signalling
Usage example:
from webrtc_signalling import WebRTCSignalling
Expand Down

0 comments on commit 3889685

Please sign in to comment.