|
1 | | -# Analytical Platform Airflow Python Template |
2 | | - |
3 | | -[](https://operations-engineering-reports.cloud-platform.service.justice.gov.uk/public-report/analytical-platform-airflow-python-template) |
4 | | - |
5 | | -This template repository equips you with the default initial files required for an Analytical Platform Airflow workflow. |
6 | | - |
7 | | -## Included Files |
8 | | - |
9 | | -The repository comes with the following preset files: |
10 | | - |
11 | | -- GitHub Actions workflows |
12 | | - - Dependency review (if your repository is public) (`.github/workflows/dependency-review.yml`) |
13 | | - - Container release to Analytical Platform's ECR (`.github/workflows/release-container.yml`) |
14 | | - - Container scan with Trivy (`.github/workflows/scan-container.yml`) |
15 | | - - Container structure test (`.github/workflows/test-container.yml`) |
16 | | -- CODEOWNERS |
17 | | -- Dependabot configuration |
18 | | -- Dockerfile |
19 | | -- MIT License |
20 | | - |
21 | | -## Setup Instructions |
22 | | - |
23 | | -Once you've created your repository using this template, ensure the following steps: |
24 | | - |
25 | | -### Update README |
26 | | - |
27 | | -Edit this README.md file to document your project accurately. Take the time to create a clear, engaging, and informative README.md file. Include information like what your project does, how to install and run it, how to contribute, and any other pertinent details. |
28 | | - |
29 | | -### Update repository description |
30 | | - |
31 | | -After you've created your repository, GitHub provides a brief description field that appears on the top of your repository's main page. This is a summary that gives visitors quick insight into the project. Using this field to provide a succinct overview of your repository is highly recommended. |
32 | | - |
33 | | -This description and your README.md will be one of the first things people see when they visit your repository. It's a good place to make a strong, concise first impression. Remember, this is often visible in search results on GitHub and search engines, so it's also an opportunity to help people discover your project. |
34 | | - |
35 | | -### Grant Team Permissions |
36 | | - |
37 | | -Assign permissions to the appropriate Ministry of Justice teams. Ensure at least one team is granted Admin permissions. Whenever possible, assign permissions to teams rather than individual users. |
38 | | - |
39 | | -### Read about the GitHub repository standards |
40 | | - |
41 | | -Familiarise yourself with the Ministry of Justice GitHub Repository Standards. These standards ensure consistency, maintainability, and best practices across all our repositories. |
42 | | - |
43 | | -You can find the standards [here](https://user-guide.operations-engineering.service.justice.gov.uk/documentation/information/mojrepostandards.html). |
44 | | - |
45 | | -Please read and understand these standards thoroughly and enable them when you feel comfortable. |
46 | | - |
47 | | -### Modify the GitHub Standards Badge |
48 | | - |
49 | | -Once you've ensured that all the [GitHub Repository Standards](https://user-guide.operations-engineering.service.justice.gov.uk/documentation/information/mojrepostandards.html) have been applied to your repository, it's time to update the Ministry of Justice (MoJ) Compliance Badge located in the README file. |
50 | | - |
51 | | -The badge demonstrates that your repository is compliant with MoJ's standards. Please follow these [instructions](https://user-guide.operations-engineering.service.justice.gov.uk/documentation/information/add-repo-badge.html) to modify the badge URL to reflect the status of your repository correctly. |
52 | | - |
53 | | -**Please note** the badge will not function correctly if your repository is internal or private. In this case, you may remove the badge from your README. |
54 | | - |
55 | | -### Manage Outside Collaborators |
56 | | - |
57 | | -To add an Outside Collaborator to the repository, follow the guidelines detailed [here](https://github.com/ministryofjustice/github-collaborators). |
58 | | - |
59 | | -### Update CODEOWNERS |
60 | | - |
61 | | -(Optional) Modify the CODEOWNERS file to specify the teams or users authorized to approve pull requests. |
62 | | - |
63 | | -### Configure Dependabot |
64 | | - |
65 | | -Adapt the dependabot.yml file to match your project's [dependency manager](https://docs.github.com/en/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file#package-ecosystem) and to enable [automated pull requests for package updates](https://docs.github.com/en/code-security/supply-chain-security). |
66 | | - |
67 | | -### Dependency Review |
68 | | - |
69 | | -If your repository is private with no GitHub Advanced Security license, remove the `.github/workflows/dependency-review.yml` file. |
| 1 | +# Analytical Platform Python `uv` Example |
0 commit comments