Merge pull request #1387 from shlinkio/develop

Release 4.3.0

Author: acelaya

.github/workflows/ci-docker-image-build.yml

@@ -0,0 +1,10 @@
+name: Test docker image build
+
+on:
+  pull_request:
+    paths:
+      - 'Dockerfile'
+
+jobs:
+  build-docker-image:
+    uses: shlinkio/github-actions/.github/workflows/docker-image-build-ci.yml@main

.github/workflows/ci.yml

@@ -11,5 +11,5 @@ jobs:
   ci:
     uses: shlinkio/github-actions/.github/workflows/web-app-ci.yml@main
     with:
-      node-version: 20.7
+      node-version: 22.x
       publish-coverage: true

.github/workflows/deploy-preview.yml

@@ -9,19 +9,19 @@ jobs:
     continue-on-error: true
     steps:
       - name: Checkout code
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
           repository: ${{ github.event.pull_request.head.repo.full_name }}
           ref: ${{ github.event.pull_request.head.ref }}
       - name: Use node.js
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
-          node-version: 20.7
+          node-version: 22.x
       - name: Build
         run: |
           npm ci && \
           node ./scripts/set-homepage.cjs /shlink-web-client/${GITHUB_HEAD_REF#refs/heads/} && \
-          npm run build
+          node --run build
       - name: Deploy preview
         uses: shlinkio/[email protected]
         with:

.github/workflows/publish-release.yml

@@ -10,11 +10,11 @@ jobs:
     runs-on: ubuntu-22.04
     steps:
       - name: Checkout code
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       - name: Use node.js
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
-          node-version: 20.7
+          node-version: 22.x
       - name: Generate release assets
         run: npm ci && VERSION=${GITHUB_REF#refs/tags/v} npm run build:dist
       - name: Publish release with assets

.gitignore

@@ -7,9 +7,7 @@
 
 # production
 /build
+/dist
 
 npm-debug.log*
-
-docker-compose.override.yml
-home
 public/servers.json*

CHANGELOG.md

@@ -4,6 +4,34 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org).
 
+## [4.3.0] - 2024-11-30
+### Added
+* [#1360](https://github.com/shlinkio/shlink-web-client/issues/1360) Added ability for server IDs to be generated based on the server name and URL, instead of generating a random UUID.
+
+    This can improve sharing a predefined set of servers cia servers.json, env vars, or simply export and import your servers in some other device, and then be able to share server URLs which continue working.
+
+    All existing servers will keep their generated IDs in existing devices for backwards compatibility, but newly created servers will use the new approach.
+
+* [shlink-web-component#491](https://github.com/shlinkio/shlink-web-component/issues/491) Add support for colors in QR code configurator.
+* [shlink-web-component#515](https://github.com/shlinkio/shlink-web-component/issues/515) Add support for geolocation redirect conditions, when using Shlink 4.3 or newer.
+* [shlink-web-component#514](https://github.com/shlinkio/shlink-web-component/issues/514) Allow filtering short URLs list by domain, when using Shlink 4.3 or newer.
+* [shlink-web-component#520](https://github.com/shlinkio/shlink-web-component/issues/520) Allow navigating from domains list to short URLs list filtered by one domain, when using Shlink 4.3 or newer.
+* [shlink-web-component#517](https://github.com/shlinkio/shlink-web-component/issues/517) Update list of known domains when a short URL is created with a new domain.
+* [shlink-web-component#292](https://github.com/shlinkio/shlink-web-component/issues/292) Add icon in short URLs list indicating if a short URL has redirect rules.
+
+### Changed
+* *Nothing*
+
+### Deprecated
+* *Nothing*
+
+### Removed
+* *Nothing*
+
+### Fixed
+* [shlink-web-component#504](https://github.com/shlinkio/shlink-web-component/issues/504) Fix fallback interval not causing new visits to be loaded.
+
+
 ## [4.2.2] - 2024-10-19
 ### Added
 * *Nothing*

CONTRIBUTING.md

@@ -14,16 +14,13 @@ Because of this, the only actual dependencies are [docker](https://docs.docker.c
 
 The first thing you need to do is fork the repository, and clone it in your local machine.
 
-Then you will have to follow these steps:
+Then simply run `docker compose up` and you will have the project exposed in port `3000` (http://localhost:3000).
 
-* Copy the file `docker-compose.override.yml.dist` by also removing the `dist` extension.
-* Start-up the project by running `docker compose up`.
-
-Once this is finished, you will have the project exposed in port `3000` (http://localhost:3000).
+> The first time the container is created, the project dependencies will be installed and the container may take a bit longer to start.
 
 ## Project structure
 
-This project is a [react](https://reactjs.org/) & [redux](https://redux.js.org/) application, built with [typescript](https://www.typescriptlang.org/), which is distributed as a 100% client-side progressive web application.
+This project is a [react](https://react.dev/) & [redux](https://redux.js.org/) application, built with [typescript](https://www.typescriptlang.org/), which is distributed as a 100% client-side progressive web application.
 
 This is the basic project structure:
 
@@ -39,7 +36,7 @@ shlink-web-client
 ```
 
 * `config`: It contains some configuration scripts, used during testing, linting and building of the project.
-* `public`: Will act as the application document root once built, and contains some static assets (favicons, images, etc).
+* `public`: Will act as the application document root once built, and contains some static assets (favicons, images, etc.).
 * `scripts`: It has some of the CLI scripts used to run tests or building.
 * `src`: Contains the main source code of the application, including both web components, SASS stylesheets and files with logic.
 * `test`: Contains the project tests.
@@ -48,20 +45,19 @@ shlink-web-client
 
 > Note: The `indocker` shell script is a helper used to run commands inside the docker container.
 
-* `./indocker npm run lint`: Checks coding styles are fulfilled, both in JS/TS files as well as in stylesheets.
-* `./indocker npm run lint:js`: Checks coding styles are fulfilled in JS/TS files.
-* `./indocker npm run lint:css`: Checks coding styles are fulfilled in stylesheets.
-* `./indocker npm run lint:js:fix`: Fixes coding styles in JS/TS files.
-* `./indocker npm run lint:css:fix`: Fixes coding styles in stylesheets.
-* `./indocker npm run test`: Runs unit tests with Jest.
-* `./indocker npm run mutate`: Runs mutation tests with StrykerJS (this command can be very slow).
+* `./indocker node --run lint`: Checks coding styles are fulfilled, both in JS/TS files and in stylesheets.
+* `./indocker node --run lint:js`: Checks coding styles are fulfilled in JS/TS files.
+* `./indocker node --run lint:css`: Checks coding styles are fulfilled in stylesheets.
+* `./indocker node --run lint:js:fix`: Fixes coding styles in JS/TS files.
+* `./indocker node --run lint:css:fix`: Fixes coding styles in stylesheets.
+* `./indocker node --run test`: Runs unit tests with Jest.
 
 ## Building the project
 
 The source code in this project cannot be run directly in a web browser, you need to build it first.
 
-* `./indocker npm run build`: Builds the project using a combination of `webpack`, `babel` and `tsc`, generating the final static files. The content is placed in the `build` folder, which is automatically created if it does not exist.
-* `./indocker npm run serve:build`: Serves the static files inside the `build` folder in port 5000 (http://localhost:5000). Useful to test the content built with previous command.
+* `./indocker node --run run build`: Builds the project for production using [vite](https://vite.dev/), generating the final static files. The content is placed in the `build` folder, which is automatically created if it does not exist.
+* `./indocker node --run run preview`: Serves the static files inside the `build` folder in a random port. Useful to test the content built with previous command.
 
 ## Pull request process
 

Dockerfile

@@ -1,8 +1,8 @@
-FROM node:23.0-alpine as node
+FROM node:23.3-alpine AS node
 COPY . /shlink-web-client
 ARG VERSION="latest"
-ENV VERSION ${VERSION}
-RUN cd /shlink-web-client && npm ci && npm run build
+ENV VERSION=${VERSION}
+RUN cd /shlink-web-client && npm ci && node --run build
 
 FROM nginxinc/nginx-unprivileged:1.27-alpine
 ARG UID=101

README.md

@@ -7,7 +7,7 @@
 [![GitHub license](https://img.shields.io/github/license/shlinkio/shlink-web-client.svg?style=flat-square)](https://github.com/shlinkio/shlink-web-client/blob/main/LICENSE)
 
 [![Mastodon](https://img.shields.io/mastodon/follow/109329425426175098?color=%236364ff&domain=https%3A%2F%2Ffosstodon.org&label=follow&logo=mastodon&logoColor=white&style=flat-square)](https://fosstodon.org/@shlinkio)
-[![Bluesky](https://img.shields.io/badge/follow-shlinkio-0285FF.svg?style=flat-square&logo=bluesky&logoColor=white)](https://bsky.app/profile/shlinkio.bsky.social)
+[![Bluesky](https://img.shields.io/badge/follow-shlinkio-0285FF.svg?style=flat-square&logo=bluesky&logoColor=white)](https://bsky.app/profile/shlink.io)
 [![Paypal Donate](https://img.shields.io/badge/Donate-paypal-blue.svg?style=flat-square&logo=paypal&colorA=cccccc)](https://slnk.to/donate)
 
 A ReactJS-based progressive web application for [Shlink](https://shlink.io).

dist/.gitignore

@@ -1,7 +1,8 @@
 services:
   shlink_web_client_node:
     container_name: shlink_web_client_node
-    image: node:22.3-alpine
+    user: 1000:1000 # With this, files created via `indocker` script will belong to the host user
+    image: node:22.10-alpine
     command: /bin/sh -c "cd /home/shlink/www && npm install && npm run start"
     volumes:
       - ./:/home/shlink/www