From 1fa72ccfbab9e382e7498b3de90d4a9e3adc45da Mon Sep 17 00:00:00 2001 From: Arya Massarat <23412689+aryarm@users.noreply.github.com> Date: Fri, 1 Mar 2024 12:21:15 -0800 Subject: [PATCH] add github actions to build instructions --- README.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 517226a..8b1c6c0 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ Scripts, recipes, and docs for conda packages. Inspired by [jdblischak/jdb-conda](https://github.com/jdblischak/jdb-conda). -To build a local version of a package in this repository: +## Build a package in this repository locally 1. Clone this repository ``` @@ -42,4 +42,8 @@ To build a local version of a package in this repository: conda activate PACKAGE ``` -For maximum reproducibility, consider doing these steps within [a GitHub codespace](https://codespaces.new/aryarm/aryarm-conda). This will also allow you to skip steps 1-3. \ No newline at end of file +## Build a package in this repository in GitHub Codespaces +For your convenince, you may consider doing the steps above within [a GitHub codespace](https://codespaces.new/aryarm/aryarm-conda). This will also allow you to skip steps 1-3. You can then [download the built package](https://github.com/orgs/community/discussions/62388#discussioncomment-7281243) (located at `${CONDA_PREFIX}/conda-bld/`) from the codespace through the VSCode GUI. + +## Build a package in this repository in GitHub Actions (recommended) +Alternatively, you can skip steps 1-5 by simply forking this repository. This is probably the easiest method because it uses GitHub Actions to do all the work. Any commits to the `main` branch or to a pull request will trigger a bot to automatically rebuild packages from changed recipes and publish the built packages as [Github Artifacts](https://docs.github.com/en/actions/managing-workflow-runs/downloading-workflow-artifacts). You can then download an artifact, unzip it, and proceed with the resulting directory of files in place of the `${CONDA_PREFIX}/conda-bld/` path in step 6.