Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add CI config for project template #12

Closed
a-musing-moose opened this issue Nov 8, 2023 · 0 comments
Closed

Add CI config for project template #12

a-musing-moose opened this issue Nov 8, 2023 · 0 comments
Assignees
@zahraaalizadeh

Comments

@a-musing-moose
Copy link
Contributor

a-musing-moose commented Nov 8, 2023 •
edited
Loading

馃幆 Aim

Add basic CI configuration for the project template.

馃摃Context

The template project currently has no CI (Continuous Integration) runner configuration but should have at least support for running tests, static analysis, building docs and the docker image. This will help ensure that projects are set up with good development practices right for the start.

I (@a-musing-moose) have a strong preference that CI jobs should not only be possible in the CI runner - it should be possible to run them all locally as well. This ensures that CI failures are resolvable offline, and that we are not 100% dependant on the CI runner to get anything done. As such the CI jobs should mostly be wrappers around existing Invoke task.

馃摑 Relevant resources/doc's/people

鉁匒cceptance Criteria

  • Choose a CI runner
  • Provide CI configuration for running tests
  • Provide CI configuration for running static analysis tools (linting and typing)
  • Provide CI configuration for running documentation building
  • Provide CI configuration for running image building
  • All the above configurations should ideally wrap invoke task unless there is a good reason they cannot
@a-musing-moose a-musing-moose mentioned this issue Nov 9, 2023
Open
@zahraaalizadeh zahraaalizadeh self-assigned this Nov 23, 2023
@zahraaalizadeh zahraaalizadeh mentioned this issue Apr 3, 2024
Merged
zahraaalizadeh added a commit that referenced this issue Apr 5, 2024
@zahraaalizadeh
Add ci configs/1 (#41)
78b18b6 
This change:
- Fixes a few typos
- Adds a basic CI configuration to run `format` task on the subproject
- Adds a documentation about how to use 'act' to run github workflows
locally.
- Updates the README file with how to include github workflows when
starting a new project.

issue: #12
This was referenced Apr 5, 2024
Merged
Merged
zahraaalizadeh added a commit that referenced this issue Apr 10, 2024
@zahraaalizadeh
Add ci configs/2 (#44)
121fd68 
This change adds the following CI configs:
- Linting
- Type checking
- Doc building

issue: #12
zahraaalizadeh added a commit that referenced this issue Apr 15, 2024
@zahraaalizadeh
Add CI configs for running tests (#46)
9eaccff 
This PR adds run-test job to the CI pipeline. It also introduces a new invoke task to install dependencies to make the setup operations clean and minimal.

Issue: #12
@zahraaalizadeh zahraaalizadeh mentioned this issue Apr 22, 2024
Merged
zahraaalizadeh added a commit that referenced this issue Apr 24, 2024
@zahraaalizadeh
Add a basic ci job to run Docker image builder (#55)
002b15c 
This change adds the last piece required in
#12
Adds:
- An invoke task to run the service Docker image
- A CI job to build and test the docker image
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@zahraaalizadeh zahraaalizadeh

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@a-musing-moose @zahraaalizadeh