Skip to content

Commit 001499f

Browse files
cbartzerinecon
andauthored
docs: add how-to docs (#739)
* add how-to docs * Apply suggestions from code review Co-authored-by: Erin Conley <erin.conley@canonical.com> --------- Co-authored-by: Erin Conley <erin.conley@canonical.com>
1 parent ca637f1 commit 001499f

3 files changed

Lines changed: 14 additions & 0 deletions

File tree

docs/changelog.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,10 @@
22

33
This changelog documents user-relevant changes to the GitHub runner charm.
44

5+
## 2026-02-25
6+
7+
- Add the `How to upgrade` documentation.
8+
59
## 2026-02-12
610

711
- Add support to integrate with GitHub Runner planner charm with the `github_runner_planner_v0` interface.

docs/how-to/upgrade.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# Upgrade
2+
3+
In order to upgrade the charm, refresh the revision using the `juju refresh` command:
4+
5+
```bash
6+
juju refresh github-runner
7+
```
8+
9+
Verify if the charm is active and idle by running the `juju status --wait 1s` command.

docs/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,7 @@ Thinking about using the GitHub runner charm for your next project? [Get in touc
5959
1. [Spawn OpenStack runner](how-to/openstack-runner.md)
6060
1. [Set up reactive spawning](how-to/reactive.md)
6161
1. [Comply with security requirements](how-to/comply-security.md)
62+
1. [Upgrade](how-to/upgrade.md)
6263
1. [Contribute](how-to/contribute.md)
6364
1. [Reference](reference)
6465
1. [Actions](reference/actions.md)

0 commit comments

Comments
 (0)