Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve "convert repo" docs #582

Open
martinRenou opened this issue Sep 12, 2024 · 1 comment
Open

Improve "convert repo" docs #582

martinRenou opened this issue Sep 12, 2024 · 1 comment
Labels
bug Something isn't working

Comments

@martinRenou
Copy link
Contributor

I find the https://jupyter-releaser.readthedocs.io/en/latest/how_to_guides/convert_repo_from_repo.html docs page difficult to understand.

Set up a [GitHub App](https://docs.github.com/en/apps/creating-github-apps/about-creating-github-apps/about-creating-github-apps#github-apps-that-act-on-their-own-behalf) on your organization (or personal account for a personal project).
- Disable the web hook
- Enable Repository permissions > Contents > Read and write
- Select “Only on this account”
- Click “Create GitHub App”
- Browse to the App Settings
- Select “Install App” and install on all repositories
- Under “General” click “Generate a private key”
- Store the APP_ID and the private key in a secure location (Jupyter Vault if using a Jupyter Org)

Missing information from here:

  • where to find how to create a Github app: org settings -> developper settings -> Github Apps -> New Github App button
  • What to provide as Homepage URL?

Create a “release” environment on your repository and add an APP_ID Environment Variable and APP_PRIVATE_KEY secret. The environment should be enabled for “Protected branches only”.

This is a bit unclear. Where to find the APP_ID? Should the private key include -----BEGIN RSA PRIVATE KEY----- and -----END RSA PRIVATE KEY----- (yes)?
We need to clarify this

Configure Rulesets for the repository
Set up branch protection (with default rules) on publication branches
Remove global tag protection.
Add a branch Ruleset for all branches
Allow the GitHub App to bypass protections
Set up Pull Request and Required Checks
Add a tags Ruleset for all tags
Allow the GitHub App to bypass protections

The steps are unclear. I was personally not able to go through this. It seems it's not required though. Should we remove that from the docs or add more information and screenshots?

@martinRenou martinRenou added the bug Something isn't working label Sep 12, 2024
@jtpio
Copy link
Member

jtpio commented Sep 16, 2024

where to find how to create a Github app: org settings -> developper settings -> Github Apps -> New Github App button

Right, this should be better documented 👍

What to provide as Homepage URL?

Most of the Jupyter repos point to https://jupyter.org/. For other repos, maybe the link to the repo or the parent org? We could add some examples of URLs in the docs.

Where to find the APP_ID?

Probably related to the first point. Normally it should be visible on the app settings page, close to where the app was created.

The steps are unclear. I was personally not able to go through this. It seems it's not required though. Should we remove that from the docs or add more information and screenshots?

I guess this is because most of the Jupyter repos have a ruleset configured as best practice. Maybe this step should be optional (but recommended) so it can be skipped for repos that haven't set such ruleset yet?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

2 participants