Skip to content

Commit

Permalink
Release 0.2.8 (#727)
Browse files Browse the repository at this point in the history
# Description

Please describe the change you have made.

## Checklist

- [ ] Tests added/updated.
- [ ] Run Demo Job Locally.
- [ ] Documentation updated.
- [ ] Changelogs updated in
[CHANGELOG.cdf-tk.md](https://github.com/cognitedata/toolkit/blob/main/CHANGELOG.cdf-tk.md).
- [ ] Template changelogs updated in
[CHANGELOG.templates.md](https://github.com/cognitedata/toolkit/blob/main/CHANGELOG.templates.md).
- [ ] Version bumped.

[_version.py](https://github.com/cognitedata/toolkit/blob/main/cognite/cognite_toolkit/_version.py)
and

[pyproject.toml](https://github.com/cognitedata/toolkit/blob/main/pyproject.toml)
per [semantic versioning](https://semver.org/).
  • Loading branch information
doctrino authored Jul 1, 2024
2 parents 962210a + 23706bd commit b0ff8b9
Show file tree
Hide file tree
Showing 37 changed files with 766 additions and 366 deletions.
2 changes: 1 addition & 1 deletion .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ repos:
- --fixable=E,W,F,I,T,RUF,TID,UP
- --target-version=py39
- id: ruff-format
rev: v0.4.10
rev: v0.5.0

- repo: https://github.com/pre-commit/pre-commit-hooks
rev: v4.6.0
Expand Down
19 changes: 19 additions & 0 deletions CHANGELOG.cdf-tk.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,25 @@ Changes are grouped as follows:
- `Fixed` for any bug fixes.
- `Security` in case of vulnerabilities.

## [0.2.8] - 2024-07-01

### Added

- [Feature Preview] Option to turn off semantic naming checks for resources. Turn on the feature by running
`cdf-tk features set no-naming --enable`.

### Fixed

- When running `cdf-tk run function --local`, the toolkit would raise an `ToolkitValidationError`. This is now fixed.
- When running `cdf-tk deploy --dry-run`, if any resource was referencing a `DataSet`, `SecurityCategory`,
or `ExtractionPipeline`, it would incorrectly be classified as changed. This is now fixed. This applied to
`ExtractionPipeline`, `FileMetadata`, `Function`, `Group`, `Label`, `TimeSeries`, and `Transformation` resources.

### Changed

- Function configurations for multiple functions can now be in multiple files in the function directory. Before
all configurations had to be listed in the same YAML file.

## [0.2.7] - 2024-06-28

### Fixed
Expand Down
6 changes: 6 additions & 0 deletions CHANGELOG.templates.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,12 @@ Changes are grouped as follows:
- `Fixed` for any bug fixes.
- `Security` in case of vulnerabilities.

## [0.2.8] - 2024-07-01

### Fixed

- Added missing dependency to `requirements.txt` in `cognite_modules/examples/cdf_functions_dummy`.

## [0.2.7] - 2024-06-28

No changes to templates.
Expand Down
20 changes: 13 additions & 7 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -103,27 +103,33 @@ To release a new version of the `cdf-tk` tool and the templates, you need to do
3. Update the following files with the new version number:
- `cognite_toolkit/_version.py`
- `pyproject.toml`
- `cognite_toolkit/cognite_modules/_system.yaml`
- `tests/tests_unit/tests_cdf_tk/run_data/cognite_modules/_system.yaml`.
- `tests/tests_unit/test_cdf_tk/project_for_test/cognite_modules/_system.yaml`
- `_system.yaml` (multiple)

4. Run `poetry lock` to update the `poetry.lock` file.
5. Run `pytest tests` locally to ensure that tests pass.
6. Run `python module_upgrade/run_check.py` to ensure that the `cdf-tk modules upgrade` command works as expected.
against previous versions. See [Module Upgrade](module_upgrade/README.md) for more information.
2. Get approval to squash merge the branch into `main`:

if a check fails due to missing package:
- source .venv/.../bin/activate
- pip install dependency
- deactivate
- run script again

1. Get approval to squash merge the branch into `main`:
1. Verify that all Github actions pass.
3. Create a release branch: `release-x.y.z` from `main`:
1. Create a release branch: `release-x.y.z` from `main`:
1. Create a new tag on the branch with the version number, e.g. `v0.1.0b3`.
2. Open a PR with the existing `release` branch as base comparing to your new `release-x.y.z` branch.
3. Get approval and merge (do not squash).
4. Verify that the Github action `release` passes and pushes to PyPi.
4. Create a new release on github.com with the tag and release notes:
1. Create a new release on github.com with the tag and release notes:
1. Find the tag you created and create the new release.
2. Copy the release notes from the `CHANGELOG.cdf-tk.md` file, add a `# cdf-tk` header.
3. Copy then further below the release notes from the `CHANGELOG.templates.md` file, add
a `# Templates` header.
4. Remember to mark as pre-release if this is not a final release.
5. Evaluate necessary announcements:
1. Evaluate necessary announcements:
1. On the Cognite Hub group, create a new post.
2. As part of product releases, evaluate what to include.
3. Cognite internal announcements.
Loading

0 comments on commit b0ff8b9

Please sign in to comment.