Skip to content

Release v1.0.0#4

Merged
aethr merged 11 commits into
mainfrom
release-v1.0.0
Apr 26, 2026
Merged

Release v1.0.0#4
aethr merged 11 commits into
mainfrom
release-v1.0.0

Conversation

@aethr

@aethr aethr commented Feb 9, 2026

Copy link
Copy Markdown
Contributor

Scope

Prepare for a release of "version 1" of the Open Methane CMAQ fork. This PR adds:

  • open source LICENSE based on licensing of US EPA CMAQ 5.4
  • clear documentation showing lineage to CMAQ 5.0.2, since we are re-versioning to 1.0
  • add changelog and release process based on uv/towncrier/GHA

Once this PR is merged, we'll follow the launch plan in #5 to coordinate public release.

aethr added 3 commits February 9, 2026 11:25
Since we will be releasing the current build of this repo as "v1.0.0" of "Open Methane CMAQ", it's important to be clear about the version of CMAQ this is based on.

Additionally, the high level description of changes we've made illustrates why we chose to fork, instead of just applying minor changes over the original source.
@aethr aethr self-assigned this Feb 9, 2026
aethr added a commit that referenced this pull request Feb 10, 2026
aethr added a commit that referenced this pull request Feb 10, 2026
@aethr aethr force-pushed the release-v1.0.0 branch 2 times, most recently from 168b4be to 4b4dd8b Compare February 10, 2026 05:06
Although this repo doesn't actively use python, a minimal pyproject.toml containing the release version and towncrier config is a streamlined way of incorporating a mature release process. It also brings it in line with other repositories in the Open Methane ecosystem, making it easier to update and maintain.

This also opens the door for us to include python in the testing process if we want to make the tests more advanced or robust.
This project is unlikely to ever use non-gcc compilers and other things that would have originally been supported by mainline CMAQ. Removing all of these options (in the form of commented out lines) will make parsing the bits that we do use much easier for future maintainers.
Immediately after a release is created, we bump the version with a "patch"+"dev" bump, i.e. 1.0.0 to 1.0.1.dev1. If the next version is a "patch" release, we want to release 1.0.1, however the current behaviour will release 1.0.2 if "patch" is selected.

This change will use a "stable" bump to go from 1.0.1.dev1 to 1.0.1 when the desired release is a "patch".
@aethr aethr requested a review from prayner April 23, 2026 03:41
Base automatically changed from CH4only to main April 26, 2026 23:42
@aethr aethr merged commit c6de2bd into main Apr 26, 2026
3 checks passed
@aethr aethr deleted the release-v1.0.0 branch April 26, 2026 23:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants