Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .github/workflows/release.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,7 @@ jobs:
- name: generate changelog
run: |
uv run towncrier build --version=steps.package-version.outputs.version --yes
git commit -a -m "create changelog for version ${{ steps.package-version.outputs.version }}"

# Create Release if they differ
- name: Create Draft GitHub Release
Expand All @@ -56,3 +57,4 @@ jobs:
body_path: ".github/release_template.md"
draft: true
tag_name: v${{ steps.package-version.outputs.version }}
files: ../../changelog.md
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -283,12 +283,12 @@ branch. Please create the pr as a draft first because this will save computing t


### versioning
We manually update versions. the version number is store in `pyproject.toml`. It can either be updated manually or through
We manually update versions. The version number is stored in `pyproject.toml`. It can either be updated manually or through

```
uv version --bump [major|minor|patch]
```

We only update the major version when a major new or breaking functionality is added or a major or breaking data format change is introduced. Minor version are updated for new input data versions and smaller functionality changes. The patch version is update for data corrections, bugfixes etc.

Once a pr with a new version number is merged a release is created automatically.
Once a pr with a new version number is merged a draft release is created automatically. After filling a short description and the most important changes the release can be published.
1 change: 0 additions & 1 deletion changelog/1.docs.md

This file was deleted.

1 change: 0 additions & 1 deletion changelog/1.fix.md

This file was deleted.

2 changes: 0 additions & 2 deletions changelog/1.improvement.md

This file was deleted.

1 change: 0 additions & 1 deletion changelog/3.fix.md

This file was deleted.

1 change: 1 addition & 0 deletions changelog/7.docs.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Updated README to reflect the release process.
1 change: 1 addition & 0 deletions changelog/7.fix.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Improved release workflow to automatically delete old news files and save the current version of the changelog with the release.
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[project]
name = "cdiac_ff_data"
version = "0.1.1"
version = "0.1.2"
description = "Download CDIAC fossil fuel related CO2 emissions data and convert to primap2 format"
readme = "README.md"
#license = "CC BY-NC-SA"
Expand Down
2 changes: 1 addition & 1 deletion uv.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading