-
Notifications
You must be signed in to change notification settings - Fork 111
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
5 changed files
with
120 additions
and
122 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,57 +1,57 @@ | ||
| --- | ||
| title: Github Actions | ||
| hide_title: true | ||
|
|
||
| --- | ||
|
|
||
| import { Advanced, Details, Modal, Tooltip, Charts, Important } from "/src/components/global.jsx" | ||
| import { Steps, Tabs, TabItem, Card, CardGrid, LinkCard, Aside, Icon } from '@astrojs/starlight/components'; | ||
|
|
||
| There are some actions created that will build the binaries and create and artifacts. They can be viewed here: | ||
|
|
||
| [https://github.com/userdocs/qbittorrent-nox-static/actions](https://github.com/userdocs/qbittorrent-nox-static/actions) | ||
|
|
||
| Most of these actions are triggered manually by clicking on the action and running the workflow meaning you can fork the repo and use the workflows you require. Patching will work with the `multi_arch` actions as long as you configure it correctly in the action first. | ||
|
|
||
| These are the currently available actions. | ||
|
|
||
| :::tip | ||
| also generates releases based on the qbittorrent and libtorrent tags used. The release is created when the first matrix build completes and the other builds update this release as they complete. | ||
| ::: | ||
|
|
||
| ```bash | ||
| # CI triggered on pushes to the build script. Tests on x86_64 Debian buster/sid Ubuntu Focal/hirsute to make sure it all works on these platforms. | ||
| debian_based_CI.yml | ||
|
|
||
| # qbittorrent-nox qmake, cmake, libtorrent v1 and v2 multi build and release across these architectures - x86_64 armhf armv7 aarch64 cross built via musl prebuilt toolchains. 32 builds are created. 16 per release. | ||
| matrix_multi_build_and_release.yml | ||
|
|
||
| # Same as above but with options to specificy tags so that I can update previous releases. | ||
| matrix_multi_build_and_release_customs_tags.yml | ||
|
|
||
| # Uses https://github.com/userdocs/qbt-workflow-file to create artifacts of dependencies for the worklows. | ||
| matrix_multi_build_and_release_artifacts.yml | ||
|
|
||
|
|
||
| # Uses https://github.com/userdocs/qbt-workflow-file as a source for dependencies for the worklows. | ||
| matrix_multi_build_and_release_qbt_workflow_files.yml | ||
| ``` | ||
|
|
||
| ### Github repo Actions settings | ||
|
|
||
| The only permissions these actions should need is: | ||
|
|
||
| ```yaml | ||
| permissions: | ||
| contents: write | ||
| ``` | ||
| These are already set and should require not modification in the forked repo to run successfully. | ||
| These should be the default settings for recently forked versions of this repo that require this permission. | ||
|  | ||
| You can find these settings bu going to the repo settings/actions/general | ||
|  | ||
| --- | ||
| title: Github Actions | ||
| hide_title: true | ||
|
|
||
| --- | ||
|
|
||
| import { Advanced, Details, Modal, Tooltip, Charts, Important } from "/src/components/global.jsx" | ||
| import { Steps, Tabs, TabItem, Card, CardGrid, LinkCard, Aside, Icon } from '@astrojs/starlight/components'; | ||
|
|
||
| There are some actions created that will build the binaries and create and artifacts. They can be viewed here: | ||
|
|
||
| [https://github.com/userdocs/qbittorrent-nox-static/actions](https://github.com/userdocs/qbittorrent-nox-static/actions) | ||
|
|
||
| Most of these actions are triggered manually by clicking on the action and running the workflow meaning you can fork the repo and use the workflows you require. Patching will work with the `multi_arch` actions as long as you configure it correctly in the action first. | ||
|
|
||
| These are the currently available actions. | ||
|
|
||
| :::tip | ||
| also generates releases based on the qbittorrent and libtorrent tags used. The release is created when the first matrix build completes and the other builds update this release as they complete. | ||
| ::: | ||
|
|
||
| ```bash | ||
| # CI triggered on pushes to the build script. Tests on x86_64 Debian buster/sid Ubuntu Focal/hirsute to make sure it all works on these platforms. | ||
| debian_based_CI.yml | ||
|
|
||
| # qbittorrent-nox qmake, cmake, libtorrent v1 and v2 multi build and release across these architectures - x86_64 armhf armv7 aarch64 cross built via musl prebuilt toolchains. 32 builds are created. 16 per release. | ||
| matrix_multi_build_and_release.yml | ||
|
|
||
| # Same as above but with options to specificy tags so that I can update previous releases. | ||
| matrix_multi_build_and_release_customs_tags.yml | ||
|
|
||
| # Uses https://github.com/userdocs/qbt-workflow-file to create artifacts of dependencies for the worklows. | ||
| matrix_multi_build_and_release_artifacts.yml | ||
|
|
||
|
|
||
| # Uses https://github.com/userdocs/qbt-workflow-file as a source for dependencies for the worklows. | ||
| matrix_multi_build_and_release_qbt_workflow_files.yml | ||
| ``` | ||
|
|
||
| ### Github repo Actions settings | ||
|
|
||
| The only permissions these actions should need is: | ||
|
|
||
| ```yaml | ||
| permissions: | ||
| contents: write | ||
| ``` | ||
| These are already set and should require not modification in the forked repo to run successfully. | ||
| These should be the default settings for recently forked versions of this repo that require this permission. | ||
|  | ||
| You can find these settings bu going to the repo settings/actions/general | ||
|  |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,56 +1,56 @@ | ||
| --- | ||
| title: Script Usage | ||
| hide_title: true | ||
| --- | ||
|
|
||
| import { Advanced, Details, Modal, Tooltip, Charts, Important } from "/src/components/global.jsx" | ||
| import { Steps, Tabs, TabItem, Card, CardGrid, LinkCard, Aside, Icon } from '@astrojs/starlight/components'; | ||
|
|
||
| :::tip[Just use docker] | ||
| The preferred and recommended build platform is Alpine Linux and the recommended method is via docker. It will just make things easier. | ||
| ::: | ||
|
|
||
| :::caution[Assumptions] | ||
| The guide will assume you are using docker, with example commands that are either one liners or from within the container. | ||
| ::: | ||
|
|
||
| :::danger | ||
| Don't run this directly on the host system unless you know what you are doing. It's not recommended and the build will probably fail. | ||
| ::: | ||
|
|
||
|
|
||
| <Details summary="What to expect"></Details> | ||
|
|
||
| ⭐ When you are familiar with the script you can do anything you want with a one liner. It's pretty simple to use. | ||
|
|
||
| ### Host - execute script | ||
|
|
||
| To execute the script use this command: | ||
|
|
||
| ```bash | ||
| chmod +x ~/qbt.sh # make it executable | ||
| ``` | ||
|
|
||
| ```bash | ||
| ~/qbt.sh | ||
| ``` | ||
|
|
||
| <Advanced> | ||
|
|
||
| :::note | ||
| Please see the [switches and flags summary](./build-help?id=switches-and-flags-summarised) to see what options you can pass and how to use them | ||
| ::: | ||
|
|
||
| You can modify the installation command by editing this part of the docker command. | ||
|
|
||
| ```bash | ||
| bash -s all | ||
| ``` | ||
|
|
||
| For example, to use `ICU` using `-i`, `-c` to trigger cmake and in turn activate Qt6 and optimise for the system CPU using `-o`: | ||
|
|
||
| ```bash | ||
| bash -s all -i -c -o | ||
| ``` | ||
|
|
||
| </Advanced> | ||
| --- | ||
| title: Script Usage | ||
| hide_title: true | ||
| --- | ||
|
|
||
| import { Advanced, Details, Modal, Tooltip, Charts, Important } from "/src/components/global.jsx" | ||
| import { Steps, Tabs, TabItem, Card, CardGrid, LinkCard, Aside, Icon } from '@astrojs/starlight/components'; | ||
|
|
||
| :::tip[Just use docker] | ||
| The preferred and recommended build platform is Alpine Linux and the recommended method is via docker. It will just make things easier. | ||
| ::: | ||
|
|
||
| :::caution[Assumptions] | ||
| The guide will assume you are using docker, with example commands that are either one liners or from within the container. | ||
| ::: | ||
|
|
||
| :::danger | ||
| Don't run this directly on the host system unless you know what you are doing. It's not recommended and the build will probably fail. | ||
| ::: | ||
|
|
||
|
|
||
| <Details summary="What to expect"></Details> | ||
|
|
||
| ⭐ When you are familiar with the script you can do anything you want with a one liner. It's pretty simple to use. | ||
|
|
||
| ### Host - execute script | ||
|
|
||
| To execute the script use this command: | ||
|
|
||
| ```bash | ||
| chmod +x ~/qbt.sh # make it executable | ||
| ``` | ||
|
|
||
| ```bash | ||
| ~/qbt.sh | ||
| ``` | ||
|
|
||
| <Advanced> | ||
|
|
||
| :::note | ||
| Please see the [switches and flags summary](./build-help?id=switches-and-flags-summarised) to see what options you can pass and how to use them | ||
| ::: | ||
|
|
||
| You can modify the installation command by editing this part of the docker command. | ||
|
|
||
| ```bash | ||
| bash -s all | ||
| ``` | ||
|
|
||
| For example, to use `ICU` using `-i`, `-c` to trigger cmake and in turn activate Qt6 and optimise for the system CPU using `-o`: | ||
|
|
||
| ```bash | ||
| bash -s all -i -c -o | ||
| ``` | ||
|
|
||
| </Advanced> |