Merge pull request #54 from CrayLabs/release-notes

This PR configures the github automated release notes.
It also changes the changelog file from restructured text to
markdown.

[ reviewed by @AlyssaCote ]
[ committed by @amandarichardsonn ]

Author: amandarichardsonn

.github/release.yml

@@ -0,0 +1,56 @@
+#
+# BSD 2-Clause License
+#
+# Copyright (c) 2021-2024, Hewlett Packard Enterprise
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+# 1. Redistributions of source code must retain the above copyright notice, this
+#    list of conditions and the following disclaimer.
+#
+# 2. Redistributions in binary form must reproduce the above copyright notice,
+#    this list of conditions and the following disclaimer in the documentation
+#    and/or other materials provided with the distribution.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+#
+
+changelog:
+  exclude:
+    labels:
+      - ignore-for-release
+  categories:
+    - title: Features
+      labels:
+        - 'type: feature'
+      exclude:
+        labels:
+          - non-user-facing
+    - title: Bug Fixes
+      labels:
+        - 'bug: critical'
+        - 'bug: major'
+        - 'bug: minor'
+      exclude:
+        labels:
+          - non-user-facing
+    - title: API Breaks
+      labels:
+        - 'API break'
+      exclude:
+        labels:
+          - non-user-facing
+    - title: Miscellaneous Improvements
+      labels:
+        - "*"

.github/workflows/changelog.yml

@@ -45,5 +45,5 @@ jobs:
     - name: Changelog Enforcer
       uses: dangoslen/changelog-enforcer@v3.6.0
       with:
-        changeLogPath: './doc/changelog.rst'
-        missingUpdateErrorMessage: 'changelog.rst has not been updated'
+        changeLogPath: './doc/changelog.md'
+        missingUpdateErrorMessage: 'changelog.md has not been updated'

doc/changelog.md

@@ -0,0 +1,45 @@
+# Changelog
+
+## Development branch
+
+Description
+
+-   Automate the creation of release notes
+    ([SmartDashboard-PR54](https://github.com/CrayLabs/SmartDashboard/pull/54))
+-   Add database telemetry documentation.
+    ([SmartDashboard-PR52](https://github.com/CrayLabs/SmartDashboard/pull/52))
+-   Auto-post release PR to develop from master
+    ([SmartDashboard-PR53](https://github.com/CrayLabs/SmartDashboard/pull/53))
+-   Decrease the pinned version of Pydantic
+    ([SmartDashboard-PR51](https://github.com/CrayLabs/SmartDashboard/pull/51))
+-   Bump version to 0.0.4, exclude streamlit version 1.31.X
+    ([SmartDashboard-PR50](https://github.com/CrayLabs/SmartDashboard/pull/50))
+-   Drop Python 3.8 support, add 3.11 support.
+    ([SmartDashboard-PR49](https://github.com/CrayLabs/SmartDashboard/pull/49))
+-   Add Database Telemetry page.
+    ([SmartDashboard-PR38](https://github.com/CrayLabs/SmartDashboard/pull/38))
+-   Add Github Actions workflow that checks if changelog is edited on
+    pull requests into develop.
+    ([SmartDashboard-PR47](https://github.com/CrayLabs/SmartDashboard/pull/47))
+-   Add manifest file tracking.
+    ([SmartDashboard-PR46](https://github.com/CrayLabs/SmartDashboard/pull/46))
+
+## 0.0.3
+
+Released on 15 February 2024
+
+Description
+
+-   Added defined schemas for entity objects.
+    ([SmartDashboard-PR31](https://github.com/CrayLabs/SmartDashboard/pull/31))
+-   Added experiment level logs to the dashboard.
+    ([SmartDashboard-PR37](https://github.com/CrayLabs/SmartDashboard/pull/37))
+
+## 0.0.2
+
+Released on 14 December 2023
+
+Description
+
+-   The initial release of SmartDashboard includes capabilities for
+    viewing experiment entity properties and statuses.