Skip to content

Commit 928fee6

Browse files
committed
Document requirements around control over NPM packages
1 parent cf3494a commit 928fee6

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

incoming_repo_requirements.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,8 @@ be transferred in.
1717
5. Adopt [Django Commons's Code of Conduct](#code-of-conduct)
1818
6. After transferring, switch to [PyPI's "Trusted Publisher"](https://docs.pypi.org/trusted-publishers/)
1919
process (see [example in django-commons-playground](https://github.com/django-commons/django-commons-playground/blob/main/.github/workflows/release.yml))
20-
7. django-commons should be added as maintainer to the readthedocs project
20+
7. If there is a JavaScript component published separately to NPM, it needs to be transferred to a new team under the [django-commons npm organization](https://www.npmjs.com/org/django-commons) and automated releases are to be set using [npm trusted publishing](https://docs.npmjs.com/trusted-publishers). If the project is already scoped under a different organization (`@your-org/your-package), this unfortunately means that package will need to be deprecated and a new package created, preferably without a scope, as there is no way to transfer packages between scopes on npm.
21+
8. django-commons should be added as maintainer to the readthedocs project
2122

2223
## Repository requirements
2324

@@ -46,6 +47,7 @@ be transferred in.
4647
- **[Required]** The repository will be transferred to the [django-commons GitHub organization](https://github.com/django-commons)
4748
- **[Required]** The Django Commons PyPI admin team (`cunla` and `stormheg`) is added as owners to PyPI and Test PyPI projects
4849
- **[Required]** Any previous maintainers who are not repository admins are removed as owners on PyPI and Test PyPI projects
50+
- **[Required]** If applicable, any separately published JavaScript package is transferred to the [django-commons npm organization](https://www.npmjs.com/org/django-commons) and any previous maintainers who are not repository admins are removed as owners. Two factor authentication must be enabled.
4951

5052
The current maintainers must be willing to hand over control of the
5153
PyPI project. The Django Commons admins team and the

0 commit comments

Comments
 (0)