Skip to content

Commit d27f812

Browse files
committed
Reformat past changelog to fit better other extensions
1 parent 4f3b619 commit d27f812

File tree

1 file changed

+61
-48
lines changed

1 file changed

+61
-48
lines changed

CHANGELOG.md

Lines changed: 61 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -1,95 +1,108 @@
1-
0.2.3 (Mar 2, 2021) -- Cleanup
1+
# 0.2.3 (Mar 2, 2021) -- Cleanup
2+
3+
## 🏠 Internal
24

35
- Mainly updating the release on PyPi to remove accidentally included
46
remains of the previous osfclient fork.
57

68

7-
0.2.2 (Feb 10, 2021) -- No forks
9+
# 0.2.2 (Feb 10, 2021) -- No forks
10+
11+
## 🏠 Internal
812

913
- The internal fork of osfclient has been removed and a dependency to
1014
version 0.0.5 (which comes with all necessary features) was added.
1115

1216

13-
0.2.1 (Feb 1, 2021) -- Bugfix
17+
# 0.2.1 (Feb 1, 2021) -- Bugfix
18+
19+
## 🐛 Bug Fixes
1420

15-
- Fixes
21+
- A bug that allowed to clone an OSF project from misshaped URLs of type
22+
osf://<project id>/some/where/underneath (was treated as osf://<project id>).
23+
This led to an infinite recursion when installing subdatasets.
1624

17-
- A bug that allowed to clone an OSF project from misshaped URLs of type
18-
osf://<project id>/some/where/underneath (was treated as osf://<project
19-
id>).
20-
This led to an infinite recursion when installing subdatasets.
25+
## 🏠 Internal
2126

2227
- An internal function allows to update existing project metadata
2328

29+
- Updated internal osfclient fork
30+
31+
## 📝 Documentation
32+
2433
- Several tweaks to the documentation
2534

35+
## 🛡 Tests
36+
2637
- Changes in continuous integration testing with no implications for users
2738

28-
- Updated internal osfclient fork
2939

40+
# 0.2.0 (Jul 17, 2020) -- More DataLad and OSF integration
41+
42+
## 💫 Enhancements and new features
3043

31-
0.2.0 (Jul 17, 2020) -- More DataLad and OSF integration
44+
This release brings a variety improvements that jointly better utilize
45+
DataLad and OSF features
3246

33-
- This release brings a variety improvements that jointly better utilize
34-
DataLad and OSF features
47+
- Add the ability to query a credential store via DataLad, when no
48+
credentials are found in environment variables
3549

36-
- Add the ability to query a credential store via DataLad, when no
37-
credentials are found in environment variables
50+
- Add `osf-credentials` command to more conveniently set and reset
51+
OSF credentials for use by DataLad
3852

39-
- Add `osf-credentials` command to more conveniently set and reset
40-
OSF credentials for use by DataLad
53+
- `create-sibling-osf` can now create public projects
4154

42-
- `create-sibling-osf` can now create public projects
55+
- OSF projects are now of category `data` by default and another category
56+
can be set via `create-sibling-osf --category`
4357

44-
- OSF projects are now of category `data` by default and another category
45-
can be set via `create-sibling-osf --category`
58+
- Assign default OSF project tags to location any and specific datasets
59+
via OSF search functionality
4660

47-
- Assign default OSF project tags to location any and specific datasets
48-
via OSF search functionality
61+
- Add the ability to use OSF projects as git-annex exports or actual annex
62+
stores
4963

50-
- Add the ability to use OSF projects as git-annex exports or actual annex
51-
stores
64+
- Add `git-remote-osf` Git remote helper to use an OSF project as a regular
65+
Git remote, using `osf://<projectid>` URLs. Performance can be suboptimal
66+
when used with `datalad push` in DataLad versions up to 0.13.0 (repeated,
67+
avoidable Git repository uploads). Fixes have been queue for 0.13.1, and
68+
0.14.0.
5269

53-
- Add `git-remote-osf` Git remote helper to use an OSF project as a regular
54-
Git remote, using `osf://<projectid>` URLs. Performance can be suboptimal
55-
when used with `datalad push` in DataLad versions up to 0.13.0 (repeated,
56-
avoidable Git repository uploads). Fixes have been queue for 0.13.1, and
57-
0.14.0.
70+
- Ability to `datalad clone osf://<projectid>` to publish and obtain entire
71+
datasets via OSF , without the use of a separate service for Git hosting
5872

59-
- Ability to `datalad clone osf://<projectid>` to publish and obtain entire
60-
datasets via OSF , without the use of a separate service for Git hosting
73+
## 🪓 Deprecations, removals, API changes
6174

62-
- API changes
75+
- Rename `create-sibling-osf --sibling` to `-s/--name` for uniformity with
76+
other such DataLad commands
6377

64-
- Rename `create-sibling-osf --sibling` to `-s/--name` for uniformity with
65-
other such DataLad commands
78+
- Rename `create-sibling-osf --mode {annexstore,exporttree}` to
79+
`--mode {annex,export}` to match git-annex terminology
6680

67-
- Rename `create-sibling-osf --mode {annexstore,exporttree}` to
68-
`--mode {annex,export}` to match git-annex terminology
81+
## 🛡 Tests
6982

70-
- Expanded test suite
83+
- Credential-less read-only access to public datasets
7184

72-
- Credential-less read-only access to public datasets
85+
## 🐛 Bug Fixes
7386

74-
- Fixes
87+
- User/password authentication used user as password and failed
7588

76-
- User/password authentication used user as password and failed
89+
## 🏠 Internal
7790

7891
- Dropped dependency on `7z`, archive and compression is now implemented via
7992
Python standard library functionality
8093

8194
- Major documentation overhaul to reflect the new features and changed behavior
8295

8396

84-
0.1 (Jun 18, 2020) -- Sprint!
97+
# 0.1 (Jun 18, 2020) -- Sprint!
8598

86-
- First implementation of a DataLad extension for exchanging data with and
87-
via the Open Science Framework (OSF), completed during the OHBM brainhack
88-
2020.
99+
First implementation of a DataLad extension for exchanging data with and
100+
via the Open Science Framework (OSF), completed during the OHBM brainhack
101+
2020.
89102

90-
- A new git-annex special remote implementation `git-annex-remote-osf`
91-
is included that supports using an OSF project as a classic annex,
92-
but also supports `exporttree=yes`
103+
- A new git-annex special remote implementation `git-annex-remote-osf`
104+
is included that supports using an OSF project as a classic annex,
105+
but also supports `exporttree=yes`
93106

94-
- A `datalad create-sibling-osf` command is provided that can
95-
programmatically create OSF projects for dataset publication.
107+
- A `datalad create-sibling-osf` command is provided that can
108+
programmatically create OSF projects for dataset publication.

0 commit comments

Comments
 (0)