LibreGaming
/
contentdb
14
0
Fork 0
Code Issues 13 Pull Requests Projects Releases Wiki Activity

Update documentation

This commit is contained in:
rubenwardy 2021-01-30 15:18:56 +00:00
parent 84d7030f7d
commit 1b296fcae5
2 changed files with 22 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
app/flatpages/help/update_config.md
View File

@ -6,18 +6,33 @@ When you push a change to your Git repository, ContentDB can create a new releas
send you a reminder. ContentDB will check your Git repository every day, but you can use
webhooks or the API for faster updates.
Git Update Detection is clever enough to not create a release again if you've already created
it manually or using webhooks/the API.
## 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".
* Open the "Configure Git Update Detection" page:
* 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.
* **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
* **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/).
* **Create Release** - A new release is created.
If New Commit, the title will be the iso date (eg: 2021-02-01).
If New Tag, the title will the tag name.
## Marking a package as up-to-date
Git Update Detection shouldn't erroneously mark packages as outdated if it is configured currently,
so the first thing you should do is make sure the Update Settings are set correctly.
There are some situations where the settings are correct, but you want to mark a package as
up-to-date - for example, if you don't want to make a release for a particular tag.
Clicking "Save" on "Update Settings" will mark a package as up-to-date.
## Configuring

1
app/templates/packages/update_config.html
View File

@ -15,6 +15,7 @@
<p>
{{ _("ContentDB will poll your Git repository every day, if your package is approved.") }}
{{ _("You should consider using webhooks or the API for faster releases.") }}
{{ _("Git Update Detection is clever enough to not create a release again if you've already created it manually or using webhooks/the API.") }}
</p>
{% from "macros/forms.html" import render_field, render_submit_field, render_checkbox_field %}