Skip to content

Commit 57c3f85

Browse files
yaswantyaswant
authored
Update license information and unified copyright statements across workflows (#45)
1 parent abbdcf8 commit 57c3f85

17 files changed

Lines changed: 166 additions & 108 deletions

File tree

‎.github/workflows/build-sphinx-docs.yaml‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# ------------------------------------------------------------------------------
2-
# (c) Crown copyright Met Office. All rights reserved.
3-
# The file LICENCE, distributed with this code, contains details of the terms
4-
# under which the code may be used.
2+
# (c) Crown copyright Met Office. All rights reserved.
3+
# The file LICENCE, distributed with this code, contains details of the terms
4+
# under which the code may be used.
55
# ------------------------------------------------------------------------------
66

77
name: Build Sphinx Docs
@@ -52,7 +52,7 @@ jobs:
5252
BUILD_DIR: ${{ inputs.build-directory }}
5353
steps:
5454
- name: Checkout repository
55-
uses: actions/checkout@v5
55+
uses: actions/checkout@v6
5656

5757
- name: Set up Python 3.12
5858
uses: actions/setup-python@v6

‎.github/workflows/check-cr-approved.yaml‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
# ------------------------------------------------------------------------------
2+
# (c) Crown copyright Met Office. All rights reserved.
3+
# The file LICENCE, distributed with this code, contains details of the terms
4+
# under which the code may be used.
5+
# ------------------------------------------------------------------------------
6+
17
name: Check CR Approval
28

39
on:

‎.github/workflows/cla-check.yaml‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
11
# ------------------------------------------------------------------------------
2-
# (c) Crown copyright Met Office. All rights reserved.
3-
# The file LICENCE, distributed with this code, contains details of the terms
4-
# under which the code may be used.
2+
# (c) Crown copyright Met Office. All rights reserved.
3+
# The file LICENCE, distributed with this code, contains details of the terms
4+
# under which the code may be used.
55
# ------------------------------------------------------------------------------
6+
67
name: CLA Checker
78
on:
89
workflow_call:

‎.github/workflows/deploy-sphinx-docs.yaml‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# ------------------------------------------------------------------------------
2-
# (c) Crown copyright Met Office. All rights reserved.
3-
# The file LICENCE, distributed with this code, contains details of the terms
4-
# under which the code may be used.
2+
# (c) Crown copyright Met Office. All rights reserved.
3+
# The file LICENCE, distributed with this code, contains details of the terms
4+
# under which the code may be used.
55
# ------------------------------------------------------------------------------
66

77
name: Deploy Sphinx Docs

‎.github/workflows/fortran-lint.yaml‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# ------------------------------------------------------------------------------
2-
# (c) Crown copyright Met Office. All rights reserved.
3-
# The file LICENCE, distributed with this code, contains details of the terms
4-
# under which the code may be used.
2+
# (c) Crown copyright Met Office. All rights reserved.
3+
# The file LICENCE, distributed with this code, contains details of the terms
4+
# under which the code may be used.
55
# ------------------------------------------------------------------------------
66

77
name: Lint
@@ -35,7 +35,7 @@ jobs:
3535

3636
steps:
3737
- name: Checkout repository
38-
uses: actions/checkout@v5
38+
uses: actions/checkout@v6
3939

4040
- name: Setup uv and Python ${{ env.UV_PYTHON }}
4141
uses: astral-sh/setup-uv@v7

‎.github/workflows/label-pr.yaml‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
# ------------------------------------------------------------------------------
2+
# (c) Crown copyright Met Office. All rights reserved.
3+
# The file LICENCE, distributed with this code, contains details of the terms
4+
# under which the code may be used.
5+
# ------------------------------------------------------------------------------
6+
17
name: Label PR
28

39
on:

‎.github/workflows/umdp3_fixer.yaml‎

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,9 @@
1-
---
1+
# ------------------------------------------------------------------------------
2+
# (c) Crown copyright Met Office. All rights reserved.
3+
# The file LICENCE, distributed with this code, contains details of the terms
4+
# under which the code may be used.
5+
# ------------------------------------------------------------------------------
6+
27
name: Fix UMDP3
38

49
on:
@@ -24,18 +29,18 @@ jobs:
2429

2530
steps:
2631
- name: Checkout Branch
27-
uses: actions/checkout@v4
32+
uses: actions/checkout@v6
2833
with:
2934
path: pr_branch
3035
token: ${{ secrets.GITHUB_TOKEN }}
3136
- name: Checkout SimSys_Scripts
32-
uses: actions/checkout@v4
37+
uses: actions/checkout@v6
3338
with:
3439
repository: MetOffice/SimSys_Scripts
3540
sparse-checkout: umdp3_fixer
3641
path: SimSys_Scripts
3742
- name: Set up Python 3.14
38-
uses: actions/setup-python@v5
43+
uses: actions/setup-python@v6
3944
with:
4045
python-version: 3.14
4146
- name: Run UMDP3 Fixer

‎.github/workflows/validate.yaml‎

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
# ------------------------------------------------------------------------------
2+
# (c) Crown copyright Met Office. All rights reserved.
3+
# The file LICENCE, distributed with this code, contains details of the terms
4+
# under which the code may be used.
5+
# ------------------------------------------------------------------------------
6+
17
name: CI
28
# This workflow is used for validating code quality on growss PRs.
39

@@ -24,7 +30,7 @@ jobs:
2430
UV_PYTHON: "3.14"
2531

2632
steps:
27-
- uses: actions/checkout@v5
33+
- uses: actions/checkout@v6
2834

2935
- name: Setup uv
3036
uses: astral-sh/setup-uv@v7

‎LICENCE‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
BSD 3-Clause Licence
2+
3+
Crown Copyright (c) Met Office
4+
5+
Redistribution and use in source and binary forms, with or without modification,
6+
are permitted provided that the following conditions are met:
7+
8+
1. Redistributions of source code must retain the above copyright notice, this
9+
list of conditions and the following disclaimer.
10+
11+
2. Redistributions in binary form must reproduce the above copyright notice,
12+
this list of conditions and the following disclaimer in the documentation
13+
and/or other materials provided with the distribution.
14+
15+
3. Neither the name of the copyright holder nor the names of its contributors
16+
may be used to endorse or promote products derived from this software without
17+
specific prior written permission.
18+
19+
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
20+
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
21+
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
22+
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
23+
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
24+
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
25+
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
26+
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27+
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
28+
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

‎build-sphinx-docs/README.md‎

Lines changed: 15 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,11 @@ documentation from a local repository to GitHub Pages.
55

66
## Usage
77

8-
To use this workflow developers must have a `requirements.txt` file to define
9-
the sphinx dependencies that will be used by the `build-sphinx-docs` workflow.
10-
By default the workflow will look for a `requirements.txt` file in the top
11-
level of the calling project repository. An example of a `requirements.txt`
12-
file which could run this workflow would be as follows:
8+
To use this workflow developers must have a `requirements.txt` file to define
9+
the sphinx dependencies that will be used by the `build-sphinx-docs` workflow.
10+
By default the workflow will look for a `requirements.txt` file in the top level
11+
of the calling project repository. An example of a `requirements.txt` file which
12+
could run this workflow would be as follows:
1313

1414
### Example requirements
1515

@@ -53,9 +53,10 @@ Here the user would implement this file and replace each of the parameters with
5353
the respective data types as dictated by the inputs section of the
5454
`build-sphinx-docs.yaml` file.
5555

56-
Following the calling of the `build-sphinx-docs` workflow, the `deploy-sphinx-docs`
57-
workflow can be used to deploy the generated html documentation to the GitHub
58-
webserver. This workflow can be called from a workflow using the form describe below:
56+
Following the calling of the `build-sphinx-docs` workflow, the
57+
`deploy-sphinx-docs` workflow can be used to deploy the generated html
58+
documentation to the GitHub webserver. This workflow can be called from a
59+
workflow using the form describe below:
5960

6061
### Deploy built HTML to GitHub Pages
6162

@@ -69,10 +70,10 @@ steps:
6970
timeout: Timeout for the job in minutes (5)
7071
```
7172

72-
Both of these steps can be combined to produce a simple build and deploy documentation
73-
pipeline for a repository:
73+
Both of these steps can be combined to produce a simple build and deploy
74+
documentation pipeline for a repository:
7475

75-
### Example continuous intergration pipeline in an external repository
76+
### Example continuous integration pipeline in an external repository
7677

7778
An example workflow to build Sphinx documentation and deploy it to GitHub Pages
7879
when changes are pushed to the `main` branch:
@@ -92,9 +93,9 @@ jobs:
9293
requirements: /path/to/requirements.txt
9394
runner: ubuntu-24.04
9495
timeout: 10
95-
docs-directory: '/path/to/documentation'
96-
sphinx-opts: 'extra options'
97-
build-directory: '/path/to/build/html'
96+
docs-directory: "/path/to/documentation"
97+
sphinx-opts: "extra options"
98+
build-directory: "/path/to/build/html"
9899
99100
deploy-docs:
100101
if: github.ref == 'refs/heads/main'

0 commit comments

Comments
 (0)