Skip to content

Commit

Permalink
Update documentation with v0.3.0 changelog
Browse files Browse the repository at this point in the history
- Update contribution guide for cutting a release
- Improve the get started guide command highlighting
  • Loading branch information
gunrein committed Sep 21, 2023
1 parent ff18c5c commit 168d02d
Show file tree
Hide file tree
Showing 3 changed files with 63 additions and 5 deletions.
21 changes: 21 additions & 0 deletions website/docs/changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,27 @@ Follow [these steps](https://duckdb.org/internals/storage#how-to-move-between-st
before upgrading `wallowa` until DuckDB storage format stability is reached.
:::

### v0.3.0 on September 21, 2023 {#v0.3.0}

Wallowa v0.3.0 to use a Docker image for distribution. The image is available as [`gunrein/wallowa`](https://hub.docker.com/r/gunrein/wallowa) on Docker Hub.

To run this version use the command:

```sh
docker run -v .:/usr/wallowa:rw -p 127.0.0.1:9843:9843 gunrein/wallowa:0.3.0`
```

This version uses DuckDB v0.8.1 (the same version as Wallowa v0.2).

#### Changes

- Use a Docker image for distribution
- Use a GitHub Action to automatically build a new Docker image for the release when a new Git tag is pushed to GitHub

#### Known issues

- Background data fetching in the server has a concurrency issue. During a fetch charts and other display elements that require data from the database will be slow to respond.

### v0.2.0 on September 18, 2023 {#v0.2.0}

Wallowa v0.2.0 adds a chart for the [​count of closed GitHub Pull Requests by repo](https://www.wallowa.io/docs/sources/github#closed-pr-count)​, improves messages when fetching, and fixes a bug.
Expand Down
27 changes: 26 additions & 1 deletion website/docs/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,4 +70,29 @@ Commands to use during development:

### Ship a new release

TODO
#### Update the changelog

The changelog records the changes made in each version. Create a new changelog entry in [website/docs/changelog.md](changelog) for each version.

- Use absolute URLs for links in the changelog so that the entry can be copy-paste to different locations without breaking the links
- The audience for the changelog are wallowa users so describe the changes in end-user terms rather than development terms

#### Create the release

To cut a new release from the `main` branch you'll create and push a new Git tag with the new version number. This will trigger the [Release](https://github.com/gunrein/wallowa/blob/main/.github/workflows/release.yaml) GitHub Action to build a Docker image for the new version and push it to [Docker Hub](https://hub.docker.com/).

1. Make sure `main` is up-to-date with all of the changes for the release including documentation updates and the [changelog entry](https://www.wallowa.io/docs/changelog.html)
2. Create a new "Release" on GitHub at https://github.com/gunrein/wallowa/releases/new
3. Click on "Choose a tag" and enter the new version number starting with a `v` (e.g. `v0.1.1`) and select "Create new tag: {version you entered} on publish"
4. Confirm that `main` is selected as the "Target"
5. Enter "wallowa {version you entered}" for the "Release title", e.g. "wallowa v0.1.1"
6. Copy-paste the changelog entry into the "Describe this release" field. Confirm that all links are absolute URLs.
7. Check the "Create a discussion for this release" checkbox so that a new discussion is created and choose the "Announcements" category
8. Click "Publish release" to publish the release and trigger the Docker image build GitHub Action

#### Publish the latest version of the documentation

1. `git branch website_production` - with the `main` branch up-to-date, switch to the `website_production`
2. `git pull origin main` - merge the changes from `main` into `website_production`
3. `git push origin website_production` - push the new content to GitHub. This will trigger a website rebuild and deploy on CloudFlare Pages.
4. Update the [Docker Hub repository overview] to add a link to the new version's Dockerfile in the "Supported tags and respective Dockerfile links" section
20 changes: 16 additions & 4 deletions website/docs/get-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,25 @@
### Start your first project

1. Navigate to the directory you'd like as the parent to your `wallowa` project directory
2. Run `docker run -v .:/usr/wallowa:rw -p 127.0.0.1:9843:9843 gunrein/wallowa new MY-PROJECT`, replacing `MY-PROJECT` with the name of your project
3. Change directory into the new project: `cd MY-PROJECT`
2. Run `wallowa new MY-PROJECT`, replacing `MY-PROJECT` with the name of your project:
```sh
docker run -v .:/usr/wallowa:rw -p 127.0.0.1:9843:9843 gunrein/wallowa new MY-PROJECT
```
3. Change directory into the new project:
```sh
cd MY-PROJECT
```
4. Add a [GitHub auth token to the `.env` file](configuration#github-auth-token)
5. Configure your project by editing `wallowa.config.toml` with a convenient text editor. The default file contains an overview of each setting and there is [documentation for all configuration options](configuration).
6. Fetch data for the first time using [the CLI](cli): `docker run -v .:/usr/wallowa:rw -p 127.0.0.1:9843:9843 gunrein/wallowa fetch`
6. Fetch data for the first time using [the `wallowa fetch` CLI command](cli#wallowa-fetch):
::: info This will take a while the first time if your repo(s) have a large number of PRs
7. Start the server: `docker run -v .:/usr/wallowa:rw -p 127.0.0.1:9843:9843 gunrein/wallowa gunrein/wallowa`
```sh
docker run -v .:/usr/wallowa:rw -p 127.0.0.1:9843:9843 gunrein/wallowa fetch
```
7. Start the server using [the `wallowa serve` CLI command](cli#wallowa-serve):
```sh
docker run -v .:/usr/wallowa:rw -p 127.0.0.1:9843:9843 gunrein/wallowa serve
```
8. Open your browser to http://localhost:9843/
9. Explore what's available and check out the documentation for the [web UI](web-ui) and [CLI](cli)

Expand Down

0 comments on commit 168d02d

Please sign in to comment.