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
Copy file name to clipboardExpand all lines: docs/source/faq/index.md
+47-1Lines changed: 47 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,5 +1,51 @@
1
1
# FAQ
2
2
3
+
## How to resume a failed 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 account publishing the package to npm is not part of the list of collaborators
15
+
- 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`:
16
+
17
+
```json
18
+
"publishConfig": {
19
+
"access": "public"
20
+
},
21
+
```
22
+
23
+
## `check-python` step fails with Python monorepos
24
+
25
+
If you develop multiple Python packages within the same repository (as a monorepo), and the Python packages depend on each other, for example:
26
+
27
+
```
28
+
packages
29
+
├── bar
30
+
└── foo
31
+
```
32
+
33
+
And `bar` depends on `foo`, for example with `foo>=1.0.0`. You may see the following error during the `check-python` step:
34
+
35
+
```
36
+
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)
37
+
ERROR: No matching distribution found for foo>=1.0.0
38
+
```
39
+
40
+
This issue is not fixed yet and is being tracked in [this issue](https://github.com/jupyter-server/jupyter_releaser/issues/499).
41
+
42
+
As a workaround, you can skip the `check-python` step with the following releaser config:
43
+
44
+
```toml
45
+
[tool.jupyter-releaser]
46
+
skip = ["check-python"]
47
+
```
48
+
3
49
## My changelog is out of sync
4
50
5
51
Create a new manual PR to fix the PR and re-orient the changelog entry markers.
@@ -11,5 +57,5 @@ pick up the new PR.
11
57
12
58
## What happens if one of my steps is failing but I want to force a release?
13
59
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
60
+
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
0 commit comments