Skip to content

Add how to upgrade and changelog sections #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
May 23, 2024
Merged

Conversation

Fatme
Copy link
Contributor

@Fatme Fatme commented May 23, 2024

This pull request enhances the readme.md file with two new sections:

  • Upgrade Instructions: Provides guidance on how to upgrade the Orka GitHub plugin to the latest version.
  • Changelog: Directs users to the Changelog section on the repository page for a list of changes and updates.

@Fatme Fatme merged commit 7fc245f into main May 23, 2024
@Fatme Fatme deleted the fz/changelog+upgrades branch May 29, 2024 14:09
spikeburton pushed a commit that referenced this pull request Apr 16, 2025
* Add CI workflow

* Add dockerfile and deploy job

* Build from agent branch

* Revert "Build from agent branch"

This reverts commit 47a060f65069877851df4bf9a7c56eb183eec0aa.
spikeburton added a commit that referenced this pull request Apr 22, 2025
* Bootstrap project

* Revert "Bootstrap project"

This reverts commit 1b12b8c.

* Bootstrap project

(cherry picked from commit 1b12b8c)

* Apply PR comments

* OK-2700 Implement authentication and list runners

* Rename context to ctx
Improve the logic for getting the runner scale sets

* Use independent http clients for app and auth clients

* Apply PR comments:
* Use log instead of fmt.Println
* Print all of the configuration-related errors at once instead of printing them one by one
* Add an alias to the hashicorp retryablehttp in to avoid ambiguity in the code

* Apply PR comments

* OK-2713 Implement communication between Orka runner app and GH (#4)

OK-2713 Implement communication between the Orka runner app and GH

* Add unit tests for helpers and gh config (#7)

* Add readme for the GH app and the required env vars for starting the Runner app (#6)

* Add readme for the GH app and the required env vars for starting the Runner app

* Add info for the VM_USERNAME and VM_PASSWORD

* Add CI workflow and dockerfile (#3)

* Add CI workflow

* Add dockerfile and deploy job

* Build from agent branch

* Revert "Build from agent branch"

This reverts commit 47a060f65069877851df4bf9a7c56eb183eec0aa.

* OK-2721 Deploy Orka VM and setup it as a GH agent (#5)

* OK-2721 Deploy Orka VM and setup it as a GH agent

* Use Orka CLI instead of Orka API

* Fix PR comments

* Fix formatting

* Apply PR comments

* Don't start separate shell for running orka CLI commands

* Run make tidy

* Add orka3 CLI in the docker container

* Add User directive

* Allow providing the GH app private key directly as a string (#8)

* Allow providing the GH app private key directly as a string

* Apply PR comments

* Implement async processing for CI builds (#9)

* Fail fast if there is no connectivity to the Orka cluster (#10)

* Throw an error when the vm-config or the image cannot be found (#11)

* Remove constraints on the minimum and maximum number of runners for a runnerscaleset (#12)

* Add retry logic when starting the Orka agent (#13)

* Add retry logic when starting the Orka agent

* Ensure the reqId is deleted from the canceledJobs map

* Enhance error handling when executing commands (#14)

* Check the permissions of the provided orka token (#15)

* Ensure no Orka VMs left in the cluster when canceling the CI build (#16)

* Respect provided namespace when deleting Orka VM (#17)

* Unify the format of the logs (#18)

* Improve readme files (#19)

* Add MIT LICENSE (#20)

* Allow using OCI images with the runner (#22)

* Allow using OCI images with the runner

* Add set -e

* Fix 409 error when creating JIT config (#23)

* Delete the runner manually on build cancel (#21)

* Fix the wrong method name (#24)

* Cancel VM SSH connection when build is canceled (#25)

* Add example .env file (#26)

* Add example .env file

* Address PR comments

* Don't source the `~/.bashrc` file (#29)

* Change docker image names (#30)

* Change docker image names

* Update readme.md

* OK-2816 Fix the default runner version (#31)

* OK-2816 Fix the default runner version

* Remove leading "v" from the latest version and improve the error message

* OK-2881 Add support for public IPs (#32)

* OK-2881 Enable use of public IPs

* Add node IP mapping support

* Update the readme.md and the examples

* Update Orka CLI version from CI

* OK-3055 Fix runner creation when an error occurs during provisioning (#33)

* Allow trailing backslashes on ORKA_URL

Strip a trailing backslash from the OrkaURL if there is one

* Allow both http and https domains for the ORKA_URL domain (#37)

Allow for https domains for orka url

* Change the docker image (#39)

* Run docker image as a non-root user (#41)

* WIP

* Fix lint errors

* Use USER 1000

* Use non-root orka user

* Export KUBECONFIG env (#42)

* OK-3166 Add support for VM metadata (#44)

* Add support for VM metadata

Users can now use the ORKA_VM_METADATA env variable to pass metadata to the VM

* Add examples

* Add development guide (#45)

* Add development guide

* Fix PR comments

* Fix PR comment

* Update GoLang to 1.23 (#48)

* OK-3378 Add runner name validation (#47)

Add runner name validation

Previously users were able to create runners with names that are valid for GitHub, but not for Orka VMs.
Making it impossible to deploy VMs.

Add the same validation for runner names as for Orka VMs. The alternative is to normalise the runner name at runtime, but this is error prone and can lead to confusing behavior (if there is name clashing for example).
This is not a breaking change as runners with invalid names do not work anyways

* Update information for using private keys (#49)

* OK-3167 Update readme with information from public repo (#50)

* update README with information from public repo

* update README with env var configuration

* remove redundant GITHUB_APP_ID env var

* add link to GitHub app setup guide

* add note about GHES

* Remove MIT license (#51)

remove MIT license

* Add Apache 2.0 license (#52)

* Create LICENSE

* add NOTICE and update README

* add header to attribute ARC project

---------

Co-authored-by: Fatme <[email protected]>
Co-authored-by: Connor Flanagan <[email protected]>
Co-authored-by: Ivan Spasov <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants