Merge pull request #15 from bids-apps/package

[ENH] Package

.dockerignore

@@ -1,12 +1,174 @@
 # ignoring this might speed up build
 # by preventing passing extra content to the docker daemon
+src/cat12/_version.py
 
 .simg
 
 tests/data
 
-env
-
 tmp
 
 docs/build
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/latest/usage/project/#working-with-version-control
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/

.github/workflows/docker.yml

@@ -23,15 +23,6 @@ jobs:
         -   uses: actions/checkout@v4
             with:
                 fetch-depth: 0
-        # # cache tarred docker image to speed up build on follow up runs
-        # -   uses: actions/cache@v4
-        #     id: cache
-        #     with:
-        #         path: ${{ env.IMAGE }}/image.tar
-        #         key: data
-        # -   if: ${{ steps.cache.outputs.cache-hit != 'true' }}
-        #     name: Load image
-        #     run: docker load -i ${{ env.IMAGE }}/image.tar
         -   name: Build the Docker image
             run: |
                 docker build . --tag ${{env.USER_NAME}}/${{env.REPO_NAME}}
@@ -137,3 +128,46 @@ jobs:
             with:
                 name: output_${{ matrix.type }}
                 path: /home/runner/work/cat12-container/cat12-container/tests/data/ds002799/derivatives
+
+    docker-push:
+        runs-on: ubuntu-latest
+        needs: [one-session]
+        defaults:
+            run:
+                shell: bash -el {0}
+        if: ${{ github.ref == 'refs/heads/main' || github.ref_type == 'tag' }}
+        steps:
+        -   uses: actions/checkout@v4
+            with:
+                fetch-depth: 0
+        -   name: Restore docker image
+            uses: actions/download-artifact@v4
+            with:
+                name: docker
+                path: ${{ env.IMAGE }}
+        -   name: Log in to Docker Hub
+            uses: docker/login-action@9780b0c442fbb1117ed29e0efdff1e18412f7567
+            with:
+                username: ${{ secrets.DOCKERHUB_USERNAME }}
+                password: ${{ secrets.DOCKERHUB_TOKEN }}
+        -   name: Load image
+            run: docker load -i ${{ env.IMAGE }}/image.tar
+        -   name: Push unstable to dockerhub on tags or on main
+            run: |
+                echo "Pushing unstable versions to DockerHub"
+                unstable="${{env.USER_NAME}}/${{env.REPO_NAME}}:unstable"
+                docker tag "${{env.USER_NAME}}/${{env.REPO_NAME}}" "${unstable}"
+                docker push "${unstable}"
+        -   name: Push stable release to dockerhub on tags only
+            if: ${{ github.ref_type == 'tag' }}
+            run: |
+                echo "Pushing stable and latest versions to DockerHub for latest and  ${{ github.ref_name }}"
+
+                unstable="${{env.USER_NAME}}/${{env.REPO_NAME}}:unstable"
+                latest="${{env.USER_NAME}}/${{env.REPO_NAME}}:latest"
+                docker tag "${unstable}" "${latest}"
+                docker push "${latest}"
+
+                tagged_release="${{env.USER_NAME}}/${{env.REPO_NAME}}:${{ github.ref_name }}"
+                docker tag "${unstable}" "${tagged_release}"
+                docker push "${tagged_release}"