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.

Sign up for GitHub

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

Jump to bottom

release varnish 1.0.0 #115

Merged
merged 1 commit into from
Dec 13, 2023
Merged

release varnish 1.0.0 #115

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
5 changes: 4 additions & 1 deletion DESCRIPTION
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
Package: varnish
Title: Front-end for The Carpentries Lesson Template
Version: 0.4.0.9000
Version: 1.0.0
Authors@R: c(
person(given = "Zhian N.",
family = "Kamvar",
Expand Down Expand Up @@ -30,6 +30,9 @@ Authors@R: c(
role = c("ctb"),
email = "robertdavey@carpentries.org",
comment = c(ORCID = "0000-0002-5589-7754")),
person(given = "Robert",
family = "Chisholm",
role = c("ctb")),
person(given = "Joel H.",
family = "Nitta",
role = c("ctb"),
Expand Down
23 changes: 22 additions & 1 deletion NEWS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,20 @@
# varnish 0.4.0.9000 (unreleased)
# varnish 1.0.0 (2023-12-13)

## MAJOR VERSION NOTE

We are bumping the major version number with this release because this version
of {varnish} now requires a new set of `translate` variables to be passed (which
are provided by sandpaper >= 0.16.0). If these variables do not exist, the
template will contain no navigation text.

This breaking change is a concious decision. The alternative for this was to
conditinally include translations and fall back to their hard-coded English text
when they did not exist. This may seem like a more reasonable choice, but it can
lead to upstream bugs that are difficult to detect (if translations are not
working, it's not clear what is the cause if the text is in English: is it
coming from {varnish} or is it coming from {sandpaper}?) and it makes
maintenance of these navigational elements more difficult because we would have
to update them in two places.

## NEW FEATURES

Expand Down Expand Up @@ -27,6 +43,11 @@
* Lesson title collision with search box resolved.
(reported: @ocasia, #84; fixed @robadob, #113).

## MISC

Added @joelnitta as a contributor.
Added @robadob as a contributor.

# varnish 0.4.0 (2023-11-29)

* life cycle icons are now displayed as badges for better visibility
Expand Down
Loading