From 96c3ec0350c7d295772988ff6cb20f645a518d83 Mon Sep 17 00:00:00 2001 From: Luc Perkins Date: Wed, 10 Jul 2024 08:31:02 -0700 Subject: [PATCH] Move development docs into separate Markdown file --- README.md | 17 +++-------------- docs/development.md | 15 +++++++++++++++ 2 files changed, 18 insertions(+), 14 deletions(-) create mode 100644 docs/development.md diff --git a/README.md b/README.md index a7efe491..2fca1676 100644 --- a/README.md +++ b/README.md @@ -74,20 +74,9 @@ jobs: | `source-tag` | The tag of `flakehub-push` to use. Conflicts with all other `source-*` options. | string | | | | `source-url` | A URL pointing to a `flakehub-push` binary. Overrides all other `source-*` options. | string | | | -## Development against a local Flakehub server - -Assuming the dev environment is running as described in the flakehub repo: - -```bash -export FLAKEHUB_PUSH_GITHUB_TOKEN="" -cargo run -- \ - --visibility public \ - --tag v0.1.0 \ - --repository DeterminateSystems/nix-installer \ - --git-root ../nix-installer \ - --jwt-issuer-uri http://localhost:8081/jwt/token \ - --host http://localhost:8080 -``` +## Developing `flakehub-push` + +See the [development docs](./docs/development.md). [flakehub]: https://flakehub.com [flakes]: https://zero-to-nix.com/concepts/flakes diff --git a/docs/development.md b/docs/development.md new file mode 100644 index 00000000..b3c14ce4 --- /dev/null +++ b/docs/development.md @@ -0,0 +1,15 @@ +## Developing `flakehub-push` + +You can run `flakehub-push` against a Flakehub server running locally. +Assuming the dev environment is running as described in the FlakeHub repo: + +```bash +export FLAKEHUB_PUSH_GITHUB_TOKEN="" +cargo run -- \ + --visibility public \ + --tag v0.1.0 \ + --repository DeterminateSystems/nix-installer \ + --git-root ../nix-installer \ + --jwt-issuer-uri http://localhost:8081/jwt/token \ + --host http://localhost:8080 +```