Skip to content

Commit

Permalink
automatic update
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions[bot] committed Nov 15, 2024
1 parent 2abee46 commit 7c8ef91
Show file tree
Hide file tree
Showing 502 changed files with 555 additions and 1,211 deletions.
20 changes: 20 additions & 0 deletions docs/reference/cli/content/setup-windows.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Setup.exe (Windows)
```
Velopack Setup (0.0.942) installs applications.
https://github.com/velopack/velopack
Usage: setup.exe [OPTIONS] [-- [EXE_ARGS]...]
Arguments:
[EXE_ARGS]... Arguments to pass to the started executable. Must be preceded by '--'.
Options:
-s, --silent Hides all dialogs and answers 'yes' to all prompts
-v, --verbose Print debug messages to console
-l, --log <FILE> Enable file logging and set location
-t, --installto <DIR> Installation directory to install the application
-h, --help Print help
```
2 changes: 1 addition & 1 deletion docs/reference/cli/content/vpk-linux.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
## `vpk -H`
```
Description:
Velopack CLI 0.0.869, for distributing applications.
Velopack CLI 0.0.942, for distributing applications.
Usage:
vpk [command] [options]
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/cli/content/vpk-osx.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
## `vpk -H`
```
Description:
Velopack CLI 0.0.869, for distributing applications.
Velopack CLI 0.0.942, for distributing applications.
Usage:
vpk [command] [options]
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/cli/content/vpk-windows.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
## `vpk -H`
```
Description:
Velopack CLI 0.0.869, for distributing applications.
Velopack CLI 0.0.942, for distributing applications.
Usage:
vpk [command] [options]
Expand Down
683 changes: 36 additions & 647 deletions docs/reference/cpp/doc_Velopack.md

Large diffs are not rendered by default.

66 changes: 0 additions & 66 deletions docs/reference/cpp/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,78 +4,12 @@ sidebar_position: 0
---
# Project index

- [`VPKC_CALL`](doc_Velopack.md#standardese-Velopack-h)

- [`VPKC_EXPORT`](doc_Velopack.md#standardese-Velopack-h)

- ## Namespace `Velopack`

<span id="standardese-Velopack"></span>

- [`UpdateInfo`](doc_Velopack.md#standardese-Velopack__UpdateInfo) &mdash; Holds information about the current version and pending updates, such as how many there are, and access to release notes.

- [`UpdateManager`](doc_Velopack.md#standardese-Velopack__UpdateManager) &mdash; Provides functionality for checking for updates, downloading updates, and applying updates to the current application.

- [`UpdateOptions`](doc_Velopack.md#standardese-Velopack__UpdateOptions) &mdash; Options to customise the behaviour of UpdateManager.

- [`VelopackApp`](doc_Velopack.md#standardese-Velopack__VelopackApp) &mdash; VelopackApp helps you to handle app activation events correctly.

- [`VelopackAsset`](doc_Velopack.md#standardese-Velopack__VelopackAsset) &mdash; An individual Velopack asset, could refer to an asset on-disk or in a remote package feed.

- [`VelopackLocatorConfig`](doc_Velopack.md#standardese-Velopack__VelopackLocatorConfig) &mdash; VelopackLocator provides some utility functions for locating the current app important paths (eg. path to packages, update binary, and so forth).

- [`vpkc_app_run`](doc_Velopack.md#standardese-vpkc_app_run--) &mdash; Should be run at the beginning of your application to handle Velopack events.

- [`vpkc_app_set_args`](doc_Velopack.md#standardese-vpkc_app_run--)

- [`vpkc_app_set_auto_apply_on_startup`](doc_Velopack.md#standardese-vpkc_app_run--)

- [`vpkc_app_set_hook_after_install`](doc_Velopack.md#standardese-vpkc_app_run--)

- [`vpkc_app_set_hook_after_update`](doc_Velopack.md#standardese-vpkc_app_run--)

- [`vpkc_app_set_hook_before_uninstall`](doc_Velopack.md#standardese-vpkc_app_run--)

- [`vpkc_app_set_hook_before_update`](doc_Velopack.md#standardese-vpkc_app_run--)

- [`vpkc_app_set_hook_first_run`](doc_Velopack.md#standardese-vpkc_app_run--)

- [`vpkc_app_set_hook_restarted`](doc_Velopack.md#standardese-vpkc_app_run--)

- [`vpkc_app_set_locator`](doc_Velopack.md#standardese-vpkc_app_run--)

- [`vpkc_asset_t`](doc_Velopack.md#standardese-vpkc_asset_t) &mdash; An individual Velopack asset, could refer to an asset on-disk or in a remote package feed.

- [`vpkc_check_for_updates`](doc_Velopack.md#standardese-vpkc_new_update_manager-charconst--vpkc_update_options_t--vpkc_locator_config_t--vpkc_update_manager_t---)

- [`vpkc_download_updates`](doc_Velopack.md#standardese-vpkc_new_update_manager-charconst--vpkc_update_options_t--vpkc_locator_config_t--vpkc_update_manager_t---)

- [`vpkc_free_asset`](doc_Velopack.md#standardese-vpkc_new_update_manager-charconst--vpkc_update_options_t--vpkc_locator_config_t--vpkc_update_manager_t---)

- [`vpkc_free_update_info`](doc_Velopack.md#standardese-vpkc_new_update_manager-charconst--vpkc_update_options_t--vpkc_locator_config_t--vpkc_update_manager_t---)

- [`vpkc_free_update_manager`](doc_Velopack.md#standardese-vpkc_new_update_manager-charconst--vpkc_update_options_t--vpkc_locator_config_t--vpkc_update_manager_t---)

- [`vpkc_get_app_id`](doc_Velopack.md#standardese-vpkc_new_update_manager-charconst--vpkc_update_options_t--vpkc_locator_config_t--vpkc_update_manager_t---)

- [`vpkc_get_current_version`](doc_Velopack.md#standardese-vpkc_new_update_manager-charconst--vpkc_update_options_t--vpkc_locator_config_t--vpkc_update_manager_t---)

- [`vpkc_get_last_error`](doc_Velopack.md#standardese-vpkc_get_last_error-char--size_t-) &mdash; Given a function has returned a failure, this function will return the last error message as a string.

- [`vpkc_is_portable`](doc_Velopack.md#standardese-vpkc_new_update_manager-charconst--vpkc_update_options_t--vpkc_locator_config_t--vpkc_update_manager_t---)

- [`vpkc_locator_config_t`](doc_Velopack.md#standardese-vpkc_locator_config_t) &mdash; VelopackLocator provides some utility functions for locating the current app important paths (eg. path to packages, update binary, and so forth).

- [`vpkc_new_update_manager`](doc_Velopack.md#standardese-vpkc_new_update_manager-charconst--vpkc_update_options_t--vpkc_locator_config_t--vpkc_update_manager_t---) &mdash; Creates a new vpkc\_update\_manager\_t. Free with vpkc\_free\_update\_manager.

- [`vpkc_set_log`](doc_Velopack.md#standardese-vpkc_set_log-vpkc_log_callback_t-) &mdash; Sets the callback to be used/called with log messages from Velopack.

- [`vpkc_update_check_t`](doc_Velopack.md#standardese-Velopack-h)

- [`vpkc_update_info_t`](doc_Velopack.md#standardese-vpkc_update_info_t) &mdash; Holds information about the current version and pending updates, such as how many there are, and access to release notes.

- [`vpkc_update_options_t`](doc_Velopack.md#standardese-vpkc_update_options_t) &mdash; Options to customise the behaviour of UpdateManager.

- [`vpkc_update_pending_restart`](doc_Velopack.md#standardese-vpkc_new_update_manager-charconst--vpkc_update_options_t--vpkc_locator_config_t--vpkc_update_manager_t---)

- [`vpkc_wait_exit_then_apply_update`](doc_Velopack.md#standardese-vpkc_new_update_manager-charconst--vpkc_update_options_t--vpkc_locator_config_t--vpkc_update_manager_t---)
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ title: Constructors
**Declaring Type:** [ChecksumFailedException](../index.md)
**Namespace:** [Velopack.Compression](../../index.md)
**Assembly:** Velopack
**Assembly Version:** 0.0.869+df2bffb
**Assembly Version:** 0.0.942+a011233

## Overloads

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ sidebar_label: ChecksumFailedException

**Namespace:** [Velopack.Compression](../index.md)
**Assembly:** Velopack
**Assembly Version:** 0.0.869+df2bffb
**Assembly Version:** 0.0.942+a011233

Represents an error that occurs when a package does not match it's expected SHA checksum

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
**Declaring Type:** [ChecksumFailedException](../index.md)
**Namespace:** [Velopack.Compression](../../index.md)
**Assembly:** Velopack
**Assembly Version:** 0.0.869+df2bffb
**Assembly Version:** 0.0.942+a011233

The filename of the package which failed validation

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ sidebar_label: IVelopackLocator Interface

**Namespace:** [Velopack.Locators](../index.md)
**Assembly:** Velopack
**Assembly Version:** 0.0.869+df2bffb
**Assembly Version:** 0.0.942+a011233

An interface describing where Velopack can find key folders and files.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
**Declaring Type:** [IVelopackLocator](../index.md)
**Namespace:** [Velopack.Locators](../../index.md)
**Assembly:** Velopack
**Assembly Version:** 0.0.869+df2bffb
**Assembly Version:** 0.0.942+a011233

Finds latest .nupkg file in the PackagesDir or null if not found.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
**Declaring Type:** [IVelopackLocator](../index.md)
**Namespace:** [Velopack.Locators](../../index.md)
**Assembly:** Velopack
**Assembly Version:** 0.0.869+df2bffb
**Assembly Version:** 0.0.942+a011233

Finds .nupkg files in the PackagesDir and returns a list of ReleaseEntryName objects.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
**Declaring Type:** [IVelopackLocator](../index.md)
**Namespace:** [Velopack.Locators](../../index.md)
**Assembly:** Velopack
**Assembly Version:** 0.0.869+df2bffb
**Assembly Version:** 0.0.942+a011233

Unique identifier for this user which is used to calculate whether this user is eligible for staged roll outs.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
**Declaring Type:** [IVelopackLocator](../index.md)
**Namespace:** [Velopack.Locators](../../index.md)
**Assembly:** Velopack
**Assembly Version:** 0.0.869+df2bffb
**Assembly Version:** 0.0.942+a011233

The directory in which versioned application files are stored.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
**Declaring Type:** [IVelopackLocator](../index.md)
**Namespace:** [Velopack.Locators](../../index.md)
**Assembly:** Velopack
**Assembly Version:** 0.0.869+df2bffb
**Assembly Version:** 0.0.942+a011233

The unique application Id. This is used in various app paths.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
**Declaring Type:** [IVelopackLocator](../index.md)
**Namespace:** [Velopack.Locators](../../index.md)
**Assembly:** Velopack
**Assembly Version:** 0.0.869+df2bffb
**Assembly Version:** 0.0.942+a011233

The temporary directory for this application.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
**Declaring Type:** [IVelopackLocator](../index.md)
**Namespace:** [Velopack.Locators](../../index.md)
**Assembly:** Velopack
**Assembly Version:** 0.0.869+df2bffb
**Assembly Version:** 0.0.942+a011233

The release channel this package was built for.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
**Declaring Type:** [IVelopackLocator](../index.md)
**Namespace:** [Velopack.Locators](../../index.md)
**Assembly:** Velopack
**Assembly Version:** 0.0.869+df2bffb
**Assembly Version:** 0.0.942+a011233

The currently installed version of the application, or null if the app is not installed.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
**Declaring Type:** [IVelopackLocator](../index.md)
**Namespace:** [Velopack.Locators](../../index.md)
**Assembly:** Velopack
**Assembly Version:** 0.0.869+df2bffb
**Assembly Version:** 0.0.942+a011233

A flag indicating if this is a portable build, and that the settings should be self\-contained in the package. On Windows, this is true for portable builds, and false for non\-portable builds which were installed by Setup.exe On OSX and Linux, this is always false, because settings and application files should be stored in the user's home directory.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
**Declaring Type:** [IVelopackLocator](../index.md)
**Namespace:** [Velopack.Locators](../../index.md)
**Assembly:** Velopack
**Assembly Version:** 0.0.869+df2bffb
**Assembly Version:** 0.0.942+a011233

The directory in which nupkg files are stored for this application.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
**Declaring Type:** [IVelopackLocator](../index.md)
**Namespace:** [Velopack.Locators](../../index.md)
**Assembly:** Velopack
**Assembly Version:** 0.0.869+df2bffb
**Assembly Version:** 0.0.942+a011233

The root directory of the application. On Windows, this folder contains all the application files, but that may not be the case on other operating systems.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
**Declaring Type:** [IVelopackLocator](../index.md)
**Namespace:** [Velopack.Locators](../../index.md)
**Assembly:** Velopack
**Assembly Version:** 0.0.869+df2bffb
**Assembly Version:** 0.0.942+a011233

The path from [AppContentDir](AppContentDir.md) to this executable.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
**Declaring Type:** [IVelopackLocator](../index.md)
**Namespace:** [Velopack.Locators](../../index.md)
**Assembly:** Velopack
**Assembly Version:** 0.0.869+df2bffb
**Assembly Version:** 0.0.942+a011233

The path to the current Update.exe or similar on other operating systems.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ title: Constructors
**Declaring Type:** [LinuxVelopackLocator](../index.md)
**Namespace:** [Velopack.Locators](../../index.md)
**Assembly:** Velopack
**Assembly Version:** 0.0.869+df2bffb
**Assembly Version:** 0.0.942+a011233

Creates a new [OsxVelopackLocator](../../OsxVelopackLocator/index.md) and auto\-detects the app information from metadata embedded in the .app.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ sidebar_label: LinuxVelopackLocator

**Namespace:** [Velopack.Locators](../index.md)
**Assembly:** Velopack
**Assembly Version:** 0.0.869+df2bffb
**Assembly Version:** 0.0.942+a011233

The default for OSX. All application files will remain in the '.app'. All additional files (log, etc) will be placed in a temporary directory.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
**Declaring Type:** [LinuxVelopackLocator](../index.md)
**Namespace:** [Velopack.Locators](../../index.md)
**Assembly:** Velopack
**Assembly Version:** 0.0.869+df2bffb
**Assembly Version:** 0.0.942+a011233

```csharp
public string AppContentDir { get; }
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
**Declaring Type:** [LinuxVelopackLocator](../index.md)
**Namespace:** [Velopack.Locators](../../index.md)
**Assembly:** Velopack
**Assembly Version:** 0.0.869+df2bffb
**Assembly Version:** 0.0.942+a011233

```csharp
public string AppId { get; }
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
**Declaring Type:** [LinuxVelopackLocator](../index.md)
**Namespace:** [Velopack.Locators](../../index.md)
**Assembly:** Velopack
**Assembly Version:** 0.0.869+df2bffb
**Assembly Version:** 0.0.942+a011233

File path of the .AppImage which mounted and ran this application.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
**Declaring Type:** [LinuxVelopackLocator](../index.md)
**Namespace:** [Velopack.Locators](../../index.md)
**Assembly:** Velopack
**Assembly Version:** 0.0.869+df2bffb
**Assembly Version:** 0.0.942+a011233

```csharp
public string AppTempDir { get; }
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
**Declaring Type:** [LinuxVelopackLocator](../index.md)
**Namespace:** [Velopack.Locators](../../index.md)
**Assembly:** Velopack
**Assembly Version:** 0.0.869+df2bffb
**Assembly Version:** 0.0.942+a011233

```csharp
public string Channel { get; }
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
**Declaring Type:** [LinuxVelopackLocator](../index.md)
**Namespace:** [Velopack.Locators](../../index.md)
**Assembly:** Velopack
**Assembly Version:** 0.0.869+df2bffb
**Assembly Version:** 0.0.942+a011233

```csharp
public SemanticVersion CurrentlyInstalledVersion { get; }
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
**Declaring Type:** [LinuxVelopackLocator](../index.md)
**Namespace:** [Velopack.Locators](../../index.md)
**Assembly:** Velopack
**Assembly Version:** 0.0.869+df2bffb
**Assembly Version:** 0.0.942+a011233

```csharp
public string PackagesDir { get; }
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
**Declaring Type:** [LinuxVelopackLocator](../index.md)
**Namespace:** [Velopack.Locators](../../index.md)
**Assembly:** Velopack
**Assembly Version:** 0.0.869+df2bffb
**Assembly Version:** 0.0.942+a011233

\/var\/tmp\/{velopack}\/{appid}, for storing app specific files which need to be preserved.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
**Declaring Type:** [LinuxVelopackLocator](../index.md)
**Namespace:** [Velopack.Locators](../../index.md)
**Assembly:** Velopack
**Assembly Version:** 0.0.869+df2bffb
**Assembly Version:** 0.0.942+a011233

A pointer to \/var\/tmp\/{velopack}, a location on linux which is semi\-persistent.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
**Declaring Type:** [LinuxVelopackLocator](../index.md)
**Namespace:** [Velopack.Locators](../../index.md)
**Assembly:** Velopack
**Assembly Version:** 0.0.869+df2bffb
**Assembly Version:** 0.0.942+a011233

```csharp
public string RootAppDir { get; }
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
**Declaring Type:** [LinuxVelopackLocator](../index.md)
**Namespace:** [Velopack.Locators](../../index.md)
**Assembly:** Velopack
**Assembly Version:** 0.0.869+df2bffb
**Assembly Version:** 0.0.942+a011233

```csharp
public string UpdateExePath { get; }
Expand Down
Loading

0 comments on commit 7c8ef91

Please sign in to comment.