Generate release notes.

gemini-hlsw · Aug 26, 2023 · 68ff81c · 68ff81c
1 parent 9f709ff
commit 68ff81c
Show file tree

Hide file tree

Showing 17 changed files with 25 additions and 17 deletions.
diff --git a/CHANGES.md b/CHANGES.md
@@ -0,0 +1,24 @@
+## GOATS 23.08.0 (2023-08-25)
+
+
+### New Features
+
+- GOATS CLI: The GOATS CLI was updated to use Python Click, simplifying the command-line interface. The CLI is now included with the package installation. Use the goats command in the terminal to start. [[#GOATS-42](https://noirlab.atlassian.net/browse/GOATS-42)]
+- Added v1 of GOATS footer: A custom footer was developed for the GOATS platform. The update involved integrating essential elements from the `tom_base/tom_common` files and initiating the use of custom CSS. [[#GOATS-44](https://noirlab.atlassian.net/browse/GOATS-44)]
+- Added v1 of GOATS navbar: A custom navbar was developed for the GOATS platform. [[#GOATS-45](https://noirlab.atlassian.net/browse/GOATS-45)]
+- Design initial version of GOATS CSS and layout: Bootstrap serves as a foundational element in our project, being a critical component of the TOM Toolkit. We leverage its robust framework as a starting point, extending and customizing it to create our own distinctive style that aligns with our specific needs and branding. [[#GOATS-47](https://noirlab.atlassian.net/browse/GOATS-47)]
+- Created v1 of GOATS banner: A new banner has been added to display site logo and affiliates. [[#GOATS-48](https://noirlab.atlassian.net/browse/GOATS-48)]
+- Improved CLI for GOATS: The CLI for GOATS now supports a development server that allows for real-time template modifications. Additionally, shorthand options have been introduced for a more streamlined user experience. [[#GOATS-51](https://noirlab.atlassian.net/browse/GOATS-51)]
+
+
+### Other
+
+- Tooling for release notes: Added infrastructure to produce useful, summarized change logs with `towncrier`. [[#GOATS-22](https://noirlab.atlassian.net/browse/GOATS-22)]
+- `pytest` GitHub Action Integration: Established automated unit testing and initial code coverage assessment. This action, triggered on every 'push' event, provides continual testing and a basic coverage report, laying the groundwork for future integration with Codecov. [[#GOATS-24](https://noirlab.atlassian.net/browse/GOATS-24)]
+- `pytest` infrastructure started: Established a `pytest` infrastructure for `goats`, introducing robust unit and integration tests. This setup enhances the reliability and maintainability of the codebase, facilitating more secure code updates and deployments. [[#GOATS-25](https://noirlab.atlassian.net/browse/GOATS-25)]
+- Standard `pyproject.toml` started: Implemented a `pyproject.toml` file for `goats` to standardize build tool dependencies, streamlining the build process and ensuring consistency across different environments. [[#GOATS-28](https://noirlab.atlassian.net/browse/GOATS-28)]
+- Integrated `flake8` in GitHub Actions: Incorporated `flake8` into the GitHub Actions pipeline, enabling automatic linting checks for Python code. This enforces code quality standards across `goats`. [[#GOATS-33](https://noirlab.atlassian.net/browse/GOATS-33)]
+- Overrode default TOMToolkit index page and updated `pyproject.toml`: Improved pip installation process, enhancing user interface customization for GOATS and project distribution. [[#GOATS-43](https://noirlab.atlassian.net/browse/GOATS-43)]
+- Optimized GitHub Actions and integrated HTML linting: GitHub Actions now operate selectively, with the HTML linter (`htmlhint`) triggered when template HTML files change, and unit tests and `flake8` checks run when Python files change. Additionally, common Jinja templating settings are now ignored by the HTML linter, thanks to the updated `htmlhint` configuration. [[#GOATS-53](https://noirlab.atlassian.net/browse/GOATS-53)]
+- CSS linting added to GitHub Actions: Used stylelint to ensure CSS code quality. [[#GOATS-54](https://noirlab.atlassian.net/browse/GOATS-54)]
+- JS Testing using `jest`: Implemented a test suite for JavaScript files in the GOATS project using `jest`. Ensures robust testing across the website and integrates GitHub action to run tests automatically. A badge has been added to the repository to show the test status. [[#GOATS-61](https://noirlab.atlassian.net/browse/GOATS-61)]
diff --git a/doc/changes/GOATS-22.other.md b/doc/changes/GOATS-22.other.md
diff --git a/doc/changes/GOATS-24.other.md b/doc/changes/GOATS-24.other.md
diff --git a/doc/changes/GOATS-25.other.md b/doc/changes/GOATS-25.other.md
diff --git a/doc/changes/GOATS-28.other.md b/doc/changes/GOATS-28.other.md
diff --git a/doc/changes/GOATS-33.other.md b/doc/changes/GOATS-33.other.md
diff --git a/doc/changes/GOATS-42.new.md b/doc/changes/GOATS-42.new.md
diff --git a/doc/changes/GOATS-43.other.md b/doc/changes/GOATS-43.other.md
diff --git a/doc/changes/GOATS-44.new.md b/doc/changes/GOATS-44.new.md
diff --git a/doc/changes/GOATS-45.new.md b/doc/changes/GOATS-45.new.md
diff --git a/doc/changes/GOATS-47.new.md b/doc/changes/GOATS-47.new.md
diff --git a/doc/changes/GOATS-48.new.md b/doc/changes/GOATS-48.new.md
diff --git a/doc/changes/GOATS-51.new.md b/doc/changes/GOATS-51.new.md
diff --git a/doc/changes/GOATS-53.other.md b/doc/changes/GOATS-53.other.md
diff --git a/doc/changes/GOATS-54.other.md b/doc/changes/GOATS-54.other.md
diff --git a/doc/changes/GOATS-61.other.md b/doc/changes/GOATS-61.other.md
diff --git a/pyproject.toml b/pyproject.toml
@@ -23,7 +23,7 @@ dependencies = [
     "click",
     "werkzeug",
 ]
-version = "0.0.1"
+version = "23.08.0"
 
 [project.urls]
 "Homepage" = "https://github.com/gemini-hlsw/goats"