Skip to content

Commit

Permalink
I can see a changelog in the docs (#396)
Browse files Browse the repository at this point in the history
* docs: add new section for the changelog

* docs: mention new rounding functions

* docs: link to the new rounding functions

* docs: add missing descriptions
  • Loading branch information
saig0 committed Jan 31, 2022
1 parent d538afe commit 8c3b08b
Show file tree
Hide file tree
Showing 4 changed files with 227 additions and 3 deletions.
99 changes: 99 additions & 0 deletions docs/docs/changelog/changelog.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,99 @@
---
id: changelog
title: Changelog
slug: /changelog/
---

export const SinceVersion = ({versionCloud, versionPlatform}) => (
<p>
<span style={{backgroundColor: '#25c2a0',borderRadius: '7px',color: '#fff',padding: '0.2rem',marginRight: '0.5rem'}}>Camunda Cloud: {versionCloud}</span>
<span style={{backgroundColor: '#1877F2',borderRadius: '7px',color: '#fff',padding: '0.2rem',}}>Camunda Platform: {versionPlatform}</span>
</p>
);

This page contains an overview of the released versions and highlights the major changes from a user
point of view (i.e. focus on features). The complete changelog, including the patch
versions, can be found on the [GitHub release page](https://github.com/camunda/feel-scala/releases).

## 1.14

<SinceVersion versionCloud="1.3.1" versionPlatform="not yet" />

**Built-in functions:**

* New function [extract()](../reference/builtin-functions/feel-built-in-functions-string.md#extract)
that applies a regular expression to a given a string
* New
function [string join()](../reference/builtin-functions/feel-built-in-functions-list.md#string-join)
that merges a list of strings into a single string
* New [range functions](../reference/builtin-functions/feel-built-in-functions-range.md) to compare
ranges and scalar values
* New functions to round numeric values:
* [round up()](../reference/builtin-functions/feel-built-in-functions-numeric.md#round-up)
* [round down()](../reference/builtin-functions/feel-built-in-functions-numeric.md#round-down)
* [round half up()](../reference/builtin-functions/feel-built-in-functions-numeric.md#round-half-up)
* [round half down()](../reference/builtin-functions/feel-built-in-functions-numeric.md#round-half-down)
* Extend function [abs()](../reference/builtin-functions/feel-built-in-functions-temporal.md#abs) for
duration values

See the full changelog [here](https://github.com/camunda/feel-scala/releases/tag/1.14.0).

## 1.13

<SinceVersion versionCloud="1.0.0" versionPlatform="7.15.0" />

**Expressions:**

* Access the property [weekday](../reference/language-guide/feel-temporal-expressions.md#properties)
of date and date-time values
* Allow escape sequences in [string literals](../reference/language-guide/feel-data-types.md#string)

**Built-in functions:**

* New
function [context()](../reference/builtin-functions/feel-built-in-functions-conversion.md#context)
that creates a context from a given key-value list
* New function [put()](../reference/builtin-functions/feel-built-in-functions-context.md#put) that
extends a context by a given entry
* New
function [put all()](../reference/builtin-functions/feel-built-in-functions-context.md#put-all)
that merges the given contexts

See the full changelog [here](https://github.com/camunda/feel-scala/releases/tag/1.13.0).

## 1.12

<SinceVersion versionCloud="0.25.0" versionPlatform="7.14.0" />

**Built-in functions:**

* New function [now()](../reference/builtin-functions/feel-built-in-functions-temporal.md#now) that
returns the current date-time
* New function [today()](../reference/builtin-functions/feel-built-in-functions-temporal.md#today)
that returns the current date
* New
function [week of year()](../reference/builtin-functions/feel-built-in-functions-temporal.md#week-of-year)
that returns the number of the week within the year
* New
function [month of year()](../reference/builtin-functions/feel-built-in-functions-temporal.md#month-of-year)
that returns the name of the month
* New
function [day of week()](../reference/builtin-functions/feel-built-in-functions-temporal.md#day-of-week)
that returns name of the weekday
* New
function [day of year()](../reference/builtin-functions/feel-built-in-functions-temporal.md#day-of-year)
that returns the number of the day within the year

See the full changelog [here](https://github.com/camunda/feel-scala/releases/tag/1.12.0).


## 1.11

<SinceVersion versionCloud="0.23.0" versionPlatform="7.13.0" />

**Expressions:**

* Access the [element of a list](../reference/language-guide/feel-list-expressions.md#get-element) using a numeric variable
* Disable [external functions](../reference/language-guide/feel-functions.md#external) by default for security reasons

See the full changelog [here](https://github.com/camunda/feel-scala/releases/tag/1.11.0).
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,11 @@ decimal(2.5, 0, "half_up")

## floor()

Round the given number at the given scale using the flooring rounding mode.

* parameters:
* `n`: number
* (optional) `scale`: number (default: `0`)
* result: number

```js
Expand All @@ -36,24 +39,127 @@ floor(1.5)

floor(-1.5)
// -2

floor(-1.56, 1)
// -1.6
```

## ceiling()

Round the given number at the given scale using the ceiling rounding mode.

* parameters:
* `n`: number
* (optional) `scale`: number (default: `0`)
* result: number

```js
ceiling(1.5)
// 2

floor(-1.5)
ceiling(-1.5)
// -1

ceiling(-1.56, 1)
// -1.5
```

## round up()

Round the given number at the given scale using the round-up rounding mode.

* parameters:
* `n`: number
* (optional) `scale`: number (default: `0`)
* result: number

```js
round up(5.5)
// 6

round up(-5.5)
// -6

round up(1.121, 2)
// 1.13

round up(-1.126, 2)
// -1.13
```

## round down()

Round the given number at the given scale using the round-down rounding mode.

* parameters:
* `n`: number
* (optional) `scale`: number (default: `0`)
* result: number

```js
round down(5.5)
// 5

round down (-5.5)
// -5

round down (1.121, 2)
// 1.12

round down (-1.126, 2)
// -1.12
```

## round half up()

Round the given number at the given scale using the round-half-up rounding mode.

* parameters:
* `n`: number
* (optional) `scale`: number (default: `0`)
* result: number

```js
round half up(5.5)
// 6

round half up(-5.5)
// -6

round half up(1.121, 2)
// 1.12

round half up(-1.126, 2)
// -1.13
```

## round half down()

Round the given number at the given scale using the round-half-down rounding mode.

* parameters:
* `n`: number
* (optional) `scale`: number (default: `0`)
* result: number

```js
round half down (5.5)
// 5

round half down (-5.5)
// -5

round half down (1.121, 2)
// 1.12

round half down (-1.126, 2)
// -1.13
```

## abs()

Returns the absolute value of the given numeric value.

* parameters:
* `number`: number
* result: number
Expand Down Expand Up @@ -121,22 +227,32 @@ exp(5)

## odd()

Returns `true` if the given numeric value is odd. Otherwise, it returns `false`.

* parameters:
* `number`: number
* result: boolean

```js
odd(5)
// true

odd(2)
// false
```

## even()

Returns `true` if the given numeric value is even. Otherwise, it returns `false`.

* parameters:
* `number`: number
* result: boolean

```js
odd(5)
even(5)
// false

even(2)
// true
```
6 changes: 6 additions & 0 deletions docs/docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,12 @@ module.exports = {
label: "Samples",
position: "left",
},
{
to: "docs/changelog/",
activeBasePath: "docs/changelog",
label: "Changelog",
position: "left",
},
{
type: 'docsVersionDropdown',
position: 'right',
Expand Down
5 changes: 4 additions & 1 deletion docs/sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -49,5 +49,8 @@ module.exports = {
'samples/temporal-samples',
'samples/list-samples',
'samples/context-samples'
]
],
"Changelog": [
'changelog/changelog'
],
};

0 comments on commit 8c3b08b

Please sign in to comment.