Skip to content

Commit

Permalink
3197: Updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
tuj committed Dec 9, 2024
1 parent 1e7f321 commit 9a9fd6a
Showing 1 changed file with 12 additions and 16 deletions.
28 changes: 12 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,21 +7,17 @@ See [https://github.com/os2display/display-docs/blob/main/templates.md](https://

When creating a release the config files should be built with a tag in the config routes.

Follow the instructions below.

Replace `<TAG>` with the given tag.

```shell
# Create the release branch: release/<TAG>

# Build the js and config files with tags in main config files.
docker compose run --rm --env DEPLOYMENT_BUILD_TAG=<TAG> node yarn build

# Update CHANGELOG with the new tag.
# When ready merge release branch in main.
# Tag the release in main
# Merge main in develop
```
Follow the instructions below. Replace `<TAG>` with the given tag.

1. Create the release branch: release/<TAG>
2. Build the js and config files with tags in main config files.
```shell
docker compose run --rm --env DEPLOYMENT_BUILD_TAG=<TAG> node yarn build
```
3. Update CHANGELOG with the new tag.
4. When ready merge release branch in main.
5. Tag the release in main
6. Merge main in develop

## Develop

Expand Down Expand Up @@ -109,7 +105,7 @@ Override "main" base URL only:
docker compose run --rm --env DEPLOYMENT_BUILD_BASE_URL_MAIN="http://$(docker compose port nginx 80)/build/" node yarn build
```

The default behavoir is equivalent to
The default behavior is equivalent to

```sh
docker compose run --rm \
Expand Down

0 comments on commit 9a9fd6a

Please sign in to comment.