oranda 0.6.5

🎁 generate beautiful landing pages for your projects
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61

# Changelogs

oranda can generate a separate changelog file from either a local `CHANGELOG.md` file in your repository, or from the body
of GitHub releases. This setting is **enabled** by default, as long as you have a repository set for your project. To disable this
feature, set it to false in the `oranda.json`:

```json
{
  "components": {
    "changelog": false
  }
}
```

By default, oranda will also generate a `changelog.rss` file which you can plug into RSS readers or other automation!

## Controlling where changelogs are read from

By default, oranda will try to read changelog contents from a file called `CHANGELOG(.md)`. This file needs to be formatted
in such a way that it can be parsed, meaning you'll have to specify consistent headers in your Markdown file, like this:

```markdown
# Changelog

## 0.1.1 - 2023-04-05

- Fixed things

## 0.1.0 - 2023-04-02

### New features

- Fancy thingie
- Other cool stuff

### Fixes

- Beep booping is now consistent
```

If you would like oranda to use the bodies of GitHub releases that it finds instead, set the following option:

```json
{
  "components": {
    "changelog": {
      "read_changelog_file": false
    }
  }
}
```

> Even if oranda reads from a local changelog file, it will still try to match those releases to GitHub releases. Make
> sure that both version numbering schemes are the same between your local changelog and GitHub releases.

For a complete reference of changelog configuration, consult the [reference](./reference.md#componentschangelog)

## For workspaces

If you have a [workspace](./workspaces.md), but you would like to opt-out of changelogs for only some members, you'll need
to add manual overrides in those `oranda.json` files right now.