Improve release documentation
This commit is contained in:
+7
-1
@@ -453,7 +453,13 @@ Once the PR against stable is merged (best right after merging):
|
|||||||
* Use the button "Draft a new release" in the Github UI (subsection releases).
|
* Use the button "Draft a new release" in the Github UI (subsection releases).
|
||||||
* Use the version-number specified as tag.
|
* Use the version-number specified as tag.
|
||||||
* Use "stable" as reference (this step comes after the above PR is merged).
|
* Use "stable" as reference (this step comes after the above PR is merged).
|
||||||
* Use the above changelog as release comment (as codeblock)
|
* Use the above changelog as release comment (as codeblock).
|
||||||
|
* Use the below snippet for the new release
|
||||||
|
|
||||||
|
??? Tip "Release template"
|
||||||
|
````
|
||||||
|
--8<-- "includes/release_template.md"
|
||||||
|
````
|
||||||
|
|
||||||
## Releases
|
## Releases
|
||||||
|
|
||||||
|
|||||||
@@ -0,0 +1,37 @@
|
|||||||
|
## Highlighted changes
|
||||||
|
|
||||||
|
- ...
|
||||||
|
|
||||||
|
### How to update
|
||||||
|
|
||||||
|
As always, you can update your bot using one of the following commands:
|
||||||
|
|
||||||
|
#### docker-compose
|
||||||
|
|
||||||
|
```bash
|
||||||
|
docker-compose pull
|
||||||
|
docker-compose up -d
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Installation via setup script
|
||||||
|
|
||||||
|
```
|
||||||
|
# Deactivate venv and run
|
||||||
|
./setup.sh --update
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Plain native installation
|
||||||
|
|
||||||
|
```
|
||||||
|
git pull
|
||||||
|
pip install -U -r requirements.txt
|
||||||
|
```
|
||||||
|
|
||||||
|
<details>
|
||||||
|
<summary>Expand full changelog</summary>
|
||||||
|
|
||||||
|
```
|
||||||
|
<Paste your changelog here>
|
||||||
|
```
|
||||||
|
|
||||||
|
</details>
|
||||||
Reference in New Issue
Block a user