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
Then, install the environment and the pre-commit hooks with
110
-
111
-
```bash
112
-
make install
113
-
```
114
-
115
-
This will also generate your `uv.lock` file
116
-
117
-
### 3. Run the pre-commit hooks
118
-
119
-
Initially, the CI/CD pipeline might be failing due to formatting issues. To resolve those run:
120
-
121
-
```bash
122
-
uv run pre-commit run -a
123
-
```
124
-
125
-
### 4. Commit the changes
126
-
127
-
Lastly, commit the changes made by the two steps above to your repository.
70
+
ensure consistency with the CI/CD pipelines. Type `make` to see a list of
71
+
supported targets. A subset are listed here:
128
72
129
-
```bash
130
-
git add .
131
-
git commit -m 'Fix formatting issues'
132
-
git push origin main
133
-
```
73
+
» make
74
+
🌟🌟 biocommons conventional make targets 🌟🌟
134
75
135
-
You are now ready to start development on your project!
136
-
The CI/CD pipeline will be triggered when you open a pull request, merge to main, or when you create a new release.
76
+
Using these targets promots consistency between local development and ci/cd commands.
137
77
138
-
To finalize the set-up for publishing to PyPI, see [here](https://fpgmaas.github.io/cookiecutter-uv/features/publishing/#set-up-for-pypi).
139
-
For activating the automatic documentation with MkDocs, see [here](https://fpgmaas.github.io/cookiecutter-uv/features/mkdocs/#enabling-the-documentation-on-github).
140
-
To enable the code coverage reports, see [here](https://fpgmaas.github.io/cookiecutter-uv/features/codecov/).
78
+
usage: make [target ...]
141
79
142
-
## Releasing a new version
80
+
BASIC USAGE
81
+
help Display help message
143
82
144
-
- Create an API Token on [PyPI](https://pypi.org/).
145
-
- Add the API Token to your projects secrets with the name `PYPI_TOKEN` by visiting [this page](https://github.com/biocommons/python-package/settings/secrets/actions/new).
146
-
- Create a [new release](https://github.com/biocommons/python-package/releases/new) on Github.
147
-
- Create a new tag in the form `*.*.*`.
83
+
SETUP, INSTALLATION, PACKAGING
84
+
devready Prepare local dev env: Create virtual env, install the pre-commit hooks
85
+
build Build package
86
+
publish publish package to PyPI
148
87
149
-
For more details, see [here](https://fpgmaas.github.io/cookiecutter-uv/features/cicd/#how-to-trigger-a-release).
88
+
FORMATTING, TESTING, AND CODE QUALITY
89
+
cqa Run code quality assessments
90
+
test Test the code with pytest
150
91
151
-
---
92
+
DOCUMENTATION
93
+
docs-serve Build and serve the documentation
94
+
docs-test Test if documentation can be built without warnings or errors
152
95
153
-
Repository initiated with [fpgmaas/cookiecutter-uv](https://github.com/fpgmaas/cookiecutter-uv).
96
+
CLEANUP
97
+
clean Remove temporary and backup files
98
+
cleaner Remove files and directories that are easily rebuilt
99
+
cleanest Remove all files that can be rebuilt
100
+
distclean Remove untracked files and other detritus
0 commit comments