changelog

Author: mortenpi

CHANGELOG.md

@@ -6,6 +6,15 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
 
 ### Added
 
+* With JuliaHub instances v6.9 and above, JuliaHub.jl now supports project-dataset operations. ([#15], [#82])
+
+  This includes the following new features:
+
+  - Authentication objects can now be associated with projects.
+    If the `JULIAHUB_PROJECT_UUID` environment variable is set, JuliaHub.jl will pick it up automatically..
+  - The `project_dataset` and `project_datasets` functions allow for listing datasets attached to a project.
+  - `upload_project_dataset` can be used to upload a new version of a dataset.
+
 * All the public API names are now correctly marked `public` in Julia 1.11 and above. ([#83])
 
 ### Changed
@@ -134,6 +143,7 @@ Initial package release.
 [#12]: https://github.com/JuliaComputing/JuliaHub.jl/issues/12
 [#13]: https://github.com/JuliaComputing/JuliaHub.jl/issues/13
 [#14]: https://github.com/JuliaComputing/JuliaHub.jl/issues/14
+[#15]: https://github.com/JuliaComputing/JuliaHub.jl/issues/15
 [#18]: https://github.com/JuliaComputing/JuliaHub.jl/issues/18
 [#28]: https://github.com/JuliaComputing/JuliaHub.jl/issues/28
 [#31]: https://github.com/JuliaComputing/JuliaHub.jl/issues/31
@@ -150,6 +160,7 @@ Initial package release.
 [#53]: https://github.com/JuliaComputing/JuliaHub.jl/issues/53
 [#58]: https://github.com/JuliaComputing/JuliaHub.jl/issues/58
 [#74]: https://github.com/JuliaComputing/JuliaHub.jl/issues/74
+[#82]: https://github.com/JuliaComputing/JuliaHub.jl/issues/82
 [#83]: https://github.com/JuliaComputing/JuliaHub.jl/issues/83
 [#84]: https://github.com/JuliaComputing/JuliaHub.jl/issues/84
 [#86]: https://github.com/JuliaComputing/JuliaHub.jl/issues/86

docs/src/reference/projects.md

@@ -25,9 +25,9 @@ However, you can opt-out of this behavior by explicitly passing a `project=nothi
 You can always verify that your operations are running in the context of the correct project
 by checking the [`Authentication`](@ref) object, e.g. via [`current_authentication`](@ref):
 
-```wip-jldoctest
+```jldoctest; setup = :(using JuliaHub; Main.projectauth_setup!()), teardown = :(Main.projectauth_teardown!())
 julia> JuliaHub.current_authentication()
-...
+JuliaHub.Authentication("https://juliahub.com", "username", *****; project_id = "cd6c9ee3-d15f-414f-a762-7e1d3faed835")
 ```
 
 ## Reference

src/projects.jl

@@ -200,7 +200,9 @@ session (if any), but this can be overridden by passing `project`.
 !!! note "Permissions"
 
     Note that in order for this to work, you need to have edit rights on the projects and
-    the dataset needs to have been marked writable by the dataset owner.
+    the dataset needs to have been marked writable by the dataset owner. However, unlike for
+    normal datasets uploads (with [`upload_dataset`](@ref)), you do not need to be the dataset
+    owner to upload new versions.
 
 !!! tip