Skip to content
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.

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

Use yamlfmt instead of prettier to format YAML #568

Merged
merged 1 commit into from
May 13, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
8 changes: 8 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -96,3 +96,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
7 changes: 3 additions & 4 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -18,11 +18,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"

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
30 changes: 21 additions & 9 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,32 @@
# 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

* [#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.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🤩 thank you ✨

I wonder if there's a changelog linting tool that can help us enforce a standard like the one you're setting here.

* [#562](https://github.com/nsidc/earthaccess/issues/562): The destination
path is now created prior to direct S3 downloads, if it doesn't already
exist.

* 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))

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

* Bug fixes:
Expand Down
3 changes: 1 addition & 2 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -76,11 +76,10 @@ nav:
- "Download data from on-prem location": "howto/onprem.md"
- "Direct S3 access - Open/stream files in the cloud": "howto/cloud.md"
- TUTORIALS:
- "Accesing remote NASA data with fsspec": "tutorials/file-access.ipynb"
- "Accessing remote NASA data with fsspec": "tutorials/file-access.ipynb"
- "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'
- USER REFERENCE:
- API:
- "Search and Access": "user-reference/api/api.md"
Expand Down
Loading