Skip to content

About

A MyST plugin to generate consolidated release notes from GitHub repositories

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Latest commit

 

History

13 Commits

Folders and files

Repository files navigation

MyST Release Notes Plugin

A MyST plugin that collects the release notes from a GitHub repository onto one page of your site.

Warning: this plugin is experimental and may change quickly. We are trying it out for release notes on jupyterbook.org. Feedback is welcome.

Usage

See the documentation for setup, all directive options, and live examples.

Once set up, the directive looks like this:

```{release-notes} org/repo
:since: -6m
```

Development

Install prerequisites

# Install bun (runtime and package manager)
# macOS
brew install oven-sh/bun/bun
# or see https://bun.sh/docs/installation

# Install gh (GitHub CLI, for fetching releases)
# macOS
brew install gh
# or see https://cli.github.com/

Build and test

# Install dependencies (including MyST)
bun install

# Build and serve docs locally
bun run docs:live

# Build docs (static)
bun run docs

# Run tests
bun run test

About

A MyST plugin to generate consolidated release notes from GitHub repositories

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Contributors

Languages