You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
@@ -33,7 +26,11 @@ Then, install the environment and the pre-commit hooks with
33
26
make install
34
27
```
35
28
36
-
This will also generate your `uv.lock` file
29
+
This will also generate your `uv.lock` file.
30
+
31
+
You are now ready to start development on your project!
32
+
The CI/CD pipeline will be triggered when you open a pull request, merge to main, or when you create a new release.
33
+
37
34
38
35
### 3. Run the pre-commit hooks
39
36
@@ -43,32 +40,6 @@ Initially, the CI/CD pipeline might be failing due to formatting issues. To reso
43
40
uv run pre-commit run -a
44
41
```
45
42
46
-
### 4. Commit the changes
47
-
48
-
Lastly, commit the changes made by the two steps above to your repository.
49
-
50
-
```bash
51
-
git add .
52
-
git commit -m 'Fix formatting issues'
53
-
git push origin main
54
-
```
55
-
56
-
You are now ready to start development on your project!
57
-
The CI/CD pipeline will be triggered when you open a pull request, merge to main, or when you create a new release.
58
-
59
-
To finalize the set-up for publishing to PyPI, see [here](https://fpgmaas.github.io/cookiecutter-uv/features/publishing/#set-up-for-pypi).
60
-
For activating the automatic documentation with MkDocs, see [here](https://fpgmaas.github.io/cookiecutter-uv/features/mkdocs/#enabling-the-documentation-on-github).
61
-
To enable the code coverage reports, see [here](https://fpgmaas.github.io/cookiecutter-uv/features/codecov/).
62
-
63
-
## Releasing a new version
64
-
65
-
- Create an API Token on [PyPI](https://pypi.org/).
66
-
- Add the API Token to your projects secrets with the name `PYPI_TOKEN` by visiting [this page](https://github.com/NoxelS/python-base-api/settings/secrets/actions/new).
67
-
- Create a [new release](https://github.com/NoxelS/python-base-api/releases/new) on Github.
68
-
- Create a new tag in the form `*.*.*`.
69
-
70
-
For more details, see [here](https://fpgmaas.github.io/cookiecutter-uv/features/cicd/#how-to-trigger-a-release).
71
-
72
43
---
73
44
74
45
Repository initiated with [fpgmaas/cookiecutter-uv](https://github.com/fpgmaas/cookiecutter-uv).
0 commit comments