From f49da74c3a4446a941157c70a3a82be5d24f42a3 Mon Sep 17 00:00:00 2001 From: rubenwardy Date: Fri, 29 Jan 2021 22:50:18 +0000 Subject: [PATCH] Add help page for update detection --- app/flatpages/help.md | 1 + app/flatpages/help/release_webhooks.md | 4 ++++ app/flatpages/help/update_config.md | 27 +++++++++++++++++++++++ app/templates/packages/update_config.html | 10 +-------- 4 files changed, 33 insertions(+), 9 deletions(-) create mode 100644 app/flatpages/help/update_config.md diff --git a/app/flatpages/help.md b/app/flatpages/help.md index f068a48..0ac815b 100644 --- a/app/flatpages/help.md +++ b/app/flatpages/help.md @@ -13,6 +13,7 @@ title: Help * [Package Inclusion Policy and Guidance](/policy_and_guidance/) * [Package Tags](package_tags) +* [Automatic Update Detection](update_config) * [Creating Releases using Webhooks](release_webhooks) * [Package Configuration and Releases Guide](package_config) diff --git a/app/flatpages/help/release_webhooks.md b/app/flatpages/help/release_webhooks.md index 1ff5f1e..32c5efd 100644 --- a/app/flatpages/help/release_webhooks.md +++ b/app/flatpages/help/release_webhooks.md @@ -9,6 +9,10 @@ ContentDB offers the ability to automatically create releases using webhooks from either Github or Gitlab. If you're not using either of those services, you can also use the [API](../api) to create releases. +ContentDB also offers the ability to poll a Git repo and check for updates +without any web hooks, this is limited to once a day. +See [Automatic Update Detection](/help/update_config/). + The process is as follows: 1. The user creates an API Token and a webhook to use it. diff --git a/app/flatpages/help/update_config.md b/app/flatpages/help/update_config.md new file mode 100644 index 0000000..134415f --- /dev/null +++ b/app/flatpages/help/update_config.md @@ -0,0 +1,27 @@ +title: Automatic Update Detection + +## Introduction + +When you push a change to your Git repository, ContentDB can create a new release automatically or +send you a reminder. ContentDB will check your Git repository every day, but you can use +webhooks or the API for faster updates. + +## Setting up + +* Set "VCS Repository URL" in your package. +* Go to the Create Release page and click "Set up" on the banner. +* If the "How do you want to create releases?" wizard appears, choose "Automatic". +* Choose a trigger: + * New Commit - this will trigger for each pushed commit on the default branch, or the branch you specify. + * New Tag - this will trigger when a New Tag is created. +* Choose action to occur when the trigger happens: + * Create Release - A new release is created. + * Notification - All maintainers receive a notification under the Bot category, and the package + will appear under "Outdated Packages" in [your to do list](/user/todo/). + +## Configuring + +See the [Package Configuration and Releases Guide](/help/package_config/) for +documentation on configuring the release creation. +You can set the min/max Minetest version from the Git repository, and also +configure what files are included. diff --git a/app/templates/packages/update_config.html b/app/templates/packages/update_config.html index 6d97a5c..8a2f2ed 100644 --- a/app/templates/packages/update_config.html +++ b/app/templates/packages/update_config.html @@ -5,6 +5,7 @@ {% endblock %} {% block content %} + Help

{{ _("Configure Git Update Detection") }}

@@ -16,15 +17,6 @@ {{ _("You should consider using webhooks or the API for faster releases.") }}

- {% if package.checkPerm(current_user, "APPROVE_RELEASE") and package.getIsOnGitHub() %} -

- {{ _("Learn more") }} - - - {{ _("You can create releases faster by using a webhook or the API.") }} -

- {% endif %} - {% from "macros/forms.html" import render_field, render_submit_field, render_checkbox_field %}
{{ form.hidden_tag() }}