Merge pull request #37 from bschroeter/main

Conda release pipeline

Author: bschroeter

.conda/build_env.yaml

@@ -0,0 +1,12 @@
+# Required for 'Build and upload conda packages' workflow
+
+channels:
+  - conda-forge
+  - accessnri
+  - coecms
+  - default
+
+dependencies:
+  - anaconda-client
+  - conda-build
+  - versioneer

.conda/meorg_client_dev.yaml

@@ -0,0 +1,19 @@
+name: meorg_client_dev
+
+channels:
+  - conda-forge
+  - accessnri
+  - coecms
+  - defaults
+
+dependencies:
+  - python>=3.9
+  - requests>=2.31.0
+  - click>=8.1.7
+  - PyYAML>=6.0.1
+  - pip
+  - pytest
+  - black
+  - ruff
+  - pip:
+    - -r mkdocs-requirements.txt

.conda/meta.yaml

@@ -0,0 +1,32 @@
+{% set data = load_setup_py_data() %}
+{% set version = data.get('version') %}
+
+package:
+  name: meorg_client
+  version: "{{ version }}"
+
+source:
+  path: ..
+
+
+build:
+  noarch: python
+  number: 0
+  script: "{{ PYTHON }} -m pip install . -vv"
+
+
+requirements:
+  host:
+    - python >=3.9
+    - pip
+    - setuptools>=64
+    - versioneer
+  run:
+    - python >=3.9
+    - requests >=2.31.0
+    - click >=8.1.7
+    - PyYAML >=6.0.1
+
+test:
+  imports:
+    - meorg_client

.gitattributes

@@ -0,0 +1 @@
+meorg_client/_version.py export-subst

.github/workflows/cd.yml

@@ -0,0 +1,28 @@
+name: Conda Publish
+
+on:
+  release:
+    types: [released]
+
+jobs:
+  conda_deployment:
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+      - uses: conda-incubator/setup-miniconda@v2
+        with:
+          python-version: '3.9'
+          environment-file: .conda/build_env.yaml
+          auto-update-conda: false
+          auto-activate-base: false
+          show-channel-urls: true
+      - name: Build and upload the conda packages
+        uses: uibcdf/[email protected]
+        with:
+          python-version: '3.9'
+          meta_yaml_dir: .conda
+          user: bschroeter
+          label: main
+          token: ${{ secrets.ANACONDA_TOKEN_BEN }}

docs/contributing.md

@@ -0,0 +1,37 @@
+# Contributing
+
+The following outlines the process to contribute to meorg_client.
+
+## 1. Clone the repository
+
+```shell
+# Create a work space for repos
+mkdir -p $HOME/work
+
+# Move into it
+cd $HOME/work
+
+# Clone the repo
+git clone [email protected]:CABLE-LSM/meorg_client.git
+
+# Move into it
+cd meorg_client
+```
+
+## 2. Set up the dev environment
+
+```shell
+# Create the development environment
+conda env create -f .conda/meorg_client_dev.yaml
+```
+
+## 3. Install meorg_client in editable mode
+
+```shell
+# Install as editable
+pip install -e .
+```
+
+You can now edit the source code in your editor of choice and have changes immediately reflected in your environment for rapid development.
+
+Please follow the standard contribution guidelines in addressing issues for the project.

docs/releasing.md

@@ -0,0 +1,40 @@
+# Releasing
+
+Releases are generated from a stable main as needed to reflect developments and community needs.
+
+Release generation is restricted to project administrators.
+
+Releasing the client involves publishing a tagged release on Github:
+1. Go to https://github.com/CABLE-LSM/meorg_client/releases/new
+2. Under "Choose a tag", start typing a new release, following SemVer (without leading "v") and click "Create new tag X on publish".
+3. Ensure Target is set to "main".
+4. Generate release notes if applicable.
+5. Enter the tag you set in (2) WITH a leading "v".
+6. Edit the release description as needed.
+7. Set as the latest release.
+8. Click "Publish release".
+
+## Testing the release
+
+To test the release prior to actually releasing the code, you can approximate the build and publication process locally.
+
+```shell
+# Move into the repo directory
+cd $HOME/work/meorg_client
+
+# Create a build environment
+conda env create -n meorg_client_build -f .conda/build_env.yaml
+
+# Activate the environment
+conda activate meorg_client_build
+
+# Build the project
+conda build .
+
+# If it worked, install the local package
+conda install --use-local meorg_client
+```
+
+The build should exit immediately upon failure, however, there may be silent errors that can occur, such as no version number on either the pip or conda package (see the logs and look for "None" or "0.0.0" in build artefacts). In this case, there would be a failure in the upload to anaconda.org in the Github Action.
+
+Most users will generally not need to test the build and release process for typical development tasks.

meorg_client/__init__.py

@@ -1 +1,5 @@
 """Root init file."""
+
+from . import _version
+
+__version__ = _version.get_versions()["version"]