Add help page for update detection

This commit is contained in:
rubenwardy 2021-01-29 22:50:18 +00:00
parent 53babc1113
commit f49da74c3a
4 changed files with 33 additions and 9 deletions

View File

@ -13,6 +13,7 @@ title: Help
* [Package Inclusion Policy and Guidance](/policy_and_guidance/) * [Package Inclusion Policy and Guidance](/policy_and_guidance/)
* [Package Tags](package_tags) * [Package Tags](package_tags)
* [Automatic Update Detection](update_config)
* [Creating Releases using Webhooks](release_webhooks) * [Creating Releases using Webhooks](release_webhooks)
* [Package Configuration and Releases Guide](package_config) * [Package Configuration and Releases Guide](package_config)

View File

@ -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, from either Github or Gitlab. If you're not using either of those services,
you can also use the [API](../api) to create releases. 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: The process is as follows:
1. The user creates an API Token and a webhook to use it. 1. The user creates an API Token and a webhook to use it.

View File

@ -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.

View File

@ -5,6 +5,7 @@
{% endblock %} {% endblock %}
{% block content %} {% block content %}
<a class="btn btn-secondary float-right" href="/help/update_config/">Help</a>
<h1>{{ _("Configure Git Update Detection") }}</h1> <h1>{{ _("Configure Git Update Detection") }}</h1>
<p> <p>
@ -16,15 +17,6 @@
{{ _("You should consider using webhooks or the API for faster releases.") }} {{ _("You should consider using webhooks or the API for faster releases.") }}
</p> </p>
{% if package.checkPerm(current_user, "APPROVE_RELEASE") and package.getIsOnGitHub() %}
<p class="alert alert-secondary mb-4">
<a class="float-right btn btn-sm btn-info" href="{{ url_for('flatpage', path='help/release_webhooks') }}">{{ _("Learn more") }}</a>
<i class="fas fa-info mr-2"></i>
{{ _("You can create releases faster by using a webhook or the API.") }}
</p>
{% endif %}
{% from "macros/forms.html" import render_field, render_submit_field, render_checkbox_field %} {% from "macros/forms.html" import render_field, render_submit_field, render_checkbox_field %}
<form method="POST" action=""> <form method="POST" action="">
{{ form.hidden_tag() }} {{ form.hidden_tag() }}