Skip to content

Commit

Permalink
Use yamlfmt instead of prettier to format YAML
Browse files Browse the repository at this point in the history
Fixes #555
  • Loading branch information
chuckwondo committed May 12, 2024
1 parent c04199a commit 154fed2
Show file tree
Hide file tree
Showing 5 changed files with 34 additions and 12 deletions.
8 changes: 8 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -95,3 +95,11 @@ Temporary Items
.envrc

# End of https://www.toptal.com/developers/gitignore/api/direnv

# Created by https://www.toptal.com/developers/gitignore/api/asdf
# Edit at https://www.toptal.com/developers/gitignore?templates=asdf

### asdf ###
/.tool-versions

# End of https://www.toptal.com/developers/gitignore/api/asdf
6 changes: 3 additions & 3 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,10 @@ repos:
- id: ruff
args: ["--fix", "--exit-non-zero-on-fix"]
- id: ruff-format
- repo: https://github.com/pre-commit/mirrors-prettier
rev: "v4.0.0-alpha.8"
- repo: https://github.com/google/yamlfmt
rev: v0.12.1
hooks:
- id: prettier
- id: yamlfmt
types_or: [yaml]
exclude: ".*/vcr_cassettes/.*\\.yaml"
- repo: https://github.com/citation-file-format/cffconvert
Expand Down
2 changes: 2 additions & 0 deletions .yamlfmt.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
formatter:
retain_line_breaks_single: true
28 changes: 20 additions & 8 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,28 @@
# Changelog

## [Unreleased]

* Changes
* Removed the `get_user_profile` method and the `email_address` and `profile` attributes from the `Auth` class ([#421](https://github.com/nsidc/earthaccess/issues/421))
* Bug fixes:
* fixed 483 by extracting a common CMR query method for collections and granules using SearchAfter header
* Added VCR support for verifying the API call to CMR and the parsing of returned results without relying on CMR availability post development

* Enhancements:
* Corrected and enhanced static type hints for functions and methods that make
CMR queries or handle CMR query results ([#508](https://github.com/nsidc/earthaccess/issues/508))
* Enable queries to Earthdata User Acceptance Testing (UAT) system for authenticated accounts ([#421](https://github.com/nsidc/earthaccess/issues/421))
* [#421](https://github.com/nsidc/earthaccess/issues/421): Removed the
`get_user_profile` method and the `email_address` and `profile` attributes
from the `Auth` class. Calling the EDL API to get user profile information
is not intended for library access and is not necessary for this library's
intended use cases.
* [#555](https://github.com/nsidc/earthaccess/issues/555): YAML formatting is
now performed with `yamlfmt` instead of `prettier`.

* Enhancements

* [#483](https://github.com/nsidc/earthaccess/issues/483): Now using
[Search After](https://cmr.earthdata.nasa.gov/search/site/docs/search/api.html#search-after)
for collection and granule searches to support deep-paging through large
result sets.
* [#508](https://github.com/nsidc/earthaccess/issues/508): Corrected and
enhanced static type hints for functions and methods that make CMR queries
or handle CMR query results.
* [#421](https://github.com/nsidc/earthaccess/issues/421): Enabled queries to
Earthdata User Acceptance Testing (UAT) system for authenticated accounts.

## [v0.9.0] 2024-02-28

Expand Down
2 changes: 1 addition & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ nav:
- "Search and access of restricted datasets": "tutorials/restricted-datasets.ipynb"
- "Reproducing NASA sea level rise infographic": "tutorials/SSL.ipynb"
- "Accessing and visualizing EMIT data with a few lines of code": "tutorials/emit-earthaccess.ipynb"
# - 'Distributing workloads with Dask clusters': 'tutorials/dask.ipynb'
# - 'Distributing workloads with Dask clusters': 'tutorials/dask.ipynb'
- USER REFERENCE:
- API:
- "Search and Access": "user-reference/api/api.md"
Expand Down

0 comments on commit 154fed2

Please sign in to comment.