Skip to content

Commit

Permalink
initial take on a runbook for updating and releasing a new version of…
Browse files Browse the repository at this point in the history
… dplsh
  • Loading branch information
Philip committed Jul 10, 2024
1 parent cc1d35a commit 1989b78
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions docs/runbooks/changing-and-releasing-new-dplsh-version.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Make changes to DPLSH

Check failure on line 1 in docs/runbooks/changing-and-releasing-new-dplsh-version.md

View workflow job for this annotation

GitHub Actions / Lint Markdown

Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "# Make changes to DPLSH"]
## When to use

Check failure on line 2 in docs/runbooks/changing-and-releasing-new-dplsh-version.md

View workflow job for this annotation

GitHub Actions / Lint Markdown

Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Above] [Context: "## When to use"]

Check failure on line 2 in docs/runbooks/changing-and-releasing-new-dplsh-version.md

View workflow job for this annotation

GitHub Actions / Lint Markdown

Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "## When to use"]
When for example the `kubectl` version need updating

## Make the change

1. Go to the DPLSH directory and make the necessary changes on a new branch
2. Build DPLSH locally by running `IMAGE_URL=dplsh IMAGE_TAG=someTagName task build`
3. Test that it works by running `DPLSH_IMAGE=dplsh:local ./dplsh` and running what ever commands need to be run to test that the change has the desired effect

Check failure on line 9 in docs/runbooks/changing-and-releasing-new-dplsh-version.md

View workflow job for this annotation

GitHub Actions / Lint Markdown

Line length [Expected: 80; Actual: 159]
4. Check what version DPLSH is at here: https://github.com/danskernesdigitalebibliotek/dpl-platform/releases

Check failure on line 10 in docs/runbooks/changing-and-releasing-new-dplsh-version.md

View workflow job for this annotation

GitHub Actions / Lint Markdown

Bare URL used [Context: "https://github.com/danskernesd..."]
5. Push the branch, have it review and merge it into `main`
6. Push a new tag to `main`. The tag should look like this: `dplsh-x.x.x`. (If in doubt about what version to bump to; read this: https://semver.org/)

Check failure on line 12 in docs/runbooks/changing-and-releasing-new-dplsh-version.md

View workflow job for this annotation

GitHub Actions / Lint Markdown

Line length [Expected: 80; Actual: 150]

Check failure on line 12 in docs/runbooks/changing-and-releasing-new-dplsh-version.md

View workflow job for this annotation

GitHub Actions / Lint Markdown

Bare URL used [Context: "https://semver.org/"]
7. Wait for main to automically build and release the new version
8. Go to your main branch, enter the `/infrastructure` directory and run `../tools/dplsh/dplsh.sh --update`.

Check failure on line 14 in docs/runbooks/changing-and-releasing-new-dplsh-version.md

View workflow job for this annotation

GitHub Actions / Lint Markdown

Line length [Expected: 80; Actual: 108]

You are done and have the newest version of DPLSH on your machine.

0 comments on commit 1989b78

Please sign in to comment.