Skip to content

Commit 2d019c5

Browse files
authored
Merge pull request #7 from febus982/fix-versioned-doc-release
Fix versioned doc release
2 parents b1335e2 + 50e4672 commit 2d019c5

File tree

4 files changed

+19
-7
lines changed

4 files changed

+19
-7
lines changed

.github/workflows/release.yml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ jobs:
4040

4141
- name: Export version for site docs
4242
id: docs-version
43-
run: ./ci-scripts/docs-version.sh >> "$GITHUB_OUTPUT"
43+
run: echo "$(./ci-scripts/docs-version.sh)" >> "$GITHUB_OUTPUT"
4444

4545

4646
publish:
@@ -79,3 +79,5 @@ jobs:
7979
contents: write
8080
with:
8181
site-version: "${{needs.build.outputs.docs-version.version}}"
82+
version-alias: "stable"
83+
set-default: true

Makefile

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.PHONY: docs docs-build
1+
.PHONY: docs
22

33
test:
44
poetry run pytest -n auto --cov
@@ -35,6 +35,3 @@ check: typing test format lint
3535

3636
docs:
3737
poetry run mkdocs serve
38-
39-
docs-build:
40-
poetry run mkdocs build

README.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,11 +41,17 @@ previous python versions directly in the CI pipeline to catch these bugs.
4141
* Owner: The github repository owner (in this case `febus982`)
4242
* Repository name: The github repository name (in this case `bootstrap-python-package`)
4343
* Workflow name: `release.yml`
44-
* Enable GitHub Actions for GitHub Pages (at URL https://github.com/GITHUB_NAME_OR_ORGANIZATION/GITHUB_REPOSITORY/settings/pages)
4544
* Create a GitHub Actions secret named `CODECLIMATE_REPORTER_ID` (at URL https://github.com/GITHUB_NAME_OR_ORGANIZATION/GITHUB_REPOSITORY/settings/secrets/actions)
4645
containing the codeclimate reporter id (you can find it at https://codeclimate.com/repos/YOUR_REPO_ID/settings/test_reporter).
4746
If you don't want to use CodeClimate just delete `workflows/python-quality.yml`.
4847
* Update the badges in `README.md`! (check [shields.io](https://shields.io/) for extra badges)
48+
* Setup local development:
49+
* Clone the repository
50+
* Install poetry `pip install poetry`
51+
* Install dev dependencies with `make dev-dependencies`
52+
* Setup GitHub pages (this need local development setup):
53+
* Initialise documentation branch `poetry run mike deploy dev latest --update-aliases --push`
54+
* Enable GitHub Actions for GitHub Pages (at URL https://github.com/GITHUB_NAME_OR_ORGANIZATION/GITHUB_REPOSITORY/settings/pages)
4955

5056
**IMPORTANT:** The repository is configured to deploy on the [test PyPI repository](https://test.pypi.org/).
5157
It's strongly recommended to create the project in the [test PyPI repository](https://test.pypi.org/) and test

docs/index.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,11 +27,17 @@ previous python versions directly in the CI pipeline to catch these bugs.
2727
* Owner: The github repository owner (in this case `febus982`)
2828
* Repository name: The github repository name (in this case `bootstrap-python-package`)
2929
* Workflow name: `release.yml`
30-
* Enable GitHub Actions for GitHub Pages (at URL https://github.com/GITHUB_NAME_OR_ORGANIZATION/GITHUB_REPOSITORY/settings/pages)
3130
* Create a GitHub Actions secret named `CODECLIMATE_REPORTER_ID` (at URL https://github.com/GITHUB_NAME_OR_ORGANIZATION/GITHUB_REPOSITORY/settings/secrets/actions)
3231
containing the codeclimate reporter id (you can find it at https://codeclimate.com/repos/YOUR_REPO_ID/settings/test_reporter).
3332
If you don't want to use CodeClimate just delete `workflows/python-quality.yml`.
3433
* Update the badges in `README.md`! (check [shields.io](https://shields.io/) for extra badges)
34+
* Setup local development:
35+
* Clone the repository
36+
* Install poetry `pip install poetry`
37+
* Install dev dependencies with `make dev-dependencies`
38+
* Setup GitHub pages (this need local development setup):
39+
* Initialise documentation branch `poetry run mike deploy dev latest --update-aliases --push`
40+
* Enable GitHub Actions for GitHub Pages (at URL https://github.com/GITHUB_NAME_OR_ORGANIZATION/GITHUB_REPOSITORY/settings/pages)
3541

3642
**IMPORTANT:** The repository is configured to deploy on the [test PyPI repository](https://test.pypi.org/).
3743
It's strongly recommended to create the project in the [test PyPI repository](https://test.pypi.org/) and test
@@ -58,6 +64,7 @@ This format can be customized, refer to [poetry-dynamic-versioning docs](https:/
5864
All the common commands used during development can be run using make targets:
5965

6066
* `make dev-dependencies`: Install dev requirements
67+
* `make update-dependencies`: Update dev requirements
6168
* `make test`: Run test suite
6269
* `make check`: Run tests, code style and lint checks
6370
* `make fix`: Run code style and lint automatic fixes (where possible)

0 commit comments

Comments
 (0)