Skip to content

Commit

Permalink
Release 0.3.5 (#1131)
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 Oct 24, 2024
2 parents e3769b5 + 85e09fa commit b4aa02a
Show file tree
Hide file tree
Showing 307 changed files with 2,991 additions and 1,625 deletions.
6 changes: 3 additions & 3 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ jobs:
name: Run linters
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@eef61447b9ff4aafe5dcd4e0bbf5d482be7e7871 # v4
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
- uses: actions/setup-python@v5
with:
python-version: ${{ env.PYTHON_VERSION }}
Expand Down Expand Up @@ -55,7 +55,7 @@ jobs:
# Skipping 3.11 as we assume it is covered by 3.10 and 3.12
- "3.12"
steps:
- uses: actions/checkout@eef61447b9ff4aafe5dcd4e0bbf5d482be7e7871 # v4
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
- uses: actions/setup-python@v5
with:
python-version: ${{ matrix.python-version }}
Expand All @@ -81,7 +81,7 @@ jobs:
IDP_CLIENT_SECRET: ${{ secrets.IDP_CLIENT_SECRET }}
IDP_TOKEN_URL: ${{ secrets.IDP_TOKEN_URL }}
steps:
- uses: actions/checkout@eef61447b9ff4aafe5dcd4e0bbf5d482be7e7871 # v4
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
- uses: actions/setup-python@v5
with:
python-version: 3.11
Expand Down
4 changes: 2 additions & 2 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -300,11 +300,11 @@ function_local_venvs/
tests/data/run_data/build_info.dev.yaml
orgdir*
module_upgrade/cdf.toml
my_org
# Org used by bootcamp
ice-cream-dataops
module_upgrade/*.log
needle/
my_dev

tmp.py

my_*/
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.6.9
rev: v0.7.0

- repo: https://github.com/igorshubovych/markdownlint-cli
rev: v0.42.0
Expand Down
4 changes: 4 additions & 0 deletions CHANGELOG.cdf-tk.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,10 @@ Changes are grouped as follows:
- `Fixed` for any bug fixes.
- `Security` in case of vulnerabilities.

## [0.3.5] - 2024-10-24

No changes to cdf CLI.

## [0.3.4] - 2024-10-18

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

## [0.3.5] - 2024-10-24

### Added

- Added new package `industrial_tool` for data exploration and analytics with modules
- `cdf_search` for setting up location filters
- Added new package `contextualization` with modules
- `cdf_p_and_id_parser`
- `cdf_timeseries_equipment_sql`

## [0.3.4] - 2024-10-18

- Added new package `sourcesystem` with modules
Expand Down
3 changes: 2 additions & 1 deletion cdf.toml
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ default_organization_dir = "cognite_toolkit"
graphql = true
import-cmd = true
ado-pipelines = true
require-kind = true

[plugins]
run = true
Expand All @@ -19,4 +20,4 @@ dump = true
[modules]
# This is the version of the modules. It should not be changed manually.
# It will be updated by the 'cdf module upgrade' command.
version = "0.3.4"
version = "0.3.5"
2 changes: 1 addition & 1 deletion cognite_toolkit/_builtin_modules/cdf.toml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ default_env = "<DEFAULT_ENV_PLACEHOLDER>"
[modules]
# This is the version of the modules. It should not be changed manually.
# It will be updated by the 'cdf module upgrade' command.
version = "0.3.4"
version = "0.3.5"


[plugins]
Expand Down
Original file line number Diff line number Diff line change
@@ -1,34 +1,23 @@
# Module: cdf_auth_readwrite_all

This is a foundational module used by the `cdf-tk` tool as the default
auth module for read-write access to all CDF resources for the tool itself (admin or CI/CD pipeline),
as well as default read-only access for admin access in the UI.

This structure is based on the concept of ONLY the tool having write access to the entities
that are controlled by the templates. Everybody else should either have no access or read-only access.
This module contains two groups that are used to grant access to all resources in a CDF project. This
should **never** be used for production projects, as it grants read-write access to all resources in the project.
However, it is useful for sandbox projects to allow members of the `gp_admin_read_write` group to have full access.
It can also be used for demo projects where you want to give full read access `gp_admin_readonly` access to
all resources to a group of users.

## Managed resources

This module manages the following resources:

1. a group with read-write access (`gp_cicd_all_read_write`) to everything in a CDF project (for `cdf-tk` as an admin
tool or through a CI/CD pipeline).
2. a group with read-only access `gp_cicd_all_read_only` (for viewing configurations from UI).
1. a group with read-write access (`gp_admin_read_write`) to everything in a CDF project.
2. a group with read-only access `gp_admin_readonly` (for viewing configurations from UI).

## Variables

The following variables are required and defined in this module:

| Variable | Description |
|----------|-------------|
|readwrite_source_id| The source ID of the group that should be granted read-write access to all resources in the project. |
|readonly_source_id| The source ID of the group that should be granted read-only access to all resources in the project.|

## Usage

The `gp_cicd_all_read_write` group is used default by the `cdf-tk auth verify` command to verify correct access to
resources in a project. The groups are default part of several packages that are created by the `cdf-tk` tool.

If you have different needs for the readwrite and readonly groups, you can copy this module into `custom_modules`, rename
it (remove the cdf_ prefix), and change which modules are deployed in your `environments.yaml` file. You can also
use the `cdf-tk verify --group-file=/path/to/group.yaml` command to switch out the default group file with your own.
| Variable | Description |
|---------------------|------------------------------------------------------------------------------------------------------|
| readwrite_source_id | The source ID of the group that should be granted read-write access to all resources in the project. |
| readonly_source_id | The source ID of the group that should be granted read-only access to all resources in the project. |
Loading

0 comments on commit b4aa02a

Please sign in to comment.