Skip to content

Commit 20653e8

Browse files
committed
docs: update release information
1 parent 2c0867d commit 20653e8

1 file changed

Lines changed: 8 additions & 0 deletions

File tree

docs/RELEASE.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ and [GitHub Actions](https://github.com/mitre-attack/mitreattack-python/actions)
1616
- It will also update the `CHANGELOG.md` with all commit messages that are compatible with [Conventional Commits](https://www.conventionalcommits.org).
1717
- NOTE: You should double-check the generated `CHANGELOG.md` file and make sure it looks good.
1818
- Update other metadata as needed in `pyproject.toml` (dependencies, etc.).
19+
- `poetry update --with dev --with docs`
1920

2021
## 3. Local Validation (Recommended)
2122

@@ -36,6 +37,13 @@ poetry install --with=dev
3637
poetry run ruff check
3738
poetry run ruff format --check
3839

40+
# Build docs
41+
# This is managed directly by the Readthedocs site which is configured to watch our repository, but we should test it locally too
42+
# https://app.readthedocs.org/projects/mitreattack-python/
43+
cd docs/
44+
poetry run python -m sphinx -T -b html -d _build/doctrees -D language=en . _build/html
45+
cd ..
46+
3947
# Run tests
4048
poetry run pytest --cov=mitreattack --cov-report html
4149

0 commit comments

Comments
 (0)