From 734d91fd9811797bdb0bb81e0367fe5fd08bae35 Mon Sep 17 00:00:00 2001 From: Bernd Storath <32197462+kaaax0815@users.noreply.github.com> Date: Thu, 17 Apr 2025 15:58:45 +0200 Subject: [PATCH] replace nightly with edge (#1819) --- .../{deploy-nightly.yml => deploy-edge.yml} | 15 ++++++++++----- CHANGELOG.md | 2 ++ docs/content/contributing/general.md | 2 +- .../contributing/issues-and-pull-requests.md | 2 +- docs/content/getting-started.md | 16 ++++++++-------- 5 files changed, 22 insertions(+), 15 deletions(-) rename .github/workflows/{deploy-nightly.yml => deploy-edge.yml} (88%) diff --git a/.github/workflows/deploy-nightly.yml b/.github/workflows/deploy-edge.yml similarity index 88% rename from .github/workflows/deploy-nightly.yml rename to .github/workflows/deploy-edge.yml index 6f4d1701..de8a842f 100644 --- a/.github/workflows/deploy-nightly.yml +++ b/.github/workflows/deploy-edge.yml @@ -1,9 +1,14 @@ -name: Nightly +name: Edge on: workflow_dispatch: - schedule: - - cron: "0 0 * * *" + push: + branches: + - master + +concurrency: + group: ${{ github.workflow }}-${{ github.ref }} + cancel-in-progress: true jobs: docker: @@ -37,7 +42,7 @@ jobs: context: . push: true platforms: linux/amd64,linux/arm64 - tags: ghcr.io/wg-easy/wg-easy:nightly + tags: ghcr.io/wg-easy/wg-easy:edge cache-from: type=gha cache-to: type=gha,mode=min @@ -74,4 +79,4 @@ jobs: cd docs git fetch origin gh-pages --depth=1 || true - mike deploy --push --update-aliases nightly + mike deploy --push --update-aliases edge diff --git a/CHANGELOG.md b/CHANGELOG.md index f54ce183..f908f871 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -32,6 +32,8 @@ As the whole setup has changed, we recommend to start from scratch. And import y - Changed license from CC BY-NC-SA 4.0 to AGPL-3.0-only - Added 2FA using TOTP - Improved mobile support +- CLI +- Replaced `nightly` with `edge` ## [14.0.0] - 2024-09-04 diff --git a/docs/content/contributing/general.md b/docs/content/contributing/general.md index c7720ead..0f413315 100644 --- a/docs/content/contributing/general.md +++ b/docs/content/contributing/general.md @@ -12,7 +12,7 @@ When refactoring, writing or altering files, adhere to these rules: ## Documentation -Make sure to select `nightly` in the dropdown menu at the top. Navigate to the page you would like to edit and click the edit button in the top right. This allows you to make changes and create a pull-request. +Make sure to select `edge` in the dropdown menu at the top. Navigate to the page you would like to edit and click the edit button in the top right. This allows you to make changes and create a pull-request. Alternatively you can make the changes locally. For that you'll need to have Docker installed. Run diff --git a/docs/content/contributing/issues-and-pull-requests.md b/docs/content/contributing/issues-and-pull-requests.md index c6a58757..92f36016 100644 --- a/docs/content/contributing/issues-and-pull-requests.md +++ b/docs/content/contributing/issues-and-pull-requests.md @@ -50,7 +50,7 @@ The development workflow is the following: 3. Document your improvements if necessary 4. [Commit][commit] (and [sign your commit][gpg]), push and create a pull-request to merge into `master`. Please **use the pull-request template** to provide a minimum of contextual information and make sure to meet the requirements of the checklist. -Pull requests are automatically tested against the CI and will be reviewed when tests pass. When your changes are validated, your branch is merged. CI builds the new `:nightly` image every night and your changes will be includes in the next version release. +Pull requests are automatically tested against the CI and will be reviewed when tests pass. When your changes are validated, your branch is merged. CI builds the new `:edge` image on every push to the `master` branch and your changes will be included in the next version release. [docs-latest]: https://wg-easy.github.io/wg-easy/latest [github-file-readme]: https://github.com/wg-easy/wg-easy/blob/master/README.md diff --git a/docs/content/getting-started.md b/docs/content/getting-started.md index 8baa9d03..515a9272 100644 --- a/docs/content/getting-started.md +++ b/docs/content/getting-started.md @@ -41,14 +41,14 @@ To understand which tags you should use, read this section carefully. [Our CI][g All workflows are using the tagging convention listed below. It is subsequently applied to all images. -| tag | Type | Example | Description | -| ------------- | ---------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ | -| `15` | latest minor for that major tag | `ghcr.io/wg-easy/wg-easy:15` | latest features for specific major versions, no breaking changes, recommended | -| `latest` | latest tag | `ghcr.io/wg-easy/wg-easy:latest` or `ghcr.io/wg-easy/wg-easy` | points to latest release, can include breaking changes | -| `15.0` | latest patch for that minor tag | `ghcr.io/wg-easy/wg-easy:15.0` | latest patches for specific minor version | -| `15.0.0` | specific tag | `ghcr.io/wg-easy/wg-easy:15.0.0` | specific release, no updates | -| `nightly` | [`master`](https://github.com/wg-easy/wg-easy/tree/master) | `ghcr.io/wg-easy/wg-easy:nightly` | mostly unstable gets frequent package and code updates, deployed against [`master`](https://github.com/wg-easy/wg-easy/tree/master). | -| `development` | pull requests | `ghcr.io/wg-easy/wg-easy:development` | used for development, testing code from PRs before landing into [`master`](https://github.com/wg-easy/wg-easy/tree/master). | +| tag | Type | Example | Description | +| ------------- | ------------------------------- | ------------------------------------------------------------- | ----------------------------------------------------------------------------- | +| `15` | latest minor for that major tag | `ghcr.io/wg-easy/wg-easy:15` | latest features for specific major versions, no breaking changes, recommended | +| `latest` | latest tag | `ghcr.io/wg-easy/wg-easy:latest` or `ghcr.io/wg-easy/wg-easy` | points to latest release, can include breaking changes | +| `15.0` | latest patch for that minor tag | `ghcr.io/wg-easy/wg-easy:15.0` | latest patches for specific minor version | +| `15.0.0` | specific tag | `ghcr.io/wg-easy/wg-easy:15.0.0` | specific release, no updates | +| `edge` | push to `master` | `ghcr.io/wg-easy/wg-easy:edge` | mostly unstable, gets frequent package and code updates | +| `development` | pull requests | `ghcr.io/wg-easy/wg-easy:development` | used for development, testing code from PRs |