Skip to content

Commit

Permalink
(release) ORB version 0.5.1
Browse files Browse the repository at this point in the history
The last release that works with Org-roam v1
  • Loading branch information
myshevchuk committed May 7, 2021
1 parent 8d80bf9 commit 80a8698
Show file tree
Hide file tree
Showing 3 changed files with 41 additions and 8 deletions.
23 changes: 21 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,24 @@ Well, at least we try!
### Changed
- Remove keybindigns in `org-roam-bibtex-mode-map`.

## [0.5.1] - 2021-05-07
### Added
- This is the last version of ORB that works with Org-roam v1. Future releases
of ORB starting with v0.6 will work only with Org-roam v2 and will not be
backwords compatible with ORB < v0.6. There will be no deprecation notices
on functions and variables!
- Update README with the above notice.
- A basic setup for Eldev was added. No tests yet.

### Changed
- Default keybindings for ORB commands were removed from `org-roam-bibtex-map`
because they were non-essential conflicted with some other minor modes.

### Fixed
- Added Org-ref to `Package-Requires` declaration.
- Issue a warning in `orb-process-file-field` instead of ignoring errors
silently.

## [0.5.0] - 2021-03-17
### Added
- ORB PDF Scrapper export functionality was completely revisited. It can be
Expand Down Expand Up @@ -246,8 +264,9 @@ and fruitful discussions on export, reference grouping and reference numbers!
[org-roam]: https://github.com/jethrokuan/org-roam
[helm-bibtex/bibtex-completion]: https://github.com/tmalsburg/helm-bibtex

[Unreleased]: https://github.com/org-roam/org-roam-bibtex/compare/v0.5.0...HEAD
[0.4.0]: https://github.com/org-roam/org-roam-bibtex/compare/v0.4.0...v0.5.0
[Unreleased]: https://github.com/org-roam/org-roam-bibtex/compare/v0.5.1...HEAD
[0.5.1]: https://github.com/org-roam/org-roam-bibtex/compare/v0.5.0...v0.5.1
[0.5.0]: https://github.com/org-roam/org-roam-bibtex/compare/v0.4.0...v0.5.0
[0.4.0]: https://github.com/org-roam/org-roam-bibtex/compare/v0.3.1...v0.4.0
[0.3.1]: https://github.com/org-roam/org-roam-bibtex/compare/v0.3.0...v0.3.1
[0.3.0]: https://github.com/org-roam/org-roam-bibtex/compare/v0.2.3...v0.3.0
Expand Down
24 changes: 19 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,8 @@ Description

Org Roam BibTeX (ORB) is an Org Roam extension that integrates [Org
Roam](https://github.com/jethrokuan/org-roam) with [Helm and Ivy
BibTeX](https://github.com/tmalsburg/helm-bibtex) and
[Org Ref](https://github.com/jkitchin/org-ref).
BibTeX](https://github.com/tmalsburg/helm-bibtex) and [Org
Ref](https://github.com/jkitchin/org-ref).

It allows users to manage their bibliographical notes using Org Roam and access
the notes in `org-roam-directory` via `helm-bibtex`, `ivy-bibtex`, or by
Expand All @@ -37,6 +37,20 @@ Here is a selection of articles that you may find interesting.
#### Workflow
- [An Orgmode Note Workflow](https://rgoswami.me/posts/org-note-workflow/) by [@HaoZeke](https://github.com/HaoZeke) (outdated).

Important news
---------------------------------

Org Roam BibTeX v0.5.1 is the last version of ORB that works with Org-roam v1.
Future releases of ORB starting with v0.6 will work only with Org-roam v2 and
will not be backwards compatible with ORB < v0.6. There will be no deprecation
notices on functions and variables!

The `master` branch will be kept on v0.5.1 for a while.

The yet unreleased version compatible with Org-roam v2 can be found on the
`org-roam-v2` branch for testing and early adoption. It will be eventually
merged into `master`.

A word of warning 🚧
---------------

Expand Down Expand Up @@ -68,11 +82,11 @@ kindly ask you to follow these simple rules when asking for help:
4. Open an issue on the bug tracker.
5. Take your time to describe your problem and we'll take ours to help you solve it.
6. Describe your problem clearly, in a procedural way: "I run `this command`,
then I run `that command`, and finally `this one`. I expect `this` to happen but
instead happens `that`. Here is my `configuration`."
then I run `that command`, and finally `this one`. I expect `this` to happen
but instead happens `that`. Here is my `configuration`."
7. Thank you!

Keep in mind that ORB is under a heavy development and the configuration
Keep in mind that ORB is under active development and the configuration
snippets that you might have found somewhere in the Internet may be outdated
and be the actual cause your errors. It is therefore highly recommended to use
this README file, [the manual](doc/orb-manual.org) and the Emacs built-in
Expand Down
2 changes: 1 addition & 1 deletion org-roam-bibtex.el
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
;; Leo Vivier <[email protected]>
;; URL: https://github.com/org-roam/org-roam-bibtex
;; Keywords: bib, hypermedia, outlines, wp
;; Version: 0.5.0
;; Version: 0.5.1
;; Package-Requires: ((emacs "27.1") (org-roam "1.2.2") (bibtex-completion "2.0.0") (org-ref "1.1.1"))

;; Soft dependencies: projectile, persp-mode, helm, ivy, hydra
Expand Down

0 comments on commit 80a8698

Please sign in to comment.