diff --git a/.github/workflows/changelog-check.yml b/.github/workflows/changelog-check.yml new file mode 100644 index 0000000..2ddbe81 --- /dev/null +++ b/.github/workflows/changelog-check.yml @@ -0,0 +1,31 @@ +name: Verify CHANGELOG update + +on: + pull_request: + +jobs: + verify-changelog: + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v4 + + - name: Check changed files + uses: dorny/paths-filter@v3 + id: changes + with: + filters: | + changelog: + - 'CHANGELOG.md' + code: + - '**' + - '!CHANGELOG.md' + - '!.github/**' + - '!docs/**' + + - name: Fail if changelog not updated + if: steps.changes.outputs.code == 'true' && steps.changes.outputs.changelog == 'false' + run: | + echo "::error::CHANGELOG.md is not updated." + echo "Please update CHANGELOG.md for your changes before merging." + exit 1 diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..b7456bf --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,17 @@ +All notable changes to this project will be documented in this file. +The format is based on [https://keepachangelog.com/en/1.1.0/](Keep a Changelog), and this project adheres to [https://semver.org/spec/v2.0.0.html](Semantic Versioning). + +Obsmon is a tool for observation monitoring in the Harmonie-Arome NWP System. It is composed of two parts: The backend and the frontend. The backend is part of the scripting system and produces databases with the relevant information as part of the post-processing. The frontend allows the analysis and visualization of this data. This software, and all files contained here, correspond only to the frontend part of the full Obsmon package. In this document, however, "obsmon" will always refer to the frontend part, unless otherwise specified. + + +## [Unreleased] + +### Changed + + * Add Change Log and check on PRs [!38](https://github.com/Hirlam/obsmon/pull/38) + * Update R packages installed by Obsmon [!37](https://github.com/Hirlam/obsmon/pull/37) + * Remove deprecated use of `multiprocess` [!33](https://github.com/Hirlam/obsmon/pull/33) + * Updates to the documentation [!32](https://github.com/Hirlam/obsmon/pull/32) + * Add documentation in markdown using Julia [!31](https://github.com/Hirlam/obsmon/pull/31) + +## [4.4.0]