Merge remote-tracking branch 'origin/master'

Author: mikecao

.github/workflows/cd-cloud.yml

@@ -1,4 +1,4 @@
-name: Create docker images
+name: Create docker images (cloud)
 
 on:
   push:

.github/workflows/cd-manual.yml

@@ -1,50 +1,101 @@
 name: Create docker images
 
-on: [create]
+on:
+  push:
+    branches:
+      - master
+      - main
+      - dev
+    # Publish semver tags as releases.
+    tags: [ 'v*.*.*' ]
+  pull_request:
+    branches:
+      - master
+      - main
+      - dev
+  workflow_dispatch:
 
 jobs:
   build:
     name: Build, push, and deploy
-    if: ${{ startsWith(github.ref, 'refs/tags/v') }}
     runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+      # This is used to complete the identity challenge
+      # with sigstore/fulcio when running outside of PRs.
+      id-token: write
 
     strategy:
       matrix:
         db-type: [postgresql, mysql]
 
     steps:
-      - uses: actions/checkout@v3
-
-      - name: Set env
-        run: |
-          echo "NOW=$(date -u +'%Y-%m-%dT%H:%M:%SZ')" >> $GITHUB_ENV
-          
-      - name: Generate tags
-        id: generate_tags
-        run: |
-          echo "tag_patch=$(echo ${{ matrix.db-type }})-${GITHUB_REF#refs/tags/}" >> $GITHUB_ENV
-          echo "tag_minor=$(echo ${{ matrix.db-type }})-$(echo ${GITHUB_REF#refs/tags/} | cut -d. -f1,2)" >> $GITHUB_ENV
-          echo "tag_major=$(echo ${{ matrix.db-type }})-$(echo ${GITHUB_REF#refs/tags/} | cut -d. -f1)" >> $GITHUB_ENV
-          echo "tag_latest=$(echo ${{ matrix.db-type }})-latest" >> $GITHUB_ENV
-
-      - uses: mr-smithers-excellent/docker-build-push@v6
-        name: Build & push Docker image to ghcr.io for ${{ matrix.db-type }}
+      - uses: actions/checkout@v5
+
+      # Install the cosign tool except on PR
+      # https://github.com/sigstore/cosign-installer
+      - name: Install cosign
+        if: github.event_name != 'pull_request'
+        uses: sigstore/cosign-installer@v3
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+
+      - name: Log into registry docker.io
+        if: github.event_name != 'pull_request' && github.repository == 'umami-software/umami' 
+        uses: docker/login-action@v3
+        with:
+          registry: docker.io
+          username: ${{ secrets.DOCKER_USERNAME }}
+          password: ${{ secrets.DOCKER_PASSWORD }}
+
+      - name: Log into ghcr registry 
+        if: github.event_name != 'pull_request'
+        uses: docker/login-action@v3
         with:
-          image: umami
-          tags: ${{ env.tag_major }}, ${{ env.tag_minor }}, ${{ env.tag_patch }}, ${{ env.tag_latest }}
-          buildArgs: DATABASE_TYPE=${{ matrix.db-type }}
           registry: ghcr.io
-          multiPlatform: true
-          platform: linux/amd64,linux/arm64
           username: ${{ github.actor }}
           password: ${{ secrets.GITHUB_TOKEN }}
 
-      - uses: mr-smithers-excellent/docker-build-push@v6
-        name: Build & push Docker image to docker.io for ${{ matrix.db-type }}
+      - name: Extract Docker metadata
+        id: meta
+        uses: docker/metadata-action@v5
         with:
-          image: umamisoftware/umami
-          tags: ${{ env.tag_major }}, ${{ env.tag_minor }}, ${{ env.tag_patch }}, ${{ env.tag_latest }}
-          buildArgs: DATABASE_TYPE=${{ matrix.db-type }}
-          registry: docker.io
-          username: ${{ secrets.DOCKER_USERNAME }}
-          password: ${{ secrets.DOCKER_PASSWORD }}
+          images: |
+            umamisoftware/umami,enable=${{ github.repository == 'umami-software/umami' }}
+            ghcr.io/${{ github.repository }}
+          flavor: |
+            latest=auto
+            prefix=${{ matrix.db-type }}-
+          tags: |
+            type=ref,event=branch
+            type=ref,event=pr
+
+            # output 1.1.2
+            type=semver,pattern={{version}}
+            # output 1.1
+            type=semver,pattern={{major}}.{{minor}}
+            # output 1
+            type=semver,pattern={{major}}
+
+      - name: Build and push Docker image
+        id: build-and-push
+        uses: docker/build-push-action@v6
+        with:
+          context: .
+          platforms: linux/amd64,linux/arm64
+          build-args: DATABASE_TYPE=${{ matrix.db-type }}
+          push: ${{ github.event_name != 'pull_request' }}
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}
+          cache-from: type=gha
+          cache-to: type=gha,mode=max
+
+      # Sign the resulting Docker image digest except on PRs.
+      - name: Sign the published Docker image
+        if: ${{ github.event_name != 'pull_request' }}
+        env:
+          TAGS: ${{ steps.meta.outputs.tags }}
+          DIGEST: ${{ steps.build-and-push.outputs.digest }}
+        run: echo "${TAGS}" | xargs -I {} cosign sign --yes "{}@${DIGEST}"

.github/workflows/cd.yml

@@ -19,20 +19,26 @@ jobs:
       matrix:
         include:
         - node-version: 18.18
+          pnpm-version: 10
           db-type: postgresql
         - node-version: 18.18
+          pnpm-version: 10
           db-type: mysql
 
     steps:
     - uses: actions/checkout@v4
+    - uses: pnpm/action-setup@v4 # required so that setup-node will work
+      with:
+        version: ${{ matrix.pnpm-version }}
+        run_install: false
     - name: Use Node.js ${{ matrix.node-version }}
       uses: actions/setup-node@v4
       with:
         node-version: ${{ matrix.node-version }}
-        cache: 'yarn'
+        cache: 'pnpm'
       env:
         DATABASE_TYPE: ${{ matrix.db-type }}
-    - run: npm install --global yarn
-    - run: yarn install
-    - run: yarn test
-    - run: yarn build
+    - run: npm install --global pnpm
+    - run: pnpm install
+    - run: pnpm test
+    - run: pnpm build

.github/workflows/ci.yml

@@ -4,6 +4,7 @@
 node_modules
 .pnp
 .pnp.js
+.pnpm-store
 
 # testing
 /coverage

.gitignore

@@ -43,7 +43,7 @@ A detailed getting started guide can be found at [umami.is/docs](https://umami.i
 ```bash
 git clone https://github.com/umami-software/umami.git
 cd umami
-npm install
+pnpm install
 ```
 
 ### Configure Umami
@@ -64,15 +64,15 @@ mysql://username:mypassword@localhost:3306/mydb
 ### Build the Application
 
 ```bash
-npm run build
+pnpm run build
 ```
 
 _The build step will create tables in your database if you are installing for the first time. It will also create a login user with username **admin** and password **umami**._
 
 ### Start the Application
 
 ```bash
-npm run start
+pnpm run start
 ```
 
 _By default, this will launch the application on `http://localhost:3000`. You will need to either [proxy](https://docs.nginx.com/nginx/admin-guide/web-server/reverse-proxy/) requests from your web server or change the [port](https://nextjs.org/docs/api-reference/cli#production) to serve the application directly._
@@ -107,8 +107,8 @@ To get the latest features, simply do a pull, install any new dependencies, and
 
 ```bash
 git pull
-npm install
-npm run build
+pnpm install
+pnpm run build
 ```
 
 To update the Docker image, simply pull the new images and rebuild:

README.md

@@ -1,3 +1,5 @@
+import { uuid } from '../../src/lib/crypto';
+
 describe('Website API tests', () => {
   Cypress.session.clearAllSavedSessions();
 
@@ -65,6 +67,37 @@ describe('Website API tests', () => {
     });
   });
 
+  it('Creates a website with a fixed ID.', () => {
+    cy.fixture('websites').then(data => {
+      const websiteCreate = data.websiteCreate;
+      const fixedId = uuid();
+      cy.request({
+        method: 'POST',
+        url: '/api/websites',
+        headers: {
+          'Content-Type': 'application/json',
+          Authorization: Cypress.env('authorization'),
+        },
+        body: { ...websiteCreate, id: fixedId },
+      }).then(response => {
+        expect(response.status).to.eq(200);
+        expect(response.body).to.have.property('id', fixedId);
+        expect(response.body).to.have.property('name', 'Cypress Website');
+        expect(response.body).to.have.property('domain', 'cypress.com');
+
+        // cleanup
+        cy.request({
+          method: 'DELETE',
+          url: `/api/websites/${fixedId}`,
+          headers: {
+            'Content-Type': 'application/json',
+            Authorization: Cypress.env('authorization'),
+          },
+        });
+      });
+    });
+  });
+
   it('Returns all tracked websites.', () => {
     cy.request({
       method: 'GET',
@@ -116,6 +149,21 @@ describe('Website API tests', () => {
     });
   });
 
+  it('Updates a website with only shareId.', () => {
+    cy.request({
+      method: 'POST',
+      url: `/api/websites/${websiteId}`,
+      headers: {
+        'Content-Type': 'application/json',
+        Authorization: Cypress.env('authorization'),
+      },
+      body: { shareId: 'ABCDEF' },
+    }).then(response => {
+      expect(response.status).to.eq(200);
+      expect(response.body).to.have.property('shareId', 'ABCDEF');
+    });
+  });
+
   it('Resets a website by removing all data related to the website.', () => {
     cy.request({
       method: 'POST',