Releases: EDIorg/gbif_registrar
v0.2.0
v0.2.0 (2024-01-17)
Build
- build: remove dev dependencies to lighten package
Remove developer dependencies from the list of user/production
dependencies to lighten the installation process for users. (5496256)
Ci
- ci: allow GHA to bypass protection rules on release
Permit GitHub Actions to bypass repository branch protection rules to
enable Python Semantic Release to commit release-related changes back
to the main branch. (d3c012b)
- ci: fix failing release workflow
Update the failing release workflow (GitHub Action) to enable Python
Semantic Release to automatically create a new release when the
development branch is merged into main.
- Add the GITHUB_TOKEN to the semantic release step, where it is
necessary for committing changes, using the standard syntax for
referencing secrets. - Include the missing versioning command in the semantic release step to
ensure the new version is calculated. - Correct the outdated syntax for referencing the version number in the
pyproject.toml file to align with the requirements of the current version
of Python Semantic Release. (49c986f)
- ci: update release token reference
Update the name of the authentication token used by the CD GitHub
Actions Workflow to reflect the new permissive permissions set on the
default repository token, resolving the CD workflow failure. (dc80841)
- ci: update failing GitHub Action workflows
Adjust failing GitHub Actions workflows for 'checkout' and
'setup-python' used in the CD workflow. This workflow differs from the
CI workflow in that authentication is required for git commit and
merging operations. (bf30458)
- ci: ignore pylint c-extension-no-member messages
Ignore pylint 'c-extension-no-member' (I1101) messages, originating
from lxml, for the sake of a readable message log.
Another option, adding lxml to the pylint --extension-pkg-allow-list,
may run arbitrary code and is a decision that shouldn't be made for
collaborators running pylint in the context of this project. (3b9cefb)
- ci: update GitHub Actions
Assign GitHub Actions branch merge permissions to ensure that
'development' remains up-to-date with the main branch after 'main'
is tagged during the release process.
Declare Pylint checks in 'pyproject.toml' to ensure synchronization
between local checks and CI pipeline checks. (19e784f)
Documentation
- docs: add blank space for release commit
Insert an empty blank space into the README to ease the creation of a
commit message, via Python Semantic Release, intended solely for bumping
the major version number.
BREAKING CHANGE: This marks the first fully functioning release of the
gbif_registrar package. The APIs of previously released functionality have
been considerably modified. (86b3da0)
- docs: update CONTRIBUTING for current project status
Revise the CONTRIBUTING file to align with the current status of the project. (71e6380)
- docs: emphasize running main workflow after creation
Emphasize the importance of running the main workflow after creation,
as skipping this step can result in incomplete registration and uploading
of a package to GBIF. (20d937e)
- docs: update installation instructions
Revise installation instructions to recommend using pip from GitHub
rather than conda. While installation from conda is possible, the pip
method is more straightforward. (49d3ffa)
- docs: add examples of public-facing API usage
Add missing examples of public-facing API usage to provide users with
demonstrations of how to use the functions. (85f5364)
- docs: encourage subscription to API mailing list
Add a note to the developer section of the README, advising maintainers
to subscribe to the EDI and GBIF API mailing lists for timely updates on
outages and changes. This ensures they can adjust expectations or the
codebase accordingly. (d62edb6)
- docs: correct subsection formatting
Apply a small fix to ensure consistent subsection formatting throughout the
document. (71a837e)
- docs: clarify dataset synchronization concept
Enhance clarity in the documentation regarding the concept of dataset
synchronization to preempt any potential confusion. (1ba25e7)
- docs: update README for release
Add major missing components to the README in preparation for release. (e55cccf)
- docs: standardize descriptions for a consistent API
Standardize function descriptions for API clarity and consistency. (947093b)
- docs: standardize parameters for consistent API
Standardize function parameter names and definitions for a consistent public
facing API. (92a56ec)
- docs: comment for clarity and understanding
Update code and test comments for improved clarity and understanding. (88842cb)
- docs: revise descriptions of a few utilities
Enhance descriptions and provide examples for the utility functions
'get_local_dataset_group_id,' 'get_local_dataset_endpoint,' and
'get_gbif_dataset_uuid' to facilitate better understanding. (eae5990)
- docs: fix outdated references to read_registrations
Address outdated mentions of the 'read_registrations' function that were
missed in commit 39367cc. (37745d6)
- docs: address RTD build deprecation
Switch to 'build.os' instead of 'build.image' to address the deprecation
of the 'build.image' config key in Read the Docs. This change is
necessary for successful documentation building. (85e3fde)
Feature
- feat: upload new and revised datasets to GBIF
Implement a new function for uploading both new and revised datasets to
GBIF. Build the workflow to handle typical conditions and edge cases.
Additionally, create integration tests for making actual HTTP calls,
extended tests meant for occasional manual execution, and mock HTTP
calls, which are always run and provide faster results. (53219b6)
- feat: enable registration repair on demand
Modify 'complete_registration_records' to operate on a single record
when directed to do so, rather than always processing all incomplete
registrations. (e164d13)
- feat: check synchronization of local dataset w/GBIF
Report the success or failure of a dataset creation or update operation
to alert users of synchronization issues. Define success and failure by
comparing the publication date of the local dataset EML metadata
and the endpoint of the zip archive download, with that of the remote
GBIF instance.
Move get_local_dataset_endpoint to utilities.py to prevent a circular
reference. (c9ebad3)
- feat: wrap get GBIF dataset details for general use
Wrap calls for GBIF dataset details to simplify response handling and
to be DRY when calling from different contexts. (c3ec165)
- feat: post local datasets to GBIF
Publish a set of functions for posting a local dataset to GBIF and
maintaining synchronization as the local dataset evolves over time. (14336ac)
Fix
- fix: resolve reference to dataset group, not endpoint
To retrieve the corresponding 'gbif_dataset_uuid' without errors,
utilize the 'local_dataset_group_id' instead of the
'local_dataset_endpoint.' The 'local_dataset_endpoint' does not
reference previously used gbif_dataset_uuid values due to its
one-to-one cardinali...
v0.1.1
v0.1.1