Skip to content

Commit 0e27b51

Browse files
committed
Add more content to the FAQ
1 parent f477486 commit 0e27b51

File tree

1 file changed

+46
-1
lines changed

1 file changed

+46
-1
lines changed

docs/source/reference/faq.md

Lines changed: 46 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,50 @@
11
# FAQ
22

3+
## How to resume a failed Finalize Release?
4+
5+
If the workflow failed to publish the release, for example because PyPI or npm was down during the release process, we can try to re-run the failed "Publish Release" workflow.
6+
7+
If the draft GitHub release was correctly created, re-run the workflow this time specifying `populate-release` as a step to skip. That way the assets already attached to the draft GitHub Release and the associated release commit will not be recreated, and the workflow will skip to the "Finalize Release" step directly.
8+
9+
## Failed to publish a package to `npm`
10+
11+
The releaser may fail to publish a package to the `npm` in the following cases:
12+
13+
- `npmjs.com` is down, or `npm` is encountering issues publishing new packages
14+
- the package you are trying to publish does not contain the correct publish config. If the package is meant to be public, add the following to `package.json`:
15+
16+
```json
17+
"publishConfig": {
18+
"access": "public"
19+
},
20+
```
21+
22+
## `check-python` step fails with Python monorepos
23+
24+
If you develop multiple Python packages within the same repository (as a monorepo), and the Python packages depend on each other, for example:
25+
26+
```
27+
packages
28+
├── bar
29+
└── foo
30+
```
31+
32+
And `bar` depends on `foo`, for example with `foo>=1.0.0`. You may see the following error during the `check-python` step:
33+
34+
```
35+
ERROR: Could not find a version that satisfies the requirement foo>=1.0.0 (from bar) (from versions: 1.0.0b4, 1.0.0b5, 1.0.0b6, 1.0.0b8)
36+
ERROR: No matching distribution found for foo>=1.0.0
37+
```
38+
39+
This issue is not fixed yet and is being tracked in https://github.com/jupyter-server/jupyter_releaser/issues/499.
40+
41+
As a workaround, you can skip the `check-python` step with the following releaser config:
42+
43+
```toml
44+
[tool.jupyter-releaser]
45+
skip = ["check-python"]
46+
```
47+
348
## My changelog is out of sync
449

550
Create a new manual PR to fix the PR and re-orient the changelog entry markers.
@@ -11,5 +56,5 @@ pick up the new PR.
1156

1257
## What happens if one of my steps is failing but I want to force a release?
1358

14-
This could happen for example if you need to override PRs to include in the changelog. In that case you would pass "check-changlog" to the
59+
This could happen for example if you need to override PRs to include in the changelog. In that case you would pass "check-changelog" to the
1560
workflow's "steps_to_skip" input option.

0 commit comments

Comments
 (0)