Merge pull request #131 from ImperialCollegeLondon/develop

Alpha release

.dockerignore

@@ -10,3 +10,5 @@
 !translations
 !static
 !assets
+!test_data
+test_data/10.14469_hpc_*

.github/ISSUE_TEMPLATE/feature-issue.md

@@ -0,0 +1,23 @@
+---
+name: Feature Issue
+about: A full issue covering feature development, testing and release
+title: "[Give the issue a sensible descriptive title]"
+assignees: ''
+
+---
+
+* PR: [when the PR is created, put a link to it here.  DO NOT use the "linked PR" feature]
+* User Test Scripts: [when there are user test scripts available link them here]
+
+---
+
+*Enter a description of the issue here*
+
+*You may also want to add some user stories or other reasons for opening this issue*
+
+# Acceptance Criteria
+
+*List the criteria which must be met for the issue to be considered complete*
+
+* Criteria 1 ...
+* Criteria 2 ...

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,31 @@
+* Issue: [Link to the issue.  Do not use any of the github automation keywords]
+
+---
+
+*Enter a brief description of the PR contents here*
+
+## Developer Checklist
+
+*Developers should review and confirm each of these items before requesting review*
+
+* [ ] Code meets acceptance criteria from issue
+* [ ] Unit tests are written and all pass
+* [ ] User Test Scripts (if required) are written and have been run through
+* [ ] Code documentation and related non-code documentation has all been updated
+
+## Reviewer Checklist
+
+*Reviewers should review and confirm each of these items before approval*
+*If there are multiple reviewers, this section can be duplicated for each reviewer*
+
+* [ ] Code meets acceptance criteria from issue
+* [ ] Unit tests are written and all pass
+* [ ] User Test Scripts (if required) are written and have been run through
+* [ ] Code documentation and related non-code documentation has all been updated
+* [ ] Migation has been created and tested
+
+## Testing
+
+*List user test scripts that need to be run*
+
+*List any non-unit test scripts that need to be run*

.github/workflows/ci.yml

@@ -4,6 +4,7 @@ on:
   pull_request:
     branches:
       - main
+      - develop
 
 jobs:
   qa:
@@ -28,6 +29,6 @@ jobs:
       - name: setup project virtual environment
         run: invenio-cli install
       - name: start services
-        run: invenio-cli services setup --no-demo-data
+        run: invenio-cli services start
       - name: run tests
         run: pipenv run pytest

.github/workflows/publish.yml

@@ -4,6 +4,7 @@ on:
   push:
     branches:
       - main
+      - develop
 
 jobs:
   build-and-publish:
@@ -32,7 +33,7 @@ jobs:
         uses: docker/metadata-action@v4
         with:
           images: ghcr.io/${{ github.repository }}
-          tags: type=raw,value=frontend-main
+          tags: type=raw,value=frontend-${{ github.ref_name }}
       - name: Build and push frontend Docker image
         uses: docker/build-push-action@v4
         with:

.gitignore

@@ -73,3 +73,6 @@ data/.minio.sys
 
 # Celery
 celerybeat-schedule
+
+# test datasets
+test_data/10.14469_hpc_*

.pre-commit-config.yaml

@@ -27,3 +27,4 @@ repos:
       - id: mdformat
         additional_dependencies:
           - mdformat-gfm
+        exclude: ".github/*"

Dockerfile

@@ -26,4 +26,7 @@ RUN cp -r ./static/. ${INVENIO_INSTANCE_PATH}/static/ && \
     invenio collect --verbose  && \
     invenio webpack buildall
 
+# Make directory owned by Invenio user
+RUN chown -R invenio test_data/
+
 ENTRYPOINT [ "bash", "-c"]

LICENSE

@@ -0,0 +1,28 @@
+BSD 3-Clause License
+
+Copyright (c) 2024, Imperial College London
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Pipfile

@@ -7,6 +7,16 @@ verify_ssl = true
 check-manifest = ">=0.25"
 pre-commit = "*"
 pytest-invenio = "*"
+pytest-mypy = "*"
+mkdocs = "*"
+mkdocs-material = "*"
+mkdocs-gen-files = "*"
+mkdocs-literate-nav = "*"
+mkdocs-section-index = "*"
+mkdocstrings-python = "*"
+# Avoid pytest>=8 as dependency resolution is not giving a compatible version of pluggy
+# Manifests as: https://github.com/pytest-dev/pytest/issues/12144
+pytest = "<8"
 
 [packages]
 ic-data-repo = {editable=true, path="./site"}
@@ -16,7 +26,7 @@ uwsgi-tools = ">=1.1.1"
 # Avoid sqlalchemy-continuum==1.4.0 due to compatibility issue described here:
 # https://github.com/kvesteri/sqlalchemy-continuum/issues/351
 sqlalchemy-continuum = "!=1.4.0"
-invenio-app-rdm = {extras = ["opensearch2"], version = "~=12.0.0rc2"}
+invenio-app-rdm = {extras = ["opensearch2"], version = "~=12.0.0"}
 
 [requires]
 python_version = "3.9"