{
#logger: ILogger;
peer: RTCPeerConnection
diff --git a/packages/millicast-sdk/src/index.ts b/packages/millicast-sdk/src/index.ts
index a9e6a535..694b89bc 100644
--- a/packages/millicast-sdk/src/index.ts
+++ b/packages/millicast-sdk/src/index.ts
@@ -1,5 +1,5 @@
-import Logger from './Logger';
-export { Logger };
+import Logger, { LogLevel } from './Logger';
+export { Logger, LogLevel };
/** @hidden */
export * as Urls from './urls';
@@ -9,6 +9,9 @@ export * from './types/events';
export * from './types/PeerConnection.types';
export { PeerConnection } from './PeerConnection';
+export * from './types/stats.types';
+export * from './PeerConnectionStats';
+
export * from './types/Signaling.types';
export * from './Signaling';
diff --git a/packages/millicast-sdk/src/types/events.ts b/packages/millicast-sdk/src/types/events.ts
index 49b4d4c2..c2595417 100644
--- a/packages/millicast-sdk/src/types/events.ts
+++ b/packages/millicast-sdk/src/types/events.ts
@@ -2,6 +2,7 @@ import { BaseWebRTC } from '../utils/BaseWebRTC';
import { Publisher } from '../Publisher';
import { Viewer } from '../Viewer';
import { PeerConnection } from '../PeerConnection';
+import { PeerConnectionStats } from '../PeerConnectionStats';
import { Signaling } from '../Signaling';
import TransactionManager from 'transaction-manager';
import { EncryptionParameters, TrackInfo } from './Viewer.types';
@@ -9,7 +10,7 @@ import { EmittedEvents } from '../utils/TypedEventEmitter';
import { ConnectionStats } from './stats.types';
/**
- * Events triggered by the {@link PeerConnectionStats} classe.
+ * Events triggered by the {@link PeerConnectionStats} class.
*/
export interface PeerConnectionStatsEvents extends EmittedEvents {
/** Triggered when a new track is available. */
@@ -17,7 +18,7 @@ export interface PeerConnectionStatsEvents extends EmittedEvents {
}
/**
- * Events triggered by the {@link PeerConnection} classe.
+ * Events triggered by the {@link PeerConnection} class.
*/
export interface PeerConnectionEvents extends PeerConnectionStatsEvents, EmittedEvents {
/** Triggered when a new track is available. */
@@ -28,7 +29,7 @@ export interface PeerConnectionEvents extends PeerConnectionStatsEvents, Emitted
}
/**
- * Events triggered by the {@link Signaling} classe.
+ * Events triggered by the {@link Signaling} class.
*/
export interface SignalingEvents extends EmittedEvents {
/**
From 33bc7855fe0f4acb81a831650edd3080114f9f1d Mon Sep 17 00:00:00 2001
From: Fabien Lavocat <4154532+FabienLavocat@users.noreply.github.com>
Date: Tue, 8 Jul 2025 17:18:03 -0700
Subject: [PATCH 07/22] Update Github Actions
Signed-off-by: Fabien Lavocat <4154532+FabienLavocat@users.noreply.github.com>
---
.../CODE_OF_CONDUCT.md | 76 -
.../CONTRIBUTING.md | 54 -
.../github-pages-deploy-action-4.6.3/LICENSE | 21 -
.../README.md | 334 --
.../SECURITY.md | 14 -
.../__tests__/env.js | 2 -
.../__tests__/execute.test.ts | 40 -
.../__tests__/git.test.ts | 473 ---
.../__tests__/main.test.ts | 99 -
.../__tests__/ssh.test.ts | 141 -
.../__tests__/util.test.ts | 349 --
.../__tests__/worktree.error.test.ts | 35 -
.../__tests__/worktree.test.ts | 220 --
.../action.yml | 95 -
.../eslint.config.mjs | 72 -
.../integration/.nojekyll | 1 -
.../integration/image.jpg | Bin 1237484 -> 0 bytes
.../integration/index.html | 33 -
.../jest.config.js | 14 -
.../lib/constants.d.ts | 96 -
.../lib/constants.js | 122 -
.../lib/execute.d.ts | 17 -
.../lib/execute.js | 57 -
.../lib/git.d.ts | 9 -
.../lib/git.js | 217 --
.../lib/lib.d.ts | 6 -
.../lib/lib.js | 87 -
.../lib/main.d.ts | 1 -
.../lib/main.js | 9 -
.../lib/ssh.d.ts | 5 -
.../lib/ssh.js | 56 -
.../lib/util.d.ts | 34 -
.../lib/util.js | 102 -
.../lib/worktree.d.ts | 34 -
.../lib/worktree.js | 100 -
.../package.json | 61 -
.../src/constants.ts | 177 -
.../src/execute.ts | 58 -
.../src/git.ts | 379 --
.../src/lib.ts | 92 -
.../src/main.ts | 5 -
.../src/ssh.ts | 57 -
.../src/util.ts | 142 -
.../src/worktree.ts | 140 -
.../tsconfig.json | 12 -
.../tsconfig.lint.json | 7 -
.../yarn.lock | 3381 -----------------
.github/actions/setup-install/action.yml | 16 -
.github/workflows/check-tests.yml | 12 +-
.github/workflows/codeql-analysis.yml | 73 +
.github/workflows/new-release.yml | 42 +-
.github/workflows/rc-release.yml | 20 +-
52 files changed, 118 insertions(+), 7581 deletions(-)
delete mode 100644 .github/actions/github-pages-deploy-action-4.6.3/CODE_OF_CONDUCT.md
delete mode 100644 .github/actions/github-pages-deploy-action-4.6.3/CONTRIBUTING.md
delete mode 100644 .github/actions/github-pages-deploy-action-4.6.3/LICENSE
delete mode 100644 .github/actions/github-pages-deploy-action-4.6.3/README.md
delete mode 100644 .github/actions/github-pages-deploy-action-4.6.3/SECURITY.md
delete mode 100644 .github/actions/github-pages-deploy-action-4.6.3/__tests__/env.js
delete mode 100644 .github/actions/github-pages-deploy-action-4.6.3/__tests__/execute.test.ts
delete mode 100644 .github/actions/github-pages-deploy-action-4.6.3/__tests__/git.test.ts
delete mode 100644 .github/actions/github-pages-deploy-action-4.6.3/__tests__/main.test.ts
delete mode 100644 .github/actions/github-pages-deploy-action-4.6.3/__tests__/ssh.test.ts
delete mode 100644 .github/actions/github-pages-deploy-action-4.6.3/__tests__/util.test.ts
delete mode 100644 .github/actions/github-pages-deploy-action-4.6.3/__tests__/worktree.error.test.ts
delete mode 100644 .github/actions/github-pages-deploy-action-4.6.3/__tests__/worktree.test.ts
delete mode 100644 .github/actions/github-pages-deploy-action-4.6.3/action.yml
delete mode 100644 .github/actions/github-pages-deploy-action-4.6.3/eslint.config.mjs
delete mode 100644 .github/actions/github-pages-deploy-action-4.6.3/integration/.nojekyll
delete mode 100644 .github/actions/github-pages-deploy-action-4.6.3/integration/image.jpg
delete mode 100644 .github/actions/github-pages-deploy-action-4.6.3/integration/index.html
delete mode 100644 .github/actions/github-pages-deploy-action-4.6.3/jest.config.js
delete mode 100644 .github/actions/github-pages-deploy-action-4.6.3/lib/constants.d.ts
delete mode 100644 .github/actions/github-pages-deploy-action-4.6.3/lib/constants.js
delete mode 100644 .github/actions/github-pages-deploy-action-4.6.3/lib/execute.d.ts
delete mode 100644 .github/actions/github-pages-deploy-action-4.6.3/lib/execute.js
delete mode 100644 .github/actions/github-pages-deploy-action-4.6.3/lib/git.d.ts
delete mode 100644 .github/actions/github-pages-deploy-action-4.6.3/lib/git.js
delete mode 100644 .github/actions/github-pages-deploy-action-4.6.3/lib/lib.d.ts
delete mode 100644 .github/actions/github-pages-deploy-action-4.6.3/lib/lib.js
delete mode 100644 .github/actions/github-pages-deploy-action-4.6.3/lib/main.d.ts
delete mode 100644 .github/actions/github-pages-deploy-action-4.6.3/lib/main.js
delete mode 100644 .github/actions/github-pages-deploy-action-4.6.3/lib/ssh.d.ts
delete mode 100644 .github/actions/github-pages-deploy-action-4.6.3/lib/ssh.js
delete mode 100644 .github/actions/github-pages-deploy-action-4.6.3/lib/util.d.ts
delete mode 100644 .github/actions/github-pages-deploy-action-4.6.3/lib/util.js
delete mode 100644 .github/actions/github-pages-deploy-action-4.6.3/lib/worktree.d.ts
delete mode 100644 .github/actions/github-pages-deploy-action-4.6.3/lib/worktree.js
delete mode 100644 .github/actions/github-pages-deploy-action-4.6.3/package.json
delete mode 100644 .github/actions/github-pages-deploy-action-4.6.3/src/constants.ts
delete mode 100644 .github/actions/github-pages-deploy-action-4.6.3/src/execute.ts
delete mode 100644 .github/actions/github-pages-deploy-action-4.6.3/src/git.ts
delete mode 100644 .github/actions/github-pages-deploy-action-4.6.3/src/lib.ts
delete mode 100644 .github/actions/github-pages-deploy-action-4.6.3/src/main.ts
delete mode 100644 .github/actions/github-pages-deploy-action-4.6.3/src/ssh.ts
delete mode 100644 .github/actions/github-pages-deploy-action-4.6.3/src/util.ts
delete mode 100644 .github/actions/github-pages-deploy-action-4.6.3/src/worktree.ts
delete mode 100644 .github/actions/github-pages-deploy-action-4.6.3/tsconfig.json
delete mode 100644 .github/actions/github-pages-deploy-action-4.6.3/tsconfig.lint.json
delete mode 100644 .github/actions/github-pages-deploy-action-4.6.3/yarn.lock
delete mode 100644 .github/actions/setup-install/action.yml
create mode 100644 .github/workflows/codeql-analysis.yml
diff --git a/.github/actions/github-pages-deploy-action-4.6.3/CODE_OF_CONDUCT.md b/.github/actions/github-pages-deploy-action-4.6.3/CODE_OF_CONDUCT.md
deleted file mode 100644
index c1b7046a..00000000
--- a/.github/actions/github-pages-deploy-action-4.6.3/CODE_OF_CONDUCT.md
+++ /dev/null
@@ -1,76 +0,0 @@
-# Contributor Covenant Code of Conduct
-
-## Our Pledge
-
-In the interest of fostering an open and welcoming environment, we as
-contributors and maintainers pledge to making participation in our project and
-our community a harassment-free experience for everyone, regardless of age, body
-size, disability, ethnicity, sex characteristics, gender identity and expression,
-level of experience, education, socio-economic status, nationality, personal
-appearance, race, religion, or sexual identity and orientation.
-
-## Our Standards
-
-Examples of behavior that contributes to creating a positive environment
-include:
-
-- Using welcoming and inclusive language
-- Being respectful of differing viewpoints and experiences
-- Gracefully accepting constructive criticism
-- Focusing on what is best for the community
-- Showing empathy towards other community members
-
-Examples of unacceptable behavior by participants include:
-
-- The use of sexualized language or imagery and unwelcome sexual attention or
- advances
-- Trolling, insulting/derogatory comments, and personal or political attacks
-- Public or private harassment
-- Publishing others' private information, such as a physical or electronic
- address, without explicit permission
-- Other conduct which could reasonably be considered inappropriate in a
- professional setting
-
-## Our Responsibilities
-
-Project maintainers are responsible for clarifying the standards of acceptable
-behavior and are expected to take appropriate and fair corrective action in
-response to any instances of unacceptable behavior.
-
-Project maintainers have the right and responsibility to remove, edit, or
-reject comments, commits, code, wiki edits, issues, and other contributions
-that are not aligned to this Code of Conduct, or to ban temporarily or
-permanently any contributor for other behaviors that they deem inappropriate,
-threatening, offensive, or harmful.
-
-## Scope
-
-This Code of Conduct applies both within project spaces and in public spaces
-when an individual is representing the project or its community. Examples of
-representing a project or community include using an official project e-mail
-address, posting via an official social media account, or acting as an appointed
-representative at an online or offline event. Representation of a project may be
-further defined and clarified by project maintainers.
-
-## Enforcement
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting the project team at iam@jamesiv.es. All
-complaints will be reviewed and investigated and will result in a response that
-is deemed necessary and appropriate to the circumstances. The project team is
-obligated to maintain confidentiality with regard to the reporter of an incident.
-Further details of specific enforcement policies may be posted separately.
-
-Project maintainers who do not follow or enforce the Code of Conduct in good
-faith may face temporary or permanent repercussions as determined by other
-members of the project's leadership.
-
-## Attribution
-
-This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
-available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
-
-[homepage]: https://www.contributor-covenant.org
-
-For answers to common questions about this code of conduct, see
-https://www.contributor-covenant.org/faq
diff --git a/.github/actions/github-pages-deploy-action-4.6.3/CONTRIBUTING.md b/.github/actions/github-pages-deploy-action-4.6.3/CONTRIBUTING.md
deleted file mode 100644
index c5f7e131..00000000
--- a/.github/actions/github-pages-deploy-action-4.6.3/CONTRIBUTING.md
+++ /dev/null
@@ -1,54 +0,0 @@
-# Contributing ✏️
-
-When contributing to this repository, please first discuss the change you wish to make via issue,
-[email, or any other method with the owners of this repository](https://jamesiv.es) before making a change. If you are planning to work on an issue that already exists please let us know before writing any code incase it's already in flight!
-
-## Before Making a Pull Request 🎒
-
-1. Ensure that you've tested your feature/change yourself. As the primary focus of this project is deployment, providing a link to a deployed repository using your branch is preferred. You can reference the forked action using your GitHub username, for example `yourname/github-pages-deplpy-action@dev`.
-2. Ensure your change passes all of the integration tests.
-3. Make sure you update the README if you've made a change that requires documentation.
-4. When making a pull request, highlight any areas that may cause a breaking change so the maintainer can update the version number accordingly on the GitHub marketplace and package registries.
-5. Make sure you've linted and formatted your code. You can do this by running `yarn lint` and `yarn lint:format`.
-6. Fix or add any tests where applicable. You can run `yarn test` to run the suite. As this action is small in scope it's important that a high level of test coverage is maintained. All tests are written using [Jest](https://jestjs.io/).
-7. As this package is written in [TypeScript](https://www.typescriptlang.org/) please ensure all typing is accurate and the action compiles correctly by running `yarn build`.
-
-## Deploying 🚚
-
-In order to deploy and test your own fork of this action, you must commit the `node_modules` dependencies. Be sure to run `nvm use` before installing any dependencies. You can learn more about nvm [here](https://github.com/nvm-sh/nvm/blob/master/README.md).
-
-To do this you can follow the instructions below:
-
-Install the project:
-
-```
-yarn install
-```
-
-Comment out the following in distribution branches:
-
-```
-# node_modules/
-# lib/
-```
-
-Build the project:
-
-```
-yarn build
-```
-
-Commit:
-
-```
-$ git checkout -b branchnamehere
-$ git commit -a -m "prod dependencies"
-```
-
-The `node_modules` and `lib` folders should _not_ be included when making a pull request. These are only required for GitHub Actions when it consumes the distribution branch, the `dev` branch of the project should be free from any dependencies or lib files.
-
-## Resources 💡
-
-- [TypeScript](https://www.typescriptlang.org/)
-- [Jest](https://jestjs.io/)
-- [GitHub Actions Documentation](https://help.github.com/en/actions)
diff --git a/.github/actions/github-pages-deploy-action-4.6.3/LICENSE b/.github/actions/github-pages-deploy-action-4.6.3/LICENSE
deleted file mode 100644
index 4fef0fdd..00000000
--- a/.github/actions/github-pages-deploy-action-4.6.3/LICENSE
+++ /dev/null
@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2021 James Ives
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
diff --git a/.github/actions/github-pages-deploy-action-4.6.3/README.md b/.github/actions/github-pages-deploy-action-4.6.3/README.md
deleted file mode 100644
index e2344155..00000000
--- a/.github/actions/github-pages-deploy-action-4.6.3/README.md
+++ /dev/null
@@ -1,334 +0,0 @@
-
-
- 
-
-
-
-
- GitHub Pages Deploy Action :rocket:
-
-
-
-
- 
-
-
-
- 
-
-
-
- 
-
-
-
- 
-
-
-
- 
-
-
-
-
- Automatically deploy your project to GitHub Pages with GitHub Actions. This action can be configured to push your production-ready code into any branch you'd like, including gh-pages and docs. It can also handle cross repository deployments and works with GitHub Enterprise too.
-
-
-
- 
-
-
-
-Maintenance of this project is made possible by all the contributors and sponsors. If you'd like to sponsor this project and have your avatar or company logo appear below click here. 💖
-
-
-
-
-
-
-
-
-
-
-## Getting Started :airplane:
-
-You can include the action in your workflow to trigger on any event that [GitHub actions supports](https://help.github.com/en/articles/events-that-trigger-workflows). If the remote branch that you wish to deploy to doesn't already exist the action will create it for you. Your workflow will also need to include the `actions/checkout` step before this workflow runs in order for the deployment to work. If you intend to make multiple deployments in quick succession [you may need to leverage the concurrency parameter in your workflow](https://docs.github.com/en/actions/learn-github-actions/workflow-syntax-for-github-actions#concurrency) to prevent overlaps.
-
-You can view an example of this below.
-
-```yml
-name: Build and Deploy
-on: [push]
-permissions:
- contents: write
-jobs:
- build-and-deploy:
- concurrency: ci-${{ github.ref }} # Recommended if you intend to make multiple deployments in quick succession.
- runs-on: ubuntu-latest
- steps:
- - name: Checkout 🛎️
- uses: actions/checkout@v4
-
- - name: Install and Build 🔧 # This example project is built using npm and outputs the result to the 'build' folder. Replace with the commands required to build your project, or remove this step entirely if your site is pre-built.
- run: |
- npm ci
- npm run build
-
- - name: Deploy 🚀
- uses: JamesIves/github-pages-deploy-action@v4
- with:
- folder: build # The folder the action should deploy.
-```
-
-> [!NOTE]
-> You must configure your repository to deploy from the branch you push to. To do this, go to your repository settings, click on `Pages`, and choose `Deploy from a Branch` from the `Source` dropdown. From there select the branch you supplied to the action. In most cases this will be `gh-pages` as that's the default.
-
-If you'd like to make it so the workflow only triggers on push events to specific branches then you can modify the `on` section.
-
-```yml
-on:
- push:
- branches:
- - main
-```
-
-> [!WARNING]
-> If you do not supply the action with an access token or an SSH key, you must access your repositories settings and provide `Read and Write Permissions` to the provided `GITHUB_TOKEN`, otherwise you'll potentially run into permission issues. Alternatively you can set the following in your workflow file to grant the action the permissions it needs.
-
-```yml
-permissions:
- contents: write
-```
-
-## Configuration 📁
-
-The `with` portion of the workflow **must** be configured before the action will work. You can add these in the `with` section found in the examples above. Any `secrets` must be referenced using the bracket syntax and stored in the GitHub repository's `Settings/Secrets` menu. You can learn more about setting environment variables with GitHub actions [here](https://help.github.com/en/actions/configuring-and-managing-workflows/creating-and-storing-encrypted-secrets#creating-encrypted-secrets).
-
-#### Required Setup
-
-The following options must be configured in order to make a deployment.
-
-| Key | Value Information | Type | Required |
-| -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------ | -------- |
-| `folder` | The folder in your repository that you want to deploy. If your build script compiles into a directory named `build` you'd put it here. If you wish to deploy the root directory you can place a `.` here. You can also utilize absolute file paths by prepending `~` to your folder path. Note that any files/folders matching `.gitignore` entries will not be deployed. Some tools auto-generate a `.gitignore` file for build output. | `with` | **Yes** |
-
-By default, the action does not need any token configuration and uses the provided repository scoped GitHub token to make the deployment. If you require more customization you can modify the deployment type using the following options.
-
-| Key | Value Information | Type | Required |
-| --------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------ | -------- |
-| `token` | This option defaults to the repository scoped GitHub Token. However, if you need more permissions for things such as deploying to another repository, you can add a Personal Access Token (PAT) here. This should be stored in the `secrets / with` menu **as a secret**. We recommend using a service account with the least permissions necessary and recommend when generating a new PAT that you select the least permission scopes necessary. [Learn more about creating and using encrypted secrets here.](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/creating-and-using-encrypted-secrets) | `with` | **No** |
-| `ssh-key` | You can configure the action to deploy using SSH by setting this option to a private SSH key stored **as a secret**. It can also be set to `true` to use an existing SSH client configuration. For more detailed information on how to add your public/private ssh key pair please refer to the [Using a Deploy Key section of this README](https://github.com/JamesIves/github-pages-deploy-action/tree/dev#using-an-ssh-deploy-key-). | `with` | **No** |
-
-#### Optional Choices
-
-| Key | Value Information | Type | Required |
-| ------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------ | -------- |
-| `branch` | This is the branch you wish to deploy to, for example, `gh-pages` or `docs`. Defaults to `gh-pages`. | `with` | **No** |
-| `git-config-name` | Allows you to customize the name that is attached to the git config which is used when pushing the deployment commits. If this is not included it will use the name in the GitHub context, followed by the name of the action. | `with` | **No** |
-| `git-config-email` | Allows you to customize the email that is attached to the git config which is used when pushing the deployment commits. If this is not included it will use the email in the GitHub context, followed by a generic noreply GitHub email. You can include `<>` for the value if you wish to omit this field altogether and push the commits without an email. | `with` | **No** |
-| `repository-name` | Allows you to specify a different repository path so long as you have permissions to push to it. This should be formatted like so: `JamesIves/github-pages-deploy-action`. You'll need to use a PAT in the `token` input for this configuration option to work properly. | `with` | **No** |
-| `target-folder` | If you'd like to push the contents of the deployment folder into a specific directory on the deployment branch you can specify it here. | `with` | **No** |
-| `commit-message` | If you need to customize the commit message for an integration you can do so. | `with` | **No** |
-| `clean` | You can use this option to delete files from your deployment destination that no longer exist in your deployment source. One use case is if your project generates hashed files that vary from build to build. Using `clean` will not affect `.git`, `.github`, or `.ssh` directories. This option is turned on by default and can be toggled off by setting it to `false`. | `with` | **No** |
-| `clean-exclude` | If you need to use `clean` but you'd like to preserve certain files or folders you can use this option. This should contain each pattern as a single line in a multiline string. | `with` | **No** |
-| `dry-run` | Do not actually push back, but use `--dry-run` on `git push` invocations instead. | `with` | **No** |
-| `single-commit` | This option can be toggled to `true` if you'd prefer to have a single commit on the deployment branch instead of maintaining the full history. **Using this option will also cause any existing history to be wiped from the deployment branch**. | `with` | **No** |
-| `force` | Force-push new deployments to overwrite the previous version; otherwise, attempt to rebase new deployments onto any existing ones. This option is turned on by default and can be toggled off by setting it to `false`, which may be useful if there are multiple deployments in a single branch. | `with` | **No** |
-| `silent` | Silences the action output preventing it from displaying git messages. | `with` | **No** |
-| `tag` | Add a tag to the commit. Only works when `dry-run` is not used. | `with` | **No** |
-
-With the action correctly configured you should see the workflow trigger the deployment under the configured conditions.
-
-#### Deployment Status
-
-The action will export an environment variable called `deployment_status` that you can use in your workflow to determine if the deployment was successful or not. You can find an explanation of each status type below.
-
-| Status | Description |
-| --------- | ----------------------------------------------------------------------------------------------- |
-| `success` | The `success` status indicates that the action was able to successfully deploy to the branch. |
-| `failed` | The `failed` status indicates that the action encountered an error while trying to deploy. |
-| `skipped` | The `skipped` status indicates that the action exited early as there was nothing new to deploy. |
-
-This value is also set as a step output as `deployment-status`.
-
----
-
-### Using an SSH Deploy Key 🔑
-
-If you'd prefer to use an SSH deploy key as opposed to a token you must first generate a new SSH key by running the following terminal command, replacing the email with one connected to your GitHub account.
-
-```bash
-ssh-keygen -t rsa -m pem -b 4096 -C "youremailhere@example.com" -N ""
-```
-
-Once you've generated the key pair you must add the contents of the public key within your repository's [deploy keys menu](https://developer.github.com/v3/guides/managing-deploy-keys/). You can find this option by going to `Settings > Deploy Keys`, you can name the public key whatever you want, but you **do** need to give it write access. Afterwards, add the contents of the private key to the `Settings > Secrets` menu as `DEPLOY_KEY`.
-
-With this configured, you can then set the `ssh-key` part of the action to your private key stored as a secret.
-
-```yml
-- name: Deploy 🚀
- uses: JamesIves/github-pages-deploy-action@v4
- with:
- folder: site
- ssh-key: ${{ secrets.DEPLOY_KEY }}
-```
-
-You can view a full example of this here.
-
-
-```yml
-name: Build and Deploy
-on:
- push:
- branches:
- - main
-jobs:
- deploy:
- concurrency: ci-${{ github.ref }}
- runs-on: ubuntu-latest
- steps:
- - name: Checkout 🛎️
- uses: actions/checkout@v4
-
- - name: Install and Build 🔧 # This example project is built using npm and outputs the result to the 'build' folder. Replace with the commands required to build your project, or remove this step entirely if your site is pre-built.
- run: |
- npm ci
- npm run build
-
- - name: Deploy 🚀
- uses: JamesIves/github-pages-deploy-action@v4
- with:
- folder: build
- clean: true
- clean-exclude: |
- special-file.txt
- some/*.txt
- ssh-key: ${{ secrets.DEPLOY_KEY }}
-```
-
-
-You can view an example of this pattern here.
-
-
-```yml
-name: Build and Deploy
-on: [push]
-permissions:
- contents: write
-jobs:
- build:
- runs-on: windows-latest # The first job utilizes windows-latest
- steps:
- - name: Checkout 🛎️
- uses: actions/checkout@v4
-
- - name: Install and Build 🔧 # This example project is built using npm and outputs the result to the 'build' folder. Replace with the commands required to build your project, or remove this step entirely if your site is pre-built.
- run: |
- npm ci
- npm run build
-
- - name: Upload Artifacts 🔺 # The project is then uploaded as an artifact named 'site'.
- uses: actions/upload-artifact@v1
- with:
- name: site
- path: build
-
- deploy:
- concurrency: ci-${{ github.ref }}
- needs: [build] # The second job must depend on the first one to complete before running and uses ubuntu-latest instead of windows.
- runs-on: ubuntu-latest
- steps:
- - name: Checkout 🛎️
- uses: actions/checkout@v4
-
- - name: Download Artifacts 🔻 # The built project is downloaded into the 'site' folder.
- uses: actions/download-artifact@v1
- with:
- name: site
-
- - name: Deploy 🚀
- uses: JamesIves/github-pages-deploy-action@v4
- with:
- folder: 'site' # The deployment folder should match the name of the artifact. Even though our project builds into the 'build' folder the artifact name of 'site' must be placed here.
-```
-
-
-Click here to view an example of this.
-
-
-```yml
-name: Build and Deploy
-permissions:
- contents: write
-on:
- push:
- branches:
- - main
-jobs:
- deploy:
- concurrency: ci-${{ github.ref }}
- runs-on: ubuntu-latest
- steps:
- - name: Checkout 🛎️
- uses: actions/checkout@v4
-
- - name: Install and Build 🔧 # This example project is built using npm and outputs the result to the 'build' folder. Replace with the commands required to build your project, or remove this step entirely if your site is pre-built.
- run: |
- npm ci
- npm run build
-
- - name: Deploy 🚀
- uses: JamesIves/github-pages-deploy-action@v4
- with:
- folder: build
- clean: true
- clean-exclude: |
- special-file.txt
- some/*.txt
-```
-
-
-