It seems like you're looking for instructions on how to register a GitHub App. Here's a step-by-step guide based on the information you've provided:
Step 1: Register Your GitHub App
Navigate to GitHub App Registration Page: Go to the GitHub App registration page by visiting https://github.com/settings/apps/new or by navigating through your GitHub settings to the 'Developer settings' section and then to 'GitHub Apps'.
Fill in the Details: On the registration page, you'll need to provide details about your GitHub App. This typically includes:
The name of your application.
A short description of what your app does.
The homepage URL for your application (where users can learn more about the app).
User authorization callback URL, if your app will use OAuth for authentication.
Webhook URL, if your app will respond to GitHub events.
A private key that will be used to sign access tokens.
Set Permissions and Events: Determine what permissions your GitHub App requires on the user's repository and which events it should subscribe to. This will depend on the actions your app needs to perform.
Save Your Changes: Once you've filled in all the necessary information, save your changes to register your app with GitHub.
Step 2: Install the App on a Repository
After registering your GitHub App, you need to install it on a repository where it will run.
Navigate to the App's Page: Go to the 'Install App' tab on your GitHub App's page.
Choose Installation Repository: Select the repository where you want to install the app.
Install the App: Confirm the installation by clicking the 'Install' button.
Step 3: Push to Production
When you're ready to move your app to production, it's recommended to register a new GitHub App specifically for the production environment.
Repeat the Registration Process: Follow the same steps as above to register a new GitHub App for production.
Install on Production Repositories: Install the production GitHub App on the repositories that will use it in the production environment.
Deploy Your Application
If you're deploying your application as a JAR file, you'll need to ensure that it's properly configured to interact with the GitHub API using the credentials provided during the registration process.
Application Name
When you register your GitHub App, you'll give it a name. This name is what users will see when they install the app and when the app interacts with their repositories.
Remember to keep your private key and client secrets secure, and rotate them periodically to maintain the security of your application.
For more detailed instructions, you should refer to the GitHub documentation or the specific guide mentioned in your message (xref:register-github-app.adoc[Register a GitHub App]).
It seems like you're looking for instructions on how to register a GitHub App. Here's a step-by-step guide based on the information you've provided:
Step 1: Register Your GitHub App
Navigate to GitHub App Registration Page: Go to the GitHub App registration page by visiting
https://github.com/settings/apps/newor by navigating through your GitHub settings to the 'Developer settings' section and then to 'GitHub Apps'.Fill in the Details: On the registration page, you'll need to provide details about your GitHub App. This typically includes:
Set Permissions and Events: Determine what permissions your GitHub App requires on the user's repository and which events it should subscribe to. This will depend on the actions your app needs to perform.
Save Your Changes: Once you've filled in all the necessary information, save your changes to register your app with GitHub.
Step 2: Install the App on a Repository
After registering your GitHub App, you need to install it on a repository where it will run.
Navigate to the App's Page: Go to the 'Install App' tab on your GitHub App's page.
Choose Installation Repository: Select the repository where you want to install the app.
Install the App: Confirm the installation by clicking the 'Install' button.
Step 3: Push to Production
When you're ready to move your app to production, it's recommended to register a new GitHub App specifically for the production environment.
Repeat the Registration Process: Follow the same steps as above to register a new GitHub App for production.
Install on Production Repositories: Install the production GitHub App on the repositories that will use it in the production environment.
Deploy Your Application
If you're deploying your application as a JAR file, you'll need to ensure that it's properly configured to interact with the GitHub API using the credentials provided during the registration process.
Application Name
When you register your GitHub App, you'll give it a name. This name is what users will see when they install the app and when the app interacts with their repositories.
Remember to keep your private key and client secrets secure, and rotate them periodically to maintain the security of your application.
For more detailed instructions, you should refer to the GitHub documentation or the specific guide mentioned in your message (
xref:register-github-app.adoc[Register a GitHub App]).Source : https://docs.quarkiverse.io/quarkus-github-app/dev/