Skip to content

Commit

Permalink
add github actions to build instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
aryarm authored Mar 1, 2024
1 parent 7c09810 commit 1fa72cc
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
```
Expand Down Expand Up @@ -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.
## 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.

0 comments on commit 1fa72cc

Please sign in to comment.