Skip to content

fix: use tag rather than timestamp in dataset changelog headings #176

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
ivan-aksamentov wants to merge 1 commit into
base: master
Choose a base branch
from
Draft

fix: use tag rather than timestamp in dataset changelog headings #176

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 2 additions & 2 deletions scripts/lib/changelog.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
from .fs import file_read, file_write


def changelog_prepare(dataset, updated_at, changelog_path):
def changelog_prepare(dataset, tag, changelog_path):
path = dict_get(dataset, ["path"])
name = dict_get(dataset, ["attributes", "name"])
release_notes = changelog_get_unreleased_section(changelog_path)
Expand All @@ -11,7 +11,7 @@ def changelog_prepare(dataset, updated_at, changelog_path):
f"Cannot release dataset '{path}' without changelog. Please modify file '{changelog_path}': add '## Unreleased' section and briefly summarize the changes being released"
)

full_changelog = file_read(changelog_path).replace(f"## Unreleased", f"## {updated_at}")
full_changelog = file_read(changelog_path).replace(f"## Unreleased", f"## {tag}")
file_write(full_changelog, changelog_path)

# attr_table = format_dataset_attributes_md_table(dict_get_required(dataset, ["attributes"]))
Expand Down
6 changes: 3 additions & 3 deletions scripts/rebuild
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -394,7 +394,7 @@ def prepare_dataset_release_infos(args, datasets, datasets_from_index_json, coll
if args.release:
_, last_version = dataset_get_versions(dataset_from_index)
release_info = prepare_dataset_release_info(
dataset_dir, dataset_from_index, dict_get(last_version, ["tag"]), updated_at
dataset_dir, dataset_from_index, dict_get(last_version, ["tag"]), tag
)
if release_info is None:
continue
Expand Down Expand Up @@ -450,7 +450,7 @@ def publish_to_github_releases(args, tag, commit_hash, release_notes):
)


def prepare_dataset_release_info(dataset_dir, dataset, last_version, updated_at):
def prepare_dataset_release_info(dataset_dir, dataset, last_version, tag):
# modified_files = list(git_get_modified_files(from_revision=last_version, dirs=dataset_dir))
# modified_files = list(map(lambda f: realpath(f), modified_files))

Expand All @@ -468,7 +468,7 @@ def prepare_dataset_release_info(dataset_dir, dataset, last_version, updated_at)
# f"Unreleased' section and briefly summarize the changes being released"
# )

release_notes = changelog_prepare(dataset, updated_at, changelog_path)
release_notes = changelog_prepare(dataset, tag, changelog_path)

return {"dataset": dataset, "release_notes": release_notes, "dataset_dir": dataset_dir}

Expand Down