diff --git a/.github/MAINTAINERS_GUIDE.md b/.github/MAINTAINERS_GUIDE.md index 2cf8aad..19c1e1f 100644 --- a/.github/MAINTAINERS_GUIDE.md +++ b/.github/MAINTAINERS_GUIDE.md @@ -93,6 +93,13 @@ A smart plug and Emporia credentials are needed for this to be successful. When changes are proposed or made to the remote repository, the full test suite is performed to verify stability in any changes. +A [**new self-hosted runner**][runner] with a connected device can be brought +online to test changes with custom values for variables: + +- `EMPORIA_DEVICE` +- `EMPORIA_USERNAME` +- `EMPORIA_PASSWORD` + Additionally, some change to the `CHANGELOG.md` is checked for on pull requests. ## Updating the wiki @@ -204,5 +211,6 @@ $ spctl -a -vvv -t install ./etime [learn_go]: https://go.dev/learn/ [nix]: https://zero-to-nix.com [releases]: https://github.com/zimeg/emporia-time/releases +[runner]: https://docs.github.com/en/actions/hosting-your-own-runners/managing-self-hosted-runners/adding-self-hosted-runners [semver]: https://semver.org/spec/v2.0.0.html [wiki]: https://github.com/zimeg/emporia-time/wiki diff --git a/.github/runners/.gitignore b/.github/runners/.gitignore deleted file mode 100644 index c7b39ca..0000000 --- a/.github/runners/.gitignore +++ /dev/null @@ -1,3 +0,0 @@ -_work -.env -.path diff --git a/.github/runners/README.md b/.github/runners/README.md deleted file mode 100644 index 539be0a..0000000 --- a/.github/runners/README.md +++ /dev/null @@ -1,20 +0,0 @@ -# Runners - -A self-hosted runner is used to verify valid measurements are made when -monitoring energy usage during the remote integration tests. - -To bring the runner online, [add a **New self-hosted runner**][runner] using a -device connected to a smart plug: - -```sh -$ nix develop .#gh -$ cd . -$ config.sh # https://github.com/zimeg/emporia-time/settings/actions/runners/new -$ run.sh -``` - -Then set values for `EMPORIA_DEVICE`, `EMPORIA_USERNAME`, and `EMPORIA_PASSWORD` -in your action repository secrets using your Emporia information. Also add these -for Dependabot to configure this workflow. - -[runner]: https://docs.github.com/en/actions/hosting-your-own-runners/managing-self-hosted-runners/adding-self-hosted-runners diff --git a/CHANGELOG.md b/CHANGELOG.md index 66b0f2d..390b3e7 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -13,6 +13,7 @@ to [Semantic Versioning][semver]. - Wait until tests pass before merging updates to dependencies - Find missing references that the above changes might expect - Check that upstream merges do not let dependencies skip test +- Setup the self hosted runner on other computed configuration ## [1.1.1] - 2024-09-08 diff --git a/flake.nix b/flake.nix index ef37c6d..1eb2f21 100644 --- a/flake.nix +++ b/flake.nix @@ -29,11 +29,6 @@ go mod tidy ''; }; - devShells.gh = pkgs.mkShell { - packages = with pkgs; [ - github-runner - ]; - }; devShells.gon = if pkgs.stdenv.isDarwin then pkgs.mkShell