Skip to content

Commit

Permalink
Merge pull request #3 from macstadium/fz/changelog+upgrades
Browse files Browse the repository at this point in the history
Add how to upgrade and changelog sections
  • Loading branch information
Fatme authored May 23, 2024
2 parents 7d49bd4 + 15ce3e3 commit 7fc245f
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,20 @@ docker run -v /path/to/.env:/.env ghcr.io/macstadium/orka-github-runner:<tag-nam

Replace <tag-name> with the version or tag of the Orka GitHub runner you want to use.

## How to upgrade?

Upgrading the Orka GitHub plugin to the latest version ensures you have the latest features and bug fixes. Follow these steps to upgrade the plugin:
1. <b>Check for updates</b>: Visit [the Orka GitHub packages page](https://github.com/macstadium/orka-github-actions-integration/pkgs/container/orka-github-runner) to find the latest version of the plugin.
1. <b>Download latest release</b>: Use the command `docker pull ghcr.io/macstadium/orka-github-runner:<version>` to download the latest release of the Orka GitHub plugin.
1. <b>Check for running GitHub CI jobs</b>: Before proceeding, verify that there are no active CI jobs that are currently running.
1. <b>Stop previous instance(s)</b>: Ensure that any existing instances of the Orka GitHub plugin are stopped on your machine before proceeding with the upgrade.
1. <b>Review changelog</b>: Check the changelog for any additional requirements or changes in configuration that may be needed for the new version.
1. <b>Start new plugin version</b>: Execute the necessary docker run commands(mentioned in the previous section) to start the new docker image with the upgraded plugin.

## Changelog

Stay up-to-date with the latest changes, features, and fixes in the Orka GitHub plugin by checking the Changelog [here](https://github.com/macstadium/orka-github-actions-integration/releases).

## Contributing

We welcome contributions to this project! Here's how you can get involved:
Expand Down

0 comments on commit 7fc245f

Please sign in to comment.