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

fix!: expect correct google cloud storage abbreviation in query scheme (gcs://) #39

Merged
merged 3 commits into from
Apr 26, 2024

Conversation

johanneskoester
Copy link
Contributor

@johanneskoester johanneskoester commented Apr 26, 2024

I am sorry for the breaking change. This is unavoidable unfortunately, in order to have a consistent experience. GCS seems to be the official abbreviation of google cloud storage.

@johanneskoester johanneskoester changed the title Fix/query-schema fix!: expect correct google cloud storage abbreviation in query scheme (gcs://) Apr 26, 2024
Base automatically changed from fix/test-dirs to main April 26, 2024 09:52
@johanneskoester johanneskoester merged commit 0ebf52c into main Apr 26, 2024
6 of 7 checks passed
@johanneskoester johanneskoester deleted the fix/query-schema branch April 26, 2024 09:53
johanneskoester pushed a commit that referenced this pull request Apr 26, 2024
🤖 I have created a release *beep* *boop*
---


##
[1.0.0](v0.1.4...v1.0.0)
(2024-04-26)


### ⚠ BREAKING CHANGES

* expect correct google cloud storage abbreviation in query scheme
(gcs://)
([#39](#39))

### Bug Fixes

* expect correct google cloud storage abbreviation in query scheme
(gcs://)
([#39](#39))
([0ebf52c](0ebf52c))
* fix directory support
([#38](#38))
([ce3d165](ce3d165))


### Documentation

* add intro, fix link
([6ec568a](6ec568a))

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
jeffhsu3 added a commit to jeffhsu3/snakemake-storage-plugin-gcs that referenced this pull request May 4, 2024
@jairav
Copy link
Contributor

jairav commented Aug 14, 2024

Just following up on this @johanneskoester - has this change been tested on a bucket? As far as I'm seeing this change breaks the plugin due to the gcs:// prefix not being correct. In all of Google's cloud storage documentation, the query string is gs:// example. I have left issue #18 open as I am unable to use the plugin unless I use my own fork of it (which uses gs://).

@johanneskoester
Copy link
Contributor Author

We changed the scheme to gcs:// because that is consistent with the plugin name (snakemake-storage-plugin-gcs). At the time of naming, I had the impression that the abbreviation gcs is more commonly used than gs (and also more specific).

The plugin does not use gcs:// as a prefix for any query internally, it just takes that as a user input and infers bucket and key and from the url. Hence, I cannot see how the prefix change could cause problems. The only thing I can imagine is that it does not work to copy-pasted back an forth with google tools that eventually expect gs://? Or do you have a concrete example of what does not work for me?

@johanneskoester
Copy link
Contributor Author

Thinking about it, it does not hurt to support both while internally normalizing to gs:// so that even passing on to google tools should always work as expected. Does that help? #52

@jairav
Copy link
Contributor

jairav commented Aug 19, 2024

@johanneskoester This will be incredibly helpful, yes. Thank you!

@johanneskoester
Copy link
Contributor Author

Ok, released! Thank you!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants