Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 0 additions & 1 deletion .github/pull_request_template.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,6 @@ Applicable spec: <link>
- [ ] The [charm style guide](https://juju.is/docs/sdk/styleguide) was applied
- [ ] The [contributing guide](https://github.com/canonical/is-charms-contributing-guide) was applied
- [ ] The changes are compliant with [ISD054 - Managing Charm Complexity](https://discourse.charmhub.io/t/specification-isd014-managing-charm-complexity/11619)
- [ ] The documentation is generated using `src-docs`
- [ ] The documentation for charmhub is updated
- [ ] The PR is tagged with appropriate label (`urgent`, `trivial`, `complex`)
- [ ] The `CHANGELOG.md` is updated with user-relevant changes.
Expand Down
4 changes: 4 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

Place here any unreleased changes that are subject to release in coming versions :).

## 2026-02-18

- Added `How to upgrade` documentation.

## 2025-09-03

- Added changelog for tracking user-relevant changes.
10 changes: 0 additions & 10 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,16 +16,6 @@ in the root directory. The charm directory has been built using the
[`paas-charm`](https://canonical-12-factor-app-support.readthedocs-hosted.com/latest/) approach and then modified to support
the specific actions of this charm.


## Generating src docs for every commit

Run the following command:

```bash
echo -e "tox -e src-docs\ngit add src-docs\n" >> .git/hooks/pre-commit
chmod +x .git/hooks/pre-commit
```

## Testing

This project uses `tox` for managing test environments. There are some pre-configured environments
Expand Down
17 changes: 17 additions & 0 deletions charm/docs/how-to/upgrade.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Upgrade

Before updating the charm, we recommend you to back up the database using the MongoDB charm’s `create-backup` action.

```bash
juju run mongodb-k8s/leader create-backup
```

Additional information can be found about backing up in the MongoDB charm's [documentation](https://canonical-charmed-mongodb.readthedocs-hosted.com/6/how-to/back-up-and-restore/create-a-backup/).

Then you can upgrade the `github-runner-webhook-router` charm:

```bash
juju refresh github-runner-webhook-router
```

Verify if the charm is active and idle by running the `juju status --wait 1s` command.
10 changes: 9 additions & 1 deletion charm/docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,8 @@ to provide application and Flask related metrics via Grafana dashboards.

| | |
|--|--|
|--| [Explanation](charm-architecture.md) </br> Concepts - discussion and clarification of key topics |
|--| [How-to guides](how-to/upgrade.md) </br> Step-by-step guides covering key operations and common tasks |
| [Reference](reference/charm-architecture.md) </br> Technical information - specifications, APIs, architecture |--|


## Contributing to this documentation
Expand Down Expand Up @@ -55,3 +56,10 @@ projects, contributions, suggestions, fixes, and constructive feedback.

Thinking about using the Github Runner Webhook Router Operator for your next project?
[Get in touch](https://matrix.to/#/#charmhub-charmdev:ubuntu.com)!

# Contents

1. [How To](how-to/)
1. [Upgrade](how-to/upgrade.md)
2. [Reference](reference/)
1. [Charm architecture](reference/charm-architecture.md)
6 changes: 0 additions & 6 deletions generate-src-docs.sh

This file was deleted.

Loading