Merge branch 'develop' into 'master'

Release 0.2.0 See merge request prod-manager/prod-manager-api!2 Signed-off-by: Lunik <[email protected]>
Lunik · Feb 5, 2023 · dd55562 · dd55562
2 parents 667decd + 4f7eaaa
commit dd55562
Show file tree

Hide file tree

Showing 6 changed files with 82 additions and 1 deletion.
diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml
@@ -54,6 +54,7 @@ stages:
     - rm -rf poetry.lock
     - poetry --version
     - poetry install
+    - poetry update
 
 test:
   stage: test

diff --git a/.gitlab/merge_request_templates/release.md b/.gitlab/merge_request_templates/release.md
@@ -0,0 +1,21 @@
+# Release X.Y.Z
+
+# CHANGELOG
+
+_Copy the full changelog here_
+
+# MR acceptance checklist
+
+- [ ] The [CONTRIBUTING][contributing-manifest] file is up to date
+- [ ] The [CHANGELOG][changelog] file is up to date
+  - [ ] `[Unreleased]` have been replaced with the release version
+- [ ] The [CODEOWNERS][codeowners] file is up to date
+- [ ] `version` in `pyproject.toml` have been replaced with the release version
+
+<!-- Links -->
+
+[pylint]: https://pylint.pycqa.org/
+
+[contributing-manifest]: CONTRIBUTING.md
+[changelog]: CHANGELOG.md
+[codeowners]: .gitlab/CODEOWNERS
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,14 @@
 # CHANGELOG
 
+## 0.2.0
+
+## Added
+
+- chore: Add new Merge Request template for release
+- doc: Add documentation about Announcement (!3)
+- ci: Force update on dependencies in CI (!4)
+
+
 ## 0.1.3
 
 ### Added:

diff --git a/docs/api-objects/announcement.md b/docs/api-objects/announcement.md
@@ -0,0 +1,44 @@
+# Announcement
+
+## Examples
+
+### List announcements
+
+```python
+announcements = pm.announcement.list()
+```
+
+### Get a single announcement
+
+```python
+# Get a announcement by ID
+announcement_id = 11
+announcement = pm.announcement.get(announcement_id)
+```
+
+### Create a announcement
+
+```python
+announcement = pm.announcement.create(
+  name="My announcement",
+  description="Demonstration announcement",
+  service=service.id,
+  scope=scope.id,
+  level="medium",
+)
+```
+
+### Updating a announcement
+
+```python
+announcement = announcement.update(
+  description="Updated announcement",
+  level="low",
+)
+```
+
+### Deleting a announcement
+
+```python
+announcement.delete()
+```
diff --git a/docs/api-objects/weather.md b/docs/api-objects/weather.md
@@ -19,3 +19,9 @@ incident_weather = pm.weather.incident()
 ```python
 maintenance_weather = pm.weather.maintenance()
 ```
+
+### Get announcement weather
+
+```python
+announcement_weather = pm.weather.announcement()
+```
diff --git a/pyproject.toml b/pyproject.toml
@@ -1,7 +1,7 @@
 [tool.poetry]
 
 name = "prod-manager"
-version = "0.1.3"
+version = "0.2.0"
 description = "Interact with a ProdManager instance"
 homepage = "https://gitlab.com/prod-manager/prod-manager-api"
 repository = "https://gitlab.com/prod-manager/prod-manager-api"