Browse Source

replace nightly with edge (#1819)

pull/1821/head
Bernd Storath 1 month ago
committed by GitHub
parent
commit
734d91fd98
No known key found for this signature in database GPG Key ID: B5690EEEBB952194
  1. 15
      .github/workflows/deploy-edge.yml
  2. 2
      CHANGELOG.md
  3. 2
      docs/content/contributing/general.md
  4. 2
      docs/content/contributing/issues-and-pull-requests.md
  5. 16
      docs/content/getting-started.md

15
.github/workflows/deploy-nightly.yml → .github/workflows/deploy-edge.yml

@ -1,9 +1,14 @@
name: Nightly name: Edge
on: on:
workflow_dispatch: workflow_dispatch:
schedule: push:
- cron: "0 0 * * *" branches:
- master
concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: true
jobs: jobs:
docker: docker:
@ -37,7 +42,7 @@ jobs:
context: . context: .
push: true push: true
platforms: linux/amd64,linux/arm64 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-from: type=gha
cache-to: type=gha,mode=min cache-to: type=gha,mode=min
@ -74,4 +79,4 @@ jobs:
cd docs cd docs
git fetch origin gh-pages --depth=1 || true git fetch origin gh-pages --depth=1 || true
mike deploy --push --update-aliases nightly mike deploy --push --update-aliases edge

2
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 - Changed license from CC BY-NC-SA 4.0 to AGPL-3.0-only
- Added 2FA using TOTP - Added 2FA using TOTP
- Improved mobile support - Improved mobile support
- CLI
- Replaced `nightly` with `edge`
## [14.0.0] - 2024-09-04 ## [14.0.0] - 2024-09-04

2
docs/content/contributing/general.md

@ -12,7 +12,7 @@ When refactoring, writing or altering files, adhere to these rules:
## Documentation ## 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 Alternatively you can make the changes locally. For that you'll need to have Docker installed. Run

2
docs/content/contributing/issues-and-pull-requests.md

@ -50,7 +50,7 @@ The development workflow is the following:
3. Document your improvements if necessary 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. 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 [docs-latest]: https://wg-easy.github.io/wg-easy/latest
[github-file-readme]: https://github.com/wg-easy/wg-easy/blob/master/README.md [github-file-readme]: https://github.com/wg-easy/wg-easy/blob/master/README.md

16
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. All workflows are using the tagging convention listed below. It is subsequently applied to all images.
| tag | Type | Example | Description | | 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 | | `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 | | `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` | 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 | | `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). | | `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 before landing into [`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 |
<!-- ref: major version --> <!-- ref: major version -->

Loading…
Cancel
Save