-
Notifications
You must be signed in to change notification settings - Fork 31
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
d56c2f3
commit defaf81
Showing
74 changed files
with
864 additions
and
1,309 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,14 +1,15 @@ | ||
| # Changes here will be overwritten by Copier | ||
| _commit: 1.0.0 | ||
| _commit: 2.3.0 | ||
| _src_path: gh:DiamondLightSource/python-copier-template | ||
| author_email: eva.lott@diamond.ac.uk | ||
| author_name: Eva Lott | ||
| component_owner: '' | ||
| description: '' | ||
| distribution_name: event-model | ||
| docker: false | ||
| docs_type: sphinx | ||
| git_platform: github.com | ||
| github_org: bluesky | ||
| package_name: event_model | ||
| pypi: true | ||
| repo_name: event-model | ||
| type_checker: mypy |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| --- | ||
| name: Bug Report | ||
| about: The template to use for reporting bugs and usability issues | ||
| title: " " | ||
| labels: 'bug' | ||
| assignees: '' | ||
|
|
||
| --- | ||
|
|
||
| Describe the bug, including a clear and concise description of the expected behavior, the actual behavior and the context in which you encountered it (ideally include details of your environment). | ||
|
|
||
| ## Steps To Reproduce | ||
| Steps to reproduce the behavior: | ||
| 1. Go to '...' | ||
| 2. Click on '....' | ||
| 3. Scroll down to '....' | ||
| 4. See error | ||
|
|
||
|
|
||
| ## Acceptance Criteria | ||
| - Specific criteria that will be used to judge if the issue is fixed |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,13 @@ | ||
| --- | ||
| name: Issue | ||
| about: The standard template to use for feature requests, design discussions and tasks | ||
| title: " " | ||
| labels: '' | ||
| assignees: '' | ||
|
|
||
| --- | ||
|
|
||
| A brief description of the issue, including specific stakeholders and the business case where appropriate | ||
|
|
||
| ## Acceptance Criteria | ||
| - Specific criteria that will be used to judge if the issue is fixed |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| Fixes #ISSUE | ||
|
|
||
| ### Instructions to reviewer on how to test: | ||
| 1. Do thing x | ||
| 2. Confirm thing y happens | ||
|
|
||
| ### Checks for reviewer | ||
| - [ ] Would the PR title make sense to a user on a set of release notes |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,60 +1,34 @@ | ||
| name: Install requirements | ||
| description: Run pip install with requirements and upload resulting requirements | ||
| description: Install a version of python then call pip install and report what was installed | ||
| inputs: | ||
| requirements_file: | ||
| description: Name of requirements file to use and upload | ||
| required: true | ||
| install_options: | ||
| python-version: | ||
| description: Python version to install, default is from Dockerfile | ||
| default: "dev" | ||
| pip-install: | ||
| description: Parameters to pass to pip install | ||
| required: true | ||
| artifact_name: | ||
| description: A user friendly name to give the produced artifacts | ||
| required: true | ||
| python_version: | ||
| description: Python version to install | ||
| default: "3.x" | ||
| default: "$([ -f dev-requirements.txt ] && echo '-c dev-requirements.txt') -e .[dev]" | ||
|
|
||
| runs: | ||
| using: composite | ||
|
|
||
| steps: | ||
| - name: Get version of python | ||
| run: | | ||
| PYTHON_VERSION="${{ inputs.python-version }}" | ||
| if [ $PYTHON_VERSION == "dev" ]; then | ||
| PYTHON_VERSION=$(sed -n "s/ARG PYTHON_VERSION=//p" Dockerfile) | ||
| fi | ||
| echo "PYTHON_VERSION=$PYTHON_VERSION" >> "$GITHUB_ENV" | ||
| shell: bash | ||
|
|
||
| - name: Setup python | ||
| uses: actions/setup-python@v5 | ||
| with: | ||
| python-version: ${{ inputs.python_version }} | ||
| python-version: ${{ env.PYTHON_VERSION }} | ||
|
|
||
| - name: Pip install | ||
| run: | | ||
| touch ${{ inputs.requirements_file }} | ||
| # -c uses requirements.txt as constraints, see 'Validate requirements file' | ||
| pip install -c ${{ inputs.requirements_file }} ${{ inputs.install_options }} | ||
| - name: Install packages | ||
| run: pip install ${{ inputs.pip-install }} | ||
| shell: bash | ||
|
|
||
| - name: Create lockfile | ||
| run: | | ||
| mkdir -p lockfiles | ||
| pip freeze --exclude-editable > lockfiles/${{ inputs.requirements_file }} | ||
| # delete the self referencing line and make sure it isn't blank | ||
| sed -i'' -e '/file:/d' lockfiles/${{ inputs.requirements_file }} | ||
| shell: bash | ||
|
|
||
| - name: Upload lockfiles | ||
| uses: actions/upload-artifact@v4.0.0 | ||
| with: | ||
| name: lockfiles-${{ inputs.python_version }}-${{ inputs.artifact_name }}-${{ github.sha }} | ||
| path: lockfiles | ||
|
|
||
| # This eliminates the class of problems where the requirements being given no | ||
| # longer match what the packages themselves dictate. E.g. In the rare instance | ||
| # where I install some-package which used to depend on vulnerable-dependency | ||
| # but now uses good-dependency (despite being nominally the same version) | ||
| # pip will install both if given a requirements file with -r | ||
| - name: If requirements file exists, check it matches pip installed packages | ||
| run: | | ||
| if [ -s ${{ inputs.requirements_file }} ]; then | ||
| if ! diff -u ${{ inputs.requirements_file }} lockfiles/${{ inputs.requirements_file }}; then | ||
| echo "Error: ${{ inputs.requirements_file }} need the above changes to be exhaustive" | ||
| exit 1 | ||
| fi | ||
| fi | ||
| - name: Report what was installed | ||
| run: pip freeze | ||
| shell: bash |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.