aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorJoseph Hunkeler <jhunkeler@users.noreply.github.com>2024-06-24 11:23:26 -0400
committerGitHub <noreply@github.com>2024-06-24 11:23:26 -0400
commitabe87056faa6ed02aff3bbf77c1fd78b713a0864 (patch)
treee97960b2393979e6c05bab40c610083e5925cd0a /README.md
parent27c475ccd857ca6f75605938ee0d83e13973672d (diff)
downloadstasis-abe87056faa6ed02aff3bbf77c1fd78b713a0864.tar.gz
Pass .ci_support/plat_arch_.yaml to conda-build (#8)
* Pass .ci_support/plat_arch_.yaml to conda-build * Fixes a few outstanding leaks in delivery context * Move micromamba function out of stasis_indexer.c * Adjust code in the indexer to accommodate the move. The function now expects a MicromambaInfo structure as its first argument. * Add missing warning message * User is informed when pandoc is not available for HTML page generation * Initialize workdir_template string to zero * Add micromamba program to runtime PATH * Expose storage.tools_dir to template engine * Remove dead code * Fix wording in comment * Fix conda-forge builds * Pass their .ci_support configurations to conda-build in order to fully set up their build runtime environment * Add get_cpu_count() * Exposes STASIS_CPU_COUNT and CPU_COUNT to the runtime environment * Implements conda reactivation template string * {{ workaround.conda_reactivate }} * This is useful to call after installing any conda packages within a test.script * Fix conda runtime inside of test.script * This ensures conda and mamba are fully initialized. * Previous behavior only placed the commands on the PATH but didn't provide any shell macros (i.e. undefined behavior) * Document CPU_COUNT and workaround.conda_reactivate
Diffstat (limited to 'README.md')
-rw-r--r--README.md88
1 files changed, 45 insertions, 43 deletions
diff --git a/README.md b/README.md
index b1d6d25..c3e9db6 100644
--- a/README.md
+++ b/README.md
@@ -143,20 +143,21 @@ stasis mydelivery.ini
## Environment variables
-| Name | Purpose |
-|------------------------------|-------------------------------------------------------|
-| TMPDIR | Change default path to store temporary data |
-| STASIS_ROOT | Change default path to write STASIS's data |
-| STASIS_SYSCONFDIR | Change default path to search for configuration files |
-| STASIS_JF_ARTIFACTORY_URL | Artifactory service URL (ending in `/artifactory`) |
-| STASIS_JF_ACCESS_TOKEN | Artifactory Access Token |
-| STASIS_JF_USER | Artifactory username |
-| STASIS_JF_PASSWORD | Artifactory password |
-| STASIS_JF_SSH_KEY_PATH | Path to SSH public key file |
-| STASIS_JF_SSH_PASSPHRASE | Password associated with SSH public key file |
-| STASIS_JF_CLIENT_CERT_CERT_PATH | Path to OpenSSL cert files |
-| STASIS_JF_CLIENT_CERT_KEY_PATH | OpenSSL key file (in cert path) |
-| STASIS_JF_REPO | Artifactory "generic" repository to write to |
+| Name | Purpose |
+|-------------------------------------|-------------------------------------------------------|
+| TMPDIR | Change default path to store temporary data |
+| STASIS_ROOT | Change default path to write STASIS's data |
+| STASIS_SYSCONFDIR | Change default path to search for configuration files |
+| STASIS_CPU_COUNT (alias: CPU_COUNT) | Number of available CPUS |
+| STASIS_JF_ARTIFACTORY_URL | Artifactory service URL (ending in `/artifactory`) |
+| STASIS_JF_ACCESS_TOKEN | Artifactory Access Token |
+| STASIS_JF_USER | Artifactory username |
+| STASIS_JF_PASSWORD | Artifactory password |
+| STASIS_JF_SSH_KEY_PATH | Path to SSH public key file |
+| STASIS_JF_SSH_PASSPHRASE | Password associated with SSH public key file |
+| STASIS_JF_CLIENT_CERT_CERT_PATH | Path to OpenSSL cert files |
+| STASIS_JF_CLIENT_CERT_KEY_PATH | OpenSSL key file (in cert path) |
+| STASIS_JF_REPO | Artifactory "generic" repository to write to |
# Variable expansion
@@ -164,35 +165,36 @@ stasis mydelivery.ini
Template strings can be accessed using the `{{ subject.key }}` notation in any STASIS configuration file.
-| Name | Purpose |
-|----------------------------|------------------------------------------------------------------------------------------------------------------------|
-| meta.name | Delivery name |
-| meta.version | Delivery version |
-| meta.codename | Delivery codename |
-| meta.mission | Delivery mission |
-| meta.python | Python version (e.g. 3.11) |
-| meta.python_compact | Python (e.g. 311) |
-| info.time_str_epoch | UNIX Epoch timestamp |
-| info.release_name | Rendered delivery release name |
-| info.build_name | Rendered delivery build name |
-| info.build_number | Rendered delivery build number |
-| storage.tmpdir | Ohymcal temp directory |
-| storage.delivery_dir | STASIS delivery output directory |
-| storage.results_dir | STASIS test results directory |
-| storage.conda_artifact_dir | STASIS conda package directory |
-| storage.wheel_artifact_dir | STASIS wheel package directory |
-| storage.build_sources_dir | STASIS sources directory |
-| storage.build_docker_dir | STASIS docker directory |
-| conda.installer_name | Conda distribution name |
-| conda.installer_version | Conda distribution version |
-| conda.installer_platform | Conda target platform |
-| conda.installer_arch | Conda target architecture |
-| conda.installer_baseurl | Conda installer URL |
-| system.arch | System CPU Architecture |
-| system.platform | System Platform (OS) |
-| deploy.docker.registry | Docker registry |
-| deploy.jfrog.repo | Artifactory destination repository |
-| workaround.tox_posargs | Return populated `-c` and `--root` tox arguments.<br/>Force-enables positional arguments in tox's command line parser. |
+| Name | Purpose |
+|-----------------------------|-------------------------------------------------------------------------------------------------------------------------|
+| meta.name | Delivery name |
+| meta.version | Delivery version |
+| meta.codename | Delivery codename |
+| meta.mission | Delivery mission |
+| meta.python | Python version (e.g. 3.11) |
+| meta.python_compact | Python (e.g. 311) |
+| info.time_str_epoch | UNIX Epoch timestamp |
+| info.release_name | Rendered delivery release name |
+| info.build_name | Rendered delivery build name |
+| info.build_number | Rendered delivery build number |
+| storage.tmpdir | Ohymcal temp directory |
+| storage.delivery_dir | STASIS delivery output directory |
+| storage.results_dir | STASIS test results directory |
+| storage.conda_artifact_dir | STASIS conda package directory |
+| storage.wheel_artifact_dir | STASIS wheel package directory |
+| storage.build_sources_dir | STASIS sources directory |
+| storage.build_docker_dir | STASIS docker directory |
+| conda.installer_name | Conda distribution name |
+| conda.installer_version | Conda distribution version |
+| conda.installer_platform | Conda target platform |
+| conda.installer_arch | Conda target architecture |
+| conda.installer_baseurl | Conda installer URL |
+| system.arch | System CPU Architecture |
+| system.platform | System Platform (OS) |
+| deploy.docker.registry | Docker registry |
+| deploy.jfrog.repo | Artifactory destination repository |
+| workaround.tox_posargs | Return populated `-c` and `--root` tox arguments.<br/>Force-enables positional arguments in tox's command line parser. |
+| workaround.conda_reactivate | Reinitialize the conda runtime environment.<br/>Use this after calling `conda install` from within a `[test:*].script`. |
The template engine also provides an interface to environment variables using the `{{ env:VARIABLE_NAME }}` notation.