From 1951b8a3fe9ff3dac6b7777f1b43d16088ce1e04 Mon Sep 17 00:00:00 2001 From: Nathaniel Varona <194283+nathanielvarona@users.noreply.github.com> Date: Mon, 29 Jul 2024 13:37:23 +0800 Subject: [PATCH] Update profile-file Encode Pro Tip and Noticeable Issues and Solutions Section --- README.md | 54 ++++++++++++++++++++++++++++-------------------------- 1 file changed, 28 insertions(+), 26 deletions(-) diff --git a/README.md b/README.md index 59d202e..816821b 100644 --- a/README.md +++ b/README.md @@ -341,32 +341,6 @@ base64 --wrap 0 ./pritunl.profile.tar > ./pritunl.profile.base64 Create a GitHub Action Secret (e.g., `PRITUNL_PROFILE_FILE`) and paste the entire `base64` text data as the secret value. -## Noticeable Issues and Solutions - -### Pritunl Client Installation - - **Affected Runners:** **Ubuntu (Linux) Runners** using the `Apt Repository` for installation. - - - **Related Issues:** #209 #206 - - - **Problems:** - - Occasionally, updates to the Pritunl Client package in the Ubuntu repository can cause installation issues. - - Sometimes, the GitHub Actions Runner images have problems with their internal package caches, leading to failed installations. - - - **Solutions:** - - Specify the desired Pritunl Client version using the `client-version` input in your GitHub Action. This will download the client directly from the official [Pritunl Client GitHub Releases](https://github.com/pritunl/pritunl-client-electron/releases) page, ensuring you get the exact version you need. - - > NOTE: When specifying the `client-version` input, please use the version number without the 'v' prefix. For example, use 1.3.3883.60 instead of v1.3.3883.60. - - _Example:_ - - ```yml - - uses: nathanielvarona/pritunl-client-github-action@v1 - ... - with: - ... - client-version: 1.3.3883.60 - ``` - ### Pro Tip!
@@ -417,6 +391,8 @@ Create a GitHub Action Secret (e.g., `PRITUNL_PROFILE_FILE`) and paste the entir } } ``` + + _Check out this script ([pritunl-profile-encode.sh](https://github.com/nathanielvarona/dotfiles/blob/master/.scripts/source/pritunl-profile-encode.sh)) from [nathanielvarona/dotfiles](https://github.com/nathanielvarona/dotfiles) for an example of how to implement one-liner shorthand script._
## Supported Arm64 Architecture Runners @@ -431,6 +407,32 @@ Supports GitHub Actions runners with Arm64 architecture, enabling users to run w For details on runner billing, please refer to the "[About billing for GitHub Actions](https://docs.github.com/en/billing/managing-billing-for-github-actions/about-billing-for-github-actions)" documentation. +## Noticeable Issues and Solutions + +### Pritunl Client Installation + - **Affected Runners:** **Ubuntu (Linux) Runners** using the `Apt Repository` for installation. + + - **Related Issues:** [#209](https://github.com/nathanielvarona/pritunl-client-github-action/issues/209), [#206](https://github.com/nathanielvarona/pritunl-client-github-action/issues/206) + + - **Problems:** + - Occasionally, updates to the Pritunl Client package in the Ubuntu repository can cause installation issues. + - Sometimes, the GitHub Actions Runner images have problems with their internal package caches, leading to failed installations. + + - **Solutions:** + - Specify the desired Pritunl Client version using the `client-version` input in your GitHub Action. This will download the client directly from the official [Pritunl Client GitHub Releases](https://github.com/pritunl/pritunl-client-electron/releases) page, ensuring you get the exact version you need. + + > NOTE: When specifying the `client-version` input, please use the version number without the 'v' prefix. For example, use 1.3.3883.60 instead of v1.3.3883.60. + + _Example:_ + + ```yml + - uses: nathanielvarona/pritunl-client-github-action@v1 + ... + with: + ... + client-version: 1.3.3883.60 + ``` + ## Contributing Thank you for your interest in contributing to our project! We appreciate your help in making our project better.