Skip to content

Commit 23b5b59

Browse files
committed
docs: add development and publishing guidelines to README
1 parent f64015b commit 23b5b59

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

README.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -273,3 +273,22 @@ def upload():
273273
Gitleaks will automatically run pre-commit (see `pre-commit-config.yaml` for details) to prevent commits with secrets in the first place. To test this without committing, run `pre-commit` from the terminal. To skip this check, use `SKIP=gitleaks git commit -m "message"` to commit changes. Preferably, label false positives with the `#gitleaks:allow` comment instead of skipping the check.
274274

275275
Gitleaks will also run in the CI pipeline as a GitHub action on push and pull request (can also be manually triggered in the actions tab on GitHub). To update the baseline of ignored secrets, run `python ./scripts/create_gitleaks_baseline.py` from the venv and commit the changes to `.gitleaksignore`.
276+
277+
278+
## Development
279+
280+
### Publishing packages
281+
282+
1. update version in `package.json` and `pyproject.toml`
283+
284+
2. commit, merge to main
285+
286+
3. tag the commit with the version number e.g. `1.0.0`
287+
288+
4. publish to npm & pypi
289+
290+
```bash
291+
env WIX_URLS= npm publish
292+
cd python
293+
poetry publish --build
294+
```

0 commit comments

Comments
 (0)