Merge pull request #12 from tdegeus/patch

Adding environment-name option

.github/workflows/options.yml

@@ -0,0 +1,50 @@
+name: options
+on:
+  push:
+    branches:
+      - main
+  pull_request: null
+
+jobs:
+  test:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [windows-latest, ubuntu-latest, macos-latest]
+    name: option
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: install mamba
+        uses: ./
+        with:
+          environment-file: environment.yml
+          environment-name: myenv
+
+      - name: run python in powershell
+        shell: powershell
+        run: |
+          python -VV
+          python -c "import numpy"
+        if: runner.os == 'Windows'
+
+      - name: run python in bash
+        shell: bash -l {0}
+        run: |
+          python -VV
+          python -c "import numpy"
+          micromamba --help
+        if: runner.os != 'Windows'
+
+      - name: test environment name in powershell
+        shell: powershell
+        run: |
+          python -c "import os; env = os.environ['CONDA_PREFIX'].split('\\')[-1]; assert env == 'myenv'"
+        if: runner.os == 'Windows'
+
+      - name: test environment name in bash
+        shell: bash -l {0}
+        run: |
+          python -c "import os; env = os.environ['CONDA_PREFIX'].split('/')[-1]; assert env == 'myenv'"
+        if: runner.os != 'Windows'

README.md

@@ -9,6 +9,12 @@ GitHub Action to provision a CI instance using micromamba
 
 **Optional** The the `environment.yml` file for the conda environment. Default is `environment.yml`
 
+### `environment-name`
+
+**Optional** Specify a custom environment name, 
+to overwrite the name specified in the `environment.yml`, 
+or in in case it was not specified in the `environment.yml`.
+
 ## Example usage
 
 ```
@@ -39,6 +45,27 @@ jobs:
           python -c "import numpy"
 ```
 
+## Example with customization
+
+```
+name: test
+on:
+  push: null
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    name: test
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: install mamba
+        uses: mamba-org/provision-with-micromamba@main
+        with:
+          - environment-file: myenv.yaml
+          - environment-name: myenv
+```
+
 ## Development
 
 When developing, you need to

action.yml

@@ -8,6 +8,9 @@ inputs:
     description: 'the environment.yml file for the conda environment'
     required: true
     default: environment.yml
+  environment-name:
+    description: 'the name of the conda environment (defaults to name from the environment.yml file)'
+    required: false
 runs:
   using: 'node12'
   main: 'dist/index.js'

dist/index.js

@@ -50,7 +50,7 @@ async function run () {
     const envFileName = core.getInput('environment-file')
     const envFilePath = path.join(process.env.GITHUB_WORKSPACE || '', envFileName)
     const envYaml = yaml.safeLoad(fs.readFileSync(envFilePath, 'utf8'))
-    const envName = envYaml.name
+    const envName = core.getInput('environment-name') || envYaml.name
     const condarc = path.join(os.homedir(), '.condarc')
     const profile = path.join(os.homedir(), '.bash_profile')
     const bashrc = path.join(os.homedir(), '.bashrc')
@@ -110,7 +110,7 @@ async function run () {
 
       // final bits of the install
       await execute('mkdir -p ' + path.join(os.homedir(), 'micromamba/pkgs/'))
-      await execute('source ' + profile + ' && micromamba create --strict-channel-priority -y -f ' + envFilePath)
+      await execute('source ' + profile + ' && micromamba create -n ' + envName + ' --strict-channel-priority -y -f ' + envFilePath)
       fs.appendFileSync(profile, 'set -eo pipefail\n')
       fs.appendFileSync(profile, 'micromamba activate ' + envName + '\n')
       core.endGroup()
@@ -141,7 +141,7 @@ else
       // Can only init once right now ...
       // await execPwsh(".\\micromamba.exe shell init -s bash -p $HOME\\micromamba")
       await execPwsh('MD $HOME\\micromamba\\pkgs -ea 0')
-      await execPwsh(`.\\micromamba.exe create --strict-channel-priority -y -f ${envFilePath}`)
+      await execPwsh(`.\\micromamba.exe create -n ` + envName + ` --strict-channel-priority -y -f ${envFilePath}`)
       await execPwsh(autoactivate)
 
       fs.appendFileSync(profile, `micromamba activate ${envName}\n`)

index.js

@@ -43,7 +43,7 @@ async function run () {
     const envFileName = core.getInput('environment-file')
     const envFilePath = path.join(process.env.GITHUB_WORKSPACE || '', envFileName)
     const envYaml = yaml.safeLoad(fs.readFileSync(envFilePath, 'utf8'))
-    const envName = envYaml.name
+    const envName = core.getInput('environment-name') || envYaml.name
     const condarc = path.join(os.homedir(), '.condarc')
     const profile = path.join(os.homedir(), '.bash_profile')
     const bashrc = path.join(os.homedir(), '.bashrc')
@@ -103,7 +103,7 @@ async function run () {
 
       // final bits of the install
       await execute('mkdir -p ' + path.join(os.homedir(), 'micromamba/pkgs/'))
-      await execute('source ' + profile + ' && micromamba create --strict-channel-priority -y -f ' + envFilePath)
+      await execute('source ' + profile + ' && micromamba create -n ' + envName + ' --strict-channel-priority -y -f ' + envFilePath)
       fs.appendFileSync(profile, 'set -eo pipefail\n')
       fs.appendFileSync(profile, 'micromamba activate ' + envName + '\n')
       core.endGroup()
@@ -134,7 +134,7 @@ else
       // Can only init once right now ...
       // await execPwsh(".\\micromamba.exe shell init -s bash -p $HOME\\micromamba")
       await execPwsh('MD $HOME\\micromamba\\pkgs -ea 0')
-      await execPwsh(`.\\micromamba.exe create --strict-channel-priority -y -f ${envFilePath}`)
+      await execPwsh(`.\\micromamba.exe create -n ` + envName + ` --strict-channel-priority -y -f ${envFilePath}`)
       await execPwsh(autoactivate)
 
       fs.appendFileSync(profile, `micromamba activate ${envName}\n`)