diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..4f8fa7f --- /dev/null +++ b/LICENSE @@ -0,0 +1,26 @@ +Copyright 2025 United Kingdom Research and Innovation + +Authors: Steven Gillies, Alex Hayward, Hannah Collingwood (Telespazio UK) + +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. \ No newline at end of file diff --git a/README.md b/README.md index 41358c5..de8bec5 100644 --- a/README.md +++ b/README.md @@ -1 +1,37 @@ # GitHub Actions + +This repository contains workflows for GitHub actions used by the EO-DataHub. They can be used as per the following example: + +``` +jobs: + pre-commit-preparation: + name: Pre-commit + runs-on: ubuntu-latest + permissions: + contents: read + steps: + - uses: actions/checkout@v3 + - uses: actions/setup-python@v3 + + - name: Copy config + run: | + if [ ! -f .pre-commit-config.yaml ]; then + curl -o .pre-commit-config.yaml https://raw.githubusercontent.com/EO-DataHub/github-actions/main/.pre-commit-config-python.yaml + fi + + - uses: pre-commit/action@v3.0.1 + + security-scan: + name: Call Security Scan + permissions: + contents: read + uses: EO-DataHub/github-actions/.github/workflows/security.yaml@main + + unit-tests: + name: Run unit tests + permissions: + contents: read + uses: EO-DataHub/github-actions/.github/workflows/unit-tests-python.yaml@main + with: + PYTHON_VERSION: "3.12" +``` \ No newline at end of file