1
0
mirror of synced 2026-01-07 09:01:31 -05:00

New translation batch for ja (#23890)

* Add crowdin translations

* Run script/i18n/homogenize-frontmatter.js

* Run script/i18n/lint-translation-files.js --check parsing

* Run script/i18n/lint-translation-files.js --check rendering

* run script/i18n/reset-files-with-broken-liquid-tags.js --language=ja

* run script/i18n/reset-known-broken-translation-files.js

* Check in ja CSV report
This commit is contained in:
docubot
2021-12-20 11:53:58 -06:00
committed by GitHub
parent 3b0594e3ce
commit 478c41017b
175 changed files with 3958 additions and 2192 deletions

View File

@@ -6,7 +6,7 @@ redirect_from:
- /github/automating-your-workflow-with-github-actions/building-actions
- /actions/automating-your-workflow-with-github-actions/building-actions
- /actions/building-actions
- /articles/creating-a-github-action/
- /articles/creating-a-github-action
versions:
fpt: '*'
ghes: '*'

View File

@@ -0,0 +1,153 @@
---
title: Deploying Docker to Azure App Service
intro: You can deploy a Docker container to Azure App Service as part of your continuous deployment (CD) workflows.
versions:
fpt: '*'
ghes: '*'
ghae: '*'
ghec: '*'
type: tutorial
topics:
- CD
- Containers
- Docker
- Azure App Service
---
{% data reusables.actions.enterprise-beta %}
{% data reusables.actions.enterprise-github-hosted-runners %}
## Introduction
This guide explains how to use {% data variables.product.prodname_actions %} to build and deploy a Docker container to [Azure App Service](https://azure.microsoft.com/services/app-service/).
{% ifversion fpt or ghec or ghae-issue-4856 %}
{% note %}
**Note**: {% data reusables.actions.about-oidc-short-overview %} and "[Configuring OpenID Connect in Azure](/actions/deployment/security-hardening-your-deployments/configuring-openid-connect-in-azure)."
{% endnote %}
{% endif %}
## Prerequisites
Before creating your {% data variables.product.prodname_actions %} workflow, you will first need to complete the following setup steps:
{% data reusables.actions.create-azure-app-plan %}
1. Create a web app.
For example, you can use the Azure CLI to create an Azure App Service web app:
```bash{:copy}
az webapp create \
--name MY_WEBAPP_NAME \
--plan MY_APP_SERVICE_PLAN \
--resource-group MY_RESOURCE_GROUP \
--deployment-container-image-name nginx:latest
```
In the command above, replace the parameters with your own values, where `MY_WEBAPP_NAME` is a new name for the web app.
{% data reusables.actions.create-azure-publish-profile %}
1. Set registry credentials for your web app.
Create a personal access token with the `repo` and `read:packages` scopes. For more information, see "[Creating a personal access token](/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)."
Set `DOCKER_REGISTRY_SERVER_URL` to `https://ghcr.io`, `DOCKER_REGISTRY_SERVER_USERNAME` to the GitHub username or organization that owns the repository, and `DOCKER_REGISTRY_SERVER_PASSWORD` to your personal access token from above. This will give your web app credentials so it can pull the container image after your workflow pushes a newly built image to the registry. You can do this with the following Azure CLI command:
```shell
az webapp config appsettings set \
--name MY_WEBAPP_NAME \
--resource-group MY_RESOURCE_GROUP \
--settings DOCKER_REGISTRY_SERVER_URL=https://ghcr.io DOCKER_REGISTRY_SERVER_USERNAME=MY_REPOSITORY_OWNER DOCKER_REGISTRY_SERVER_PASSWORD=MY_PERSONAL_ACCESS_TOKEN
```
{% ifversion fpt or ghes > 3.0 or ghae or ghec %}
5. Optionally, configure a deployment environment. {% data reusables.actions.about-environments %}
{% endif %}
## Creating the workflow
Once you've completed the prerequisites, you can proceed with creating the workflow.
The following example workflow demonstrates how to build and deploy a Docker container to Azure App Service when there is a push to the `main` branch.
Ensure that you set `AZURE_WEBAPP_NAME` in the workflow `env` key to the name of the web app you created.
{% data reusables.actions.delete-env-key %}
```yaml{:copy}
{% data reusables.actions.actions-not-certified-by-github-comment %}
name: Build and deploy a container to an Azure Web App
env:
AZURE_WEBAPP_NAME: MY_WEBAPP_NAME # set this to your application's name
on:
push:
branches:
- main
permissions:
contents: 'read'
packages: 'write'
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Set up Docker Buildx
uses: docker/setup-buildx-action@v1
- name: Log in to GitHub container registry
uses: docker/login-action@v1.10.0
with:
registry: ghcr.io
username: {% raw %}${{ github.actor }}{% endraw %}
password: {% raw %}${{ secrets.GITHUB_TOKEN }}{% endraw %}
- name: Lowercase the repo name
run: echo "REPO=${GITHUB_REPOSITORY,,}" >>${GITHUB_ENV}
- name: Build and push container image to registry
uses: docker/build-push-action@v2
with:
push: true
tags: ghcr.io/{% raw %}${{ env.REPO }}{% endraw %}:{% raw %}${{ github.sha }}{% endraw %}
file: ./Dockerfile
deploy:
runs-on: ubuntu-latest
needs: build
environment:
name: 'production'
url: {% raw %}${{ steps.deploy-to-webapp.outputs.webapp-url }}{% endraw %}
steps:
- name: Lowercase the repo name
run: echo "REPO=${GITHUB_REPOSITORY,,}" >>${GITHUB_ENV}
- name: Deploy to Azure Web App
id: deploy-to-webapp
uses: azure/webapps-deploy@0b651ed7546ecfc75024011f76944cb9b381ef1e
with:
app-name: {% raw %}${{ env.AZURE_WEBAPP_NAME }}{% endraw %}
publish-profile: {% raw %}${{ secrets.AZURE_WEBAPP_PUBLISH_PROFILE }}{% endraw %}
images: 'ghcr.io/{% raw %}${{ env.REPO }}{% endraw %}:{% raw %}${{ github.sha }}{% endraw %}'
```
## Additional resources
The following resources may also be useful:
* For the original starter workflow, see [`azure-container-webapp.yml`](https://github.com/actions/starter-workflows/blob/main/deployments/azure-container-webapp.yml) in the {% data variables.product.prodname_actions %} `starter-workflows` repository.
* The action used to deploy the web app is the official Azure [`Azure/webapps-deploy`](https://github.com/Azure/webapps-deploy) action.
* For more examples of GitHub Action workflows that deploy to Azure, see the [actions-workflow-samples](https://github.com/Azure/actions-workflow-samples) repository.

View File

@@ -0,0 +1,134 @@
---
title: Deploying Java to Azure App Service
intro: You can deploy your Java project to Azure App Service as part of your continuous deployment (CD) workflows.
versions:
fpt: '*'
ghes: '*'
ghae: '*'
ghec: '*'
type: tutorial
topics:
- CD
- Java
- Azure App Service
---
{% data reusables.actions.enterprise-beta %}
{% data reusables.actions.enterprise-github-hosted-runners %}
## Introduction
This guide explains how to use {% data variables.product.prodname_actions %} to build and deploy a Java project to [Azure App Service](https://azure.microsoft.com/services/app-service/).
{% ifversion fpt or ghec or ghae-issue-4856 %}
{% note %}
**Note**: {% data reusables.actions.about-oidc-short-overview %} and "[Configuring OpenID Connect in Azure](/actions/deployment/security-hardening-your-deployments/configuring-openid-connect-in-azure)."
{% endnote %}
{% endif %}
## Prerequisites
Before creating your {% data variables.product.prodname_actions %} workflow, you will first need to complete the following setup steps:
{% data reusables.actions.create-azure-app-plan %}
1. Create a web app.
For example, you can use the Azure CLI to create an Azure App Service web app with a Java runtime:
```bash{:copy}
az webapp create \
--name MY_WEBAPP_NAME \
--plan MY_APP_SERVICE_PLAN \
--resource-group MY_RESOURCE_GROUP \
--runtime "JAVA|11-java11"
```
In the command above, replace the parameters with your own values, where `MY_WEBAPP_NAME` is a new name for the web app.
{% data reusables.actions.create-azure-publish-profile %}
{% ifversion fpt or ghes > 3.0 or ghae or ghec %}
1. Optionally, configure a deployment environment. {% data reusables.actions.about-environments %}
{% endif %}
## Creating the workflow
Once you've completed the prerequisites, you can proceed with creating the workflow.
The following example workflow demonstrates how to build and deploy a Java project to Azure App Service when there is a push to the `main` branch.
Ensure that you set `AZURE_WEBAPP_NAME` in the workflow `env` key to the name of the web app you created. If you want to use a Java version other than `11`, change `JAVA_VERSION`.
{% data reusables.actions.delete-env-key %}
```yaml{:copy}
{% data reusables.actions.actions-not-certified-by-github-comment %}
name: Build and deploy JAR app to Azure Web App
env:
AZURE_WEBAPP_NAME: MY_WEBAPP_NAME # set this to your application's name
JAVA_VERSION: '11' # set this to the Java version to use
on:
push:
branches:
- main
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Set up Java version
uses: actions/setup-java@v2.3.1
with:
java-version: {% raw %}${{ env.JAVA_VERSION }}{% endraw %}
cache: 'maven'
- name: Build with Maven
run: mvn clean install
- name: Upload artifact for deployment job
uses: actions/upload-artifact@v2
with:
name: java-app
path: '{% raw %}${{ github.workspace }}{% endraw %}/target/*.jar'
deploy:
runs-on: ubuntu-latest
needs: build
environment:
name: 'production'
url: {% raw %}${{ steps.deploy-to-webapp.outputs.webapp-url }}{% endraw %}
steps:
- name: Download artifact from build job
uses: actions/download-artifact@v2
with:
name: java-app
- name: Deploy to Azure Web App
id: deploy-to-webapp
uses: azure/webapps-deploy@0b651ed7546ecfc75024011f76944cb9b381ef1e
with:
app-name: {% raw %}${{ env.AZURE_WEBAPP_NAME }}{% endraw %}
publish-profile: {% raw %}${{ secrets.AZURE_WEBAPP_PUBLISH_PROFILE }}{% endraw %}
package: '*.jar'
```
## Additional resources
The following resources may also be useful:
* For the original starter workflow, see [`azure-webapps-java-jar.yml`](https://github.com/actions/starter-workflows/blob/main/deployments/azure-webapps-java-jar.yml) in the {% data variables.product.prodname_actions %} `starter-workflows` repository.
* The action used to deploy the web app is the official Azure [`Azure/webapps-deploy`](https://github.com/Azure/webapps-deploy) action.
* For more examples of GitHub Action workflows that deploy to Azure, see the [actions-workflow-samples](https://github.com/Azure/actions-workflow-samples) repository.

View File

@@ -0,0 +1,144 @@
---
title: Deploying .NET to Azure App Service
intro: You can deploy your .NET project to Azure App Service as part of your continuous deployment (CD) workflows.
versions:
fpt: '*'
ghes: '*'
ghae: '*'
ghec: '*'
type: tutorial
topics:
- CD
- Azure App Service
---
{% data reusables.actions.enterprise-beta %}
{% data reusables.actions.enterprise-github-hosted-runners %}
## Introduction
This guide explains how to use {% data variables.product.prodname_actions %} to build and deploy a .NET project to [Azure App Service](https://azure.microsoft.com/services/app-service/).
{% ifversion fpt or ghec or ghae-issue-4856 %}
{% note %}
**Note**: {% data reusables.actions.about-oidc-short-overview %} and "[Configuring OpenID Connect in Azure](/actions/deployment/security-hardening-your-deployments/configuring-openid-connect-in-azure)."
{% endnote %}
{% endif %}
## Prerequisites
Before creating your {% data variables.product.prodname_actions %} workflow, you will first need to complete the following setup steps:
{% data reusables.actions.create-azure-app-plan %}
2. Create a web app.
For example, you can use the Azure CLI to create an Azure App Service web app with a .NET runtime:
```bash{:copy}
az webapp create \
--name MY_WEBAPP_NAME \
--plan MY_APP_SERVICE_PLAN \
--resource-group MY_RESOURCE_GROUP \
--runtime "DOTNET|5.0"
```
In the command above, replace the parameters with your own values, where `MY_WEBAPP_NAME` is a new name for the web app.
{% data reusables.actions.create-azure-publish-profile %}
{% ifversion fpt or ghes > 3.0 or ghae or ghec %}
5. Optionally, configure a deployment environment. {% data reusables.actions.about-environments %}
{% endif %}
## Creating the workflow
Once you've completed the prerequisites, you can proceed with creating the workflow.
The following example workflow demonstrates how to build and deploy a .NET project to Azure App Service when there is a push to the `main` branch.
Ensure that you set `AZURE_WEBAPP_NAME` in the workflow `env` key to the name of the web app you created. If the path to your project is not the repository root, change `AZURE_WEBAPP_PACKAGE_PATH`. If you use a version of .NET other than `5`, change `DOTNET_VERSION`.
{% data reusables.actions.delete-env-key %}
```yaml{:copy}
{% data reusables.actions.actions-not-certified-by-github-comment %}
name: Build and deploy ASP.Net Core app to an Azure Web App
env:
AZURE_WEBAPP_NAME: MY_WEBAPP_NAME # set this to your application's name
AZURE_WEBAPP_PACKAGE_PATH: '.' # set this to the path to your web app project, defaults to the repository root
DOTNET_VERSION: '5' # set this to the .NET Core version to use
on:
push:
branches:
- main
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Set up .NET Core
uses: actions/setup-dotnet@v1
with:
dotnet-version: {% raw %}${{ env.DOTNET_VERSION }}{% endraw %}
- name: Set up dependency caching for faster builds
uses: actions/cache@v2
with:
path: ~/.nuget/packages
key: {% raw %}${{ runner.os }}-nuget-${{ hashFiles('**/packages.lock.json') }}{% endraw %}
restore-keys: |
{% raw %}${{ runner.os }}-nuget-{% endraw %}
- name: Build with dotnet
run: dotnet build --configuration Release
- name: dotnet publish
run: dotnet publish -c Release -o {% raw %}${{env.DOTNET_ROOT}}{% endraw %}/myapp
- name: Upload artifact for deployment job
uses: actions/upload-artifact@v2
with:
name: .net-app
path: {% raw %}${{env.DOTNET_ROOT}}{% endraw %}/myapp
deploy:
runs-on: ubuntu-latest
needs: build
environment:
name: 'production'
url: {% raw %}${{ steps.deploy-to-webapp.outputs.webapp-url }}{% endraw %}
steps:
- name: Download artifact from build job
uses: actions/download-artifact@v2
with:
name: .net-app
- name: Deploy to Azure Web App
id: deploy-to-webapp
uses: azure/webapps-deploy@0b651ed7546ecfc75024011f76944cb9b381ef1e
with:
app-name: {% raw %}${{ env.AZURE_WEBAPP_NAME }}{% endraw %}
publish-profile: {% raw %}${{ secrets.AZURE_WEBAPP_PUBLISH_PROFILE }}{% endraw %}
package: {% raw %}${{ env.AZURE_WEBAPP_PACKAGE_PATH }}{% endraw %}
```
## Additional resources
The following resources may also be useful:
* For the original starter workflow, see [`azure-webapps-dotnet-core.yml`](https://github.com/actions/starter-workflows/blob/main/deployments/azure-webapps-dotnet-core.yml) in the {% data variables.product.prodname_actions %} `starter-workflows` repository.
* The action used to deploy the web app is the official Azure [`Azure/webapps-deploy`](https://github.com/Azure/webapps-deploy) action.
* For more examples of GitHub Action workflows that deploy to Azure, see the [actions-workflow-samples](https://github.com/Azure/actions-workflow-samples) repository.

View File

@@ -0,0 +1,141 @@
---
title: Deploying Node.js to Azure App Service
intro: You can deploy your Node.js project to Azure App Service as part of your continuous deployment (CD) workflows.
redirect_from:
- /actions/guides/deploying-to-azure-app-service
- /actions/deployment/deploying-to-azure-app-service
- /actions/deployment/deploying-to-your-cloud-provider/deploying-to-azure-app-service
versions:
fpt: '*'
ghes: '*'
ghae: '*'
ghec: '*'
type: tutorial
topics:
- CD
- Node
- JavaScript
- Azure App Service
---
{% data reusables.actions.enterprise-beta %}
{% data reusables.actions.enterprise-github-hosted-runners %}
## Introduction
This guide explains how to use {% data variables.product.prodname_actions %} to build, test, and deploy a Node.js project to [Azure App Service](https://azure.microsoft.com/services/app-service/).
{% ifversion fpt or ghec or ghae-issue-4856 %}
{% note %}
**Note**: {% data reusables.actions.about-oidc-short-overview %} and "[Configuring OpenID Connect in Azure](/actions/deployment/security-hardening-your-deployments/configuring-openid-connect-in-azure)."
{% endnote %}
{% endif %}
## Prerequisites
Before creating your {% data variables.product.prodname_actions %} workflow, you will first need to complete the following setup steps:
{% data reusables.actions.create-azure-app-plan %}
2. Create a web app.
For example, you can use the Azure CLI to create an Azure App Service web app with a Node.js runtime:
```bash{:copy}
az webapp create \
--name MY_WEBAPP_NAME \
--plan MY_APP_SERVICE_PLAN \
--resource-group MY_RESOURCE_GROUP \
--runtime "NODE|14-lts"
```
In the command above, replace the parameters with your own values, where `MY_WEBAPP_NAME` is a new name for the web app.
{% data reusables.actions.create-azure-publish-profile %}
{% ifversion fpt or ghes > 3.0 or ghae or ghec %}
5. Optionally, configure a deployment environment. {% data reusables.actions.about-environments %}
{% endif %}
## Creating the workflow
Once you've completed the prerequisites, you can proceed with creating the workflow.
The following example workflow demonstrates how to build, test, and deploy the Node.js project to Azure App Service when there is a push to the `main` branch.
Ensure that you set `AZURE_WEBAPP_NAME` in the workflow `env` key to the name of the web app you created. If the path to your project is not the repository root, change `AZURE_WEBAPP_PACKAGE_PATH` to your project path. If you use a version of Node.js other than `10.x`, change `NODE_VERSION` to the version that you use.
{% data reusables.actions.delete-env-key %}
```yaml{:copy}
{% data reusables.actions.actions-not-certified-by-github-comment %}
on:
push:
branches:
- main
env:
AZURE_WEBAPP_NAME: MY_WEBAPP_NAME # set this to your application's name
AZURE_WEBAPP_PACKAGE_PATH: '.' # set this to the path to your web app project, defaults to the repository root
NODE_VERSION: '14.x' # set this to the node version to use
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Set up Node.js
uses: actions/setup-node@v2
with:
node-version: {% raw %}${{ env.NODE_VERSION }}{% endraw %}
cache: 'npm'
- name: npm install, build, and test
run: |
npm install
npm run build --if-present
npm run test --if-present
- name: Upload artifact for deployment job
uses: actions/upload-artifact@v2
with:
name: node-app
path: .
deploy:
runs-on: ubuntu-latest
needs: build
environment:
name: 'production'
url: {% raw %}${{ steps.deploy-to-webapp.outputs.webapp-url }}{% endraw %}
steps:
- name: Download artifact from build job
uses: actions/download-artifact@v2
with:
name: node-app
- name: 'Deploy to Azure WebApp'
id: deploy-to-webapp
uses: azure/webapps-deploy@0b651ed7546ecfc75024011f76944cb9b381ef1e
with:
app-name: {% raw %}${{ env.AZURE_WEBAPP_NAME }}{% endraw %}
publish-profile: {% raw %}${{ secrets.AZURE_WEBAPP_PUBLISH_PROFILE }}{% endraw %}
package: {% raw %}${{ env.AZURE_WEBAPP_PACKAGE_PATH }}{% endraw %}
```
## Additional resources
The following resources may also be useful:
* For the original starter workflow, see [`azure-webapps-node.yml`](https://github.com/actions/starter-workflows/blob/main/deployments/azure-webapps-node.yml) in the {% data variables.product.prodname_actions %} `starter-workflows` repository.
* The action used to deploy the web app is the official Azure [`Azure/webapps-deploy`](https://github.com/Azure/webapps-deploy) action.
* For more examples of GitHub Action workflows that deploy to Azure, see the
[actions-workflow-samples](https://github.com/Azure/actions-workflow-samples) repository.
* The "[Create a Node.js web app in Azure](https://docs.microsoft.com/azure/app-service/quickstart-nodejs)" quickstart in the Azure web app documentation demonstrates using VS Code with the [Azure App Service extension](https://marketplace.visualstudio.com/items?itemName=ms-azuretools.vscode-azureappservice).

View File

@@ -0,0 +1,155 @@
---
title: Deploying PHP to Azure App Service
intro: You can deploy your PHP project to Azure App Service as part of your continuous deployment (CD) workflows.
versions:
fpt: '*'
ghes: '*'
ghae: '*'
ghec: '*'
type: tutorial
topics:
- CD
- Azure App Service
---
{% data reusables.actions.enterprise-beta %}
{% data reusables.actions.enterprise-github-hosted-runners %}
## Introduction
This guide explains how to use {% data variables.product.prodname_actions %} to build and deploy a PHP project to [Azure App Service](https://azure.microsoft.com/services/app-service/).
{% ifversion fpt or ghec or ghae-issue-4856 %}
{% note %}
**Note**: {% data reusables.actions.about-oidc-short-overview %} and "[Configuring OpenID Connect in Azure](/actions/deployment/security-hardening-your-deployments/configuring-openid-connect-in-azure)."
{% endnote %}
{% endif %}
## Prerequisites
Before creating your {% data variables.product.prodname_actions %} workflow, you will first need to complete the following setup steps:
{% data reusables.actions.create-azure-app-plan %}
2. Create a web app.
For example, you can use the Azure CLI to create an Azure App Service web app with a PHP runtime:
```bash{:copy}
az webapp create \
--name MY_WEBAPP_NAME \
--plan MY_APP_SERVICE_PLAN \
--resource-group MY_RESOURCE_GROUP \
--runtime "php|7.4"
```
In the command above, replace the parameters with your own values, where `MY_WEBAPP_NAME` is a new name for the web app.
{% data reusables.actions.create-azure-publish-profile %}
{% ifversion fpt or ghes > 3.0 or ghae or ghec %}
5. Optionally, configure a deployment environment. {% data reusables.actions.about-environments %}
{% endif %}
## Creating the workflow
Once you've completed the prerequisites, you can proceed with creating the workflow.
The following example workflow demonstrates how to build and deploy a PHP project to Azure App Service when there is a push to the `main` branch.
Ensure that you set `AZURE_WEBAPP_NAME` in the workflow `env` key to the name of the web app you created. If the path to your project is not the repository root, change `AZURE_WEBAPP_PACKAGE_PATH` to the path to your project. If you use a version of PHP other than `8.x`, change`PHP_VERSION` to the version that you use.
{% data reusables.actions.delete-env-key %}
```yaml{:copy}
{% data reusables.actions.actions-not-certified-by-github-comment %}
name: Build and deploy PHP app to Azure Web App
env:
AZURE_WEBAPP_NAME: MY_WEBAPP_NAME # set this to your application's name
AZURE_WEBAPP_PACKAGE_PATH: '.' # set this to the path to your web app project, defaults to the repository root
PHP_VERSION: '8.x' # set this to the PHP version to use
on:
push:
branches:
- main
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Setup PHP
uses: shivammathur/setup-php@v2
with:
php-version: {% raw %}${{ env.PHP_VERSION }}{% endraw %}
- name: Check if composer.json exists
id: check_files
uses: andstor/file-existence-action@v1
with:
files: 'composer.json'
- name: Get Composer Cache Directory
id: composer-cache
if: steps.check_files.outputs.files_exists == 'true'
run: |
echo "::set-output name=dir::$(composer config cache-files-dir)"
- name: Set up dependency caching for faster installs
uses: actions/cache@v2
if: steps.check_files.outputs.files_exists == 'true'
with:
path: {% raw %}${{ steps.composer-cache.outputs.dir }}{% endraw %}
key: {% raw %}${{ runner.os }}-composer-${{ hashFiles('**/composer.lock') }}{% endraw %}
restore-keys: |
{% raw %}${{ runner.os }}-composer-{% endraw %}
- name: Run composer install if composer.json exists
if: steps.check_files.outputs.files_exists == 'true'
run: composer validate --no-check-publish && composer install --prefer-dist --no-progress
- name: Upload artifact for deployment job
uses: actions/upload-artifact@v2
with:
name: php-app
path: .
deploy:
runs-on: ubuntu-latest
needs: build
environment:
name: 'production'
url: {% raw %}${{ steps.deploy-to-webapp.outputs.webapp-url }}{% endraw %}
steps:
- name: Download artifact from build job
uses: actions/download-artifact@v2
with:
name: php-app
- name: 'Deploy to Azure Web App'
id: deploy-to-webapp
uses: azure/webapps-deploy@0b651ed7546ecfc75024011f76944cb9b381ef1e
with:
app-name: {% raw %}${{ env.AZURE_WEBAPP_NAME }}{% endraw %}
publish-profile: {% raw %}${{ secrets.AZURE_WEBAPP_PUBLISH_PROFILE }}{% endraw %}
package: .
```
## Additional resources
The following resources may also be useful:
* For the original starter workflow, see [`azure-webapps-php.yml`](https://github.com/actions/starter-workflows/blob/main/deployments/azure-webapps-php.yml) in the {% data variables.product.prodname_actions %} `starter-workflows` repository.
* The action used to deploy the web app is the official Azure [`Azure/webapps-deploy`](https://github.com/Azure/webapps-deploy) action.
* For more examples of GitHub Action workflows that deploy to Azure, see the [actions-workflow-samples](https://github.com/Azure/actions-workflow-samples) repository.

View File

@@ -0,0 +1,151 @@
---
title: Deploying Python to Azure App Service
intro: You can deploy your Python project to Azure App Service as part of your continuous deployment (CD) workflows.
versions:
fpt: '*'
ghes: '*'
ghae: '*'
ghec: '*'
type: tutorial
topics:
- CD
- Python
- Azure App Service
---
{% data reusables.actions.enterprise-beta %}
{% data reusables.actions.enterprise-github-hosted-runners %}
## Introduction
This guide explains how to use {% data variables.product.prodname_actions %} to build and deploy a Python project to [Azure App Service](https://azure.microsoft.com/services/app-service/).
{% ifversion fpt or ghec or ghae-issue-4856 %}
{% note %}
**Note**: {% data reusables.actions.about-oidc-short-overview %} and "[Configuring OpenID Connect in Azure](/actions/deployment/security-hardening-your-deployments/configuring-openid-connect-in-azure)."
{% endnote %}
{% endif %}
## Prerequisites
Before creating your {% data variables.product.prodname_actions %} workflow, you will first need to complete the following setup steps:
{% data reusables.actions.create-azure-app-plan %}
1. Create a web app.
For example, you can use the Azure CLI to create an Azure App Service web app with a Python runtime:
```bash{:copy}
az webapp create \
--name MY_WEBAPP_NAME \
--plan MY_APP_SERVICE_PLAN \
--resource-group MY_RESOURCE_GROUP \
--runtime "python|3.8"
```
In the command above, replace the parameters with your own values, where `MY_WEBAPP_NAME` is a new name for the web app.
{% data reusables.actions.create-azure-publish-profile %}
1. Add an app setting called `SCM_DO_BUILD_DURING_DEPLOYMENT` and set the value to `1`.
{% ifversion fpt or ghes > 3.0 or ghae or ghec %}
5. Optionally, configure a deployment environment. {% data reusables.actions.about-environments %}
{% endif %}
## Creating the workflow
Once you've completed the prerequisites, you can proceed with creating the workflow.
The following example workflow demonstrates how to build and deploy a Python project to Azure App Service when there is a push to the `main` branch.
Ensure that you set `AZURE_WEBAPP_NAME` in the workflow `env` key to the name of the web app you created. If you use a version of Python other than `3.8`, change `PYTHON_VERSION` to the version that you use.
{% data reusables.actions.delete-env-key %}
```yaml{:copy}
{% data reusables.actions.actions-not-certified-by-github-comment %}
name: Build and deploy Python app to Azure Web App
env:
AZURE_WEBAPP_NAME: MY_WEBAPP_NAME # set this to your application's name
PYTHON_VERSION: '3.8' # set this to the Python version to use
on:
push:
branches:
- main
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Set up Python version
uses: actions/setup-python@v2.2.2
with:
python-version: {% raw %}${{ env.PYTHON_VERSION }}{% endraw %}
- name: Create and start virtual environment
run: |
python -m venv venv
source venv/bin/activate
- name: Set up dependency caching for faster installs
uses: actions/cache@v2
with:
path: ~/.cache/pip
key: {% raw %}${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}{% endraw %}
restore-keys: |
{% raw %}${{ runner.os }}-pip-{% endraw %}
- name: Install dependencies
run: pip install -r requirements.txt
# Optional: Add a step to run tests here (PyTest, Django test suites, etc.)
- name: Upload artifact for deployment jobs
uses: actions/upload-artifact@v2
with:
name: python-app
path: |
.
!venv/
deploy:
runs-on: ubuntu-latest
needs: build
environment:
name: 'production'
url: {% raw %}${{ steps.deploy-to-webapp.outputs.webapp-url }}{% endraw %}
steps:
- name: Download artifact from build job
uses: actions/download-artifact@v2
with:
name: python-app
path: .
- name: 'Deploy to Azure Web App'
id: deploy-to-webapp
uses: azure/webapps-deploy@0b651ed7546ecfc75024011f76944cb9b381ef1e
with:
app-name: {% raw %}${{ env.AZURE_WEBAPP_NAME }}{% endraw %}
publish-profile: {% raw %}${{ secrets.AZURE_WEBAPP_PUBLISH_PROFILE }}{% endraw %}
```
## Additional resources
The following resources may also be useful:
* For the original starter workflow, see [`azure-webapps-python.yml`](https://github.com/actions/starter-workflows/blob/main/deployments/azure-webapps-python.yml) in the {% data variables.product.prodname_actions %} `starter-workflows` repository.
* The action used to deploy the web app is the official Azure [`Azure/webapps-deploy`](https://github.com/Azure/webapps-deploy) action.
* For more examples of GitHub Action workflows that deploy to Azure, see the [actions-workflow-samples](https://github.com/Azure/actions-workflow-samples) repository.

View File

@@ -0,0 +1,126 @@
---
title: Deploying to Azure Kubernetes Service
intro: You can deploy your project to Azure Kubernetes Service (AKS) as part of your continuous deployment (CD) workflows.
versions:
fpt: '*'
ghes: '*'
ghae: '*'
ghec: '*'
type: tutorial
topics:
- CD
- Azure Kubernetes Service
---
{% data reusables.actions.enterprise-beta %}
{% data reusables.actions.enterprise-github-hosted-runners %}
## Introduction
This guide explains how to use {% data variables.product.prodname_actions %} to build and deploy a project to [Azure Kubernetes Service](https://azure.microsoft.com/services/kubernetes-service/).
{% ifversion fpt or ghec or ghae-issue-4856 %}
{% note %}
**Note**: {% data reusables.actions.about-oidc-short-overview %} and "[Configuring OpenID Connect in Azure](/actions/deployment/security-hardening-your-deployments/configuring-openid-connect-in-azure)."
{% endnote %}
{% endif %}
## Prerequisites
Before creating your {% data variables.product.prodname_actions %} workflow, you will first need to complete the following setup steps:
1. Create a target AKS cluster and an Azure Container Registry (ACR). For more information, see "[Quickstart: Deploy an AKS cluster by using the Azure portal - Azure Kubernetes Service](https://docs.microsoft.com/azure/aks/kubernetes-walkthrough-portal)" and "[Quickstart - Create registry in portal - Azure Container Registry](https://docs.microsoft.com/azure/container-registry/container-registry-get-started-portal)" in the Azure documentation.
1. Create a secret called `AZURE_CREDENTIALS` to store your Azure credentials. For more information about how to find this information and structure the secret, see [the `Azure/login` action documentation](https://github.com/Azure/login#configure-a-service-principal-with-a-secret).
## Creating the workflow
Once you've completed the prerequisites, you can proceed with creating the workflow.
The following example workflow demonstrates how to build and deploy a project to Azure Kubernetes Service when code is pushed to your repository.
Under the workflow `env` key, change the the following values:
- `AZURE_CONTAINER_REGISTRY` to the name of your container registry
- `PROJECT_NAME` to the name of your project
- `RESOURCE_GROUP` to the resource group containing your AKS cluster
- `CLUSTER_NAME` to the name of your AKS cluster
This workflow uses the `helm` render engine for the [`azure/k8s-bake` action](https://github.com/Azure/k8s-bake). If you will use the `helm` render engine, change the value of `CHART_PATH` to the path to your helm file. Change `CHART_OVERRIDE_PATH` to an array of override file paths. If you use a different render engine, update the input parameters sent to the `azure/k8s-bake` action.
```yaml{:copy}
{% data reusables.actions.actions-not-certified-by-github-comment %}
name: Build and deploy to Azure Kubernetes Service
env:
AZURE_CONTAINER_REGISTRY: MY_REGISTRY_NAME # set this to the name of your container registry
PROJECT_NAME: MY_PROJECT_NAME # set this to your project's name
RESOURCE_GROUP: MY_RESOURCE_GROUP # set this to the resource group containing your AKS cluster
CLUSTER_NAME: MY_CLUSTER_NAME # set this to the name of your AKS cluster
REGISTRY_URL: MY_REGISTRY_URL # set this to the URL of your registry
# If you bake using helm:
CHART_PATH: MY_HELM_FILE # set this to the path to your helm file
CHART_OVERRIDE_PATH: MY_OVERRIDE_FILES # set this to an array of override file paths
on: [push]
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@master
- name: Azure Login
uses: azure/login@89d153571fe9a34ed70fcf9f1d95ab8debea7a73
with:
creds: {% raw %}${{ secrets.AZURE_CREDENTIALS }}{% endraw %}
- name: Build image on ACR
uses: azure/CLI@7378ce2ca3c38b4b063feb7a4cbe384fef978055
with:
azcliversion: 2.29.1
inlineScript: |
az configure --defaults acr={% raw %}${{ env.AZURE_CONTAINER_REGISTRY }}{% endraw %}
az acr build -t -t {% raw %}${{ env.REGISTRY_URL }}{% endraw %}/{% raw %}${{ env.PROJECT_NAME }}{% endraw %}:{% raw %}${{ github.sha }}{% endraw %}
- name: Gets K8s context
uses: azure/aks-set-context@4e5aec273183a197b181314721843e047123d9fa
with:
creds: {% raw %}${{ secrets.AZURE_CREDENTIALS }}{% endraw %}
resource-group: {% raw %}${{ env.RESOURCE_GROUP }}{% endraw %}
cluster-name: {% raw %}${{ env.CLUSTER_NAME }}{% endraw %}
id: login
- name: Configure deployment
uses: azure/k8s-bake@773b6144a3732e3bf4c78b146a0bb9617b2e016b
with:
renderEngine: 'helm'
helmChart: {% raw %}${{ env.CHART_PATH }}{% endraw %}
overrideFiles: {% raw %}${{ env.CHART_OVERRIDE_PATH }}{% endraw %}
overrides: |
replicas:2
helm-version: 'latest'
id: bake
- name: Deploys application
- uses: Azure/k8s-deploy@c8fbd76ededaad2799c054a9fd5d0fa5d4e9aee4
with:
manifests: {% raw %}${{ steps.bake.outputs.manifestsBundle }}{% endraw %}
images: |
{% raw %}${{ env.AZURE_CONTAINER_REGISTRY }}{% endraw %}.azurecr.io/{% raw %}${{ env.PROJECT_NAME }}{% endraw %}:{% raw %}${{ github.sha }}{% endraw %}
imagepullsecrets: |
{% raw %}${{ env.PROJECT_NAME }}{% endraw %}
```
## Additional resources
The following resources may also be useful:
* For the original starter workflow, see [`azure-kubernetes-service.yml `](https://github.com/actions/starter-workflows/blob/main/deployments/azure-kubernetes-service.yml) in the {% data variables.product.prodname_actions %} `starter-workflows` repository.
* The actions used to in this workflow are the official Azure [`Azure/login`](https://github.com/Azure/login),[`Azure/aks-set-context`](https://github.com/Azure/aks-set-context), [`Azure/CLI`](https://github.com/Azure/CLI), [`Azure/k8s-bake`](https://github.com/Azure/k8s-bake), and [`Azure/k8s-deploy`](https://github.com/Azure/k8s-deploy)actions.
* For more examples of GitHub Action workflows that deploy to Azure, see the [actions-workflow-samples](https://github.com/Azure/actions-workflow-samples) repository.

View File

@@ -0,0 +1,113 @@
---
title: Deploying to Azure Static Web App
intro: You can deploy your web app to Azure Static Web App as part of your continuous deployment (CD) workflows.
versions:
fpt: '*'
ghes: '*'
ghae: '*'
ghec: '*'
type: tutorial
topics:
- CD
- Azure Static Web Apps
---
{% data reusables.actions.enterprise-beta %}
{% data reusables.actions.enterprise-github-hosted-runners %}
## Introduction
This guide explains how to use {% data variables.product.prodname_actions %} to build and deploy a web app to [Azure Static Web Apps](https://azure.microsoft.com/services/app-service/static/).
{% ifversion fpt or ghec or ghae-issue-4856 %}
{% note %}
**Note**: {% data reusables.actions.about-oidc-short-overview %} and "[Configuring OpenID Connect in Azure](/actions/deployment/security-hardening-your-deployments/configuring-openid-connect-in-azure)."
{% endnote %}
{% endif %}
## Prerequisites
Before creating your {% data variables.product.prodname_actions %} workflow, you will first need to complete the following setup steps:
1. Create an Azure Static Web App using the 'Other' option for deployment source. For more information, see "[Quickstart: Building your first static site in the Azure portal](https://docs.microsoft.com/azure/static-web-apps/get-started-portal)" in the Azure documentation.
2. Create a secret called `AZURE_STATIC_WEB_APPS_API_TOKEN` with the value of your static web app deployment token. For more information about how to find your deployment token, see "[Reset deployment tokens in Azure Static Web Apps](https://docs.microsoft.com/azure/static-web-apps/deployment-token-management)" in the Azure documentation.
## Creating the workflow
Once you've completed the prerequisites, you can proceed with creating the workflow.
The following example workflow demonstrates how to build and deploy an Azure static web app when there is a push to the `main` branch or when a pull request targeting `main` is opened, synchronized, or reopened. The workflow also tears down the corresponding pre-production deployment when a pull request targeting `main` is closed.
Under the workflow `env` key, change the following values:
- `APP_LOCATION` to the location of your client code
- `API_LOCATION` to the location of your API source code. If `API_LOCATION` is not relevant, you can delete the variable and the lines where it is used.
- `APP_ARTIFACT_LOCATION` to the location of your client code build output
For more information about these values, see "[Build configuration for Azure Static Web Apps](https://docs.microsoft.com/azure/static-web-apps/build-configuration?tabs=github-actions)" in the Azure documentation.
```yaml{:copy}
{% data reusables.actions.actions-not-certified-by-github-comment %}
name: Deploy web app to Azure Static Web Apps
env:
APP_LOCATION: "/" # location of your client code
API_LOCATION: "api" # location of your api source code - optional
APP_ARTIFACT_LOCATION: "build" # location of client code build output
on:
push:
branches:
- main
pull_request:
types: [opened, synchronize, reopened, closed]
branches:
- main
permissions:
issues: write
jobs:
build_and_deploy:
if: github.event_name == 'push' || (github.event_name == 'pull_request' && github.event.action != 'closed')
runs-on: ubuntu-latest
name: Build and Deploy
steps:
- uses: actions/checkout@v2
with:
submodules: true
- name: Build And Deploy
uses: Azure/static-web-apps-deploy@1a947af9992250f3bc2e68ad0754c0b0c11566c9
with:
azure_static_web_apps_api_token: {% raw %}${{ secrets.AZURE_STATIC_WEB_APPS_API_TOKEN }}{% endraw %}
repo_token: {% raw %}${{ secrets.GITHUB_TOKEN }}{% endraw %}
action: "upload"
app_location: {% raw %}${{ env.APP_LOCATION }}{% endraw %}
api_location: {% raw %}${{ env.API_LOCATION }}{% endraw %}
app_artifact_location: {% raw %}${{ env.APP_ARTIFACT_LOCATION }}{% endraw %}
close:
if: github.event_name == 'pull_request' && github.event.action == 'closed'
runs-on: ubuntu-latest
name: Close
steps:
- name: Close
uses: Azure/static-web-apps-deploy@1a947af9992250f3bc2e68ad0754c0b0c11566c9
with:
azure_static_web_apps_api_token: {% raw %}${{ secrets.AZURE_STATIC_WEB_APPS_API_TOKEN }}{% endraw %}
action: "close"
```
## Additional resources
The following resources may also be useful:
* For the original starter workflow, see [`azure-staticwebapp.yml`](https://github.com/actions/starter-workflows/blob/main/deployments/azure-staticwebapp.yml) in the {% data variables.product.prodname_actions %} `starter-workflows` repository.
* The action used to deploy the web app is the official Azure [`Azure/static-web-apps-deploy`](https://github.com/Azure/static-web-apps-deploy) action.
* For more examples of GitHub Action workflows that deploy to Azure, see the [actions-workflow-samples](https://github.com/Azure/actions-workflow-samples) repository.

View File

@@ -0,0 +1,19 @@
---
title: Deploying to Azure
shortTitle: Deploy to Azure
intro: Learn how to deploy to Azure App Service, Azure Kubernetes, and Azure Static Web App as part of your continuous deployment (CD) workflows.
versions:
fpt: '*'
ghes: '*'
ghae: '*'
ghec: '*'
children:
- /deploying-nodejs-to-azure-app-service
- /deploying-python-to-azure-app-service
- /deploying-java-to-azure-app-service
- /deploying-net-to-azure-app-service
- /deploying-php-to-azure-app-service
- /deploying-docker-to-azure-app-service
- /deploying-to-azure-static-web-app
- /deploying-to-azure-kubernetes-service
---

View File

@@ -4,11 +4,11 @@ shortTitle: Deploying to your cloud provider
intro: 'You can deploy to various cloud providers, such as AWS, Azure, and GKE.'
versions:
fpt: '*'
ghae: issue-4856
ghae: '*'
ghec: '*'
ghes: '*'
children:
- /deploying-to-amazon-elastic-container-service
- /deploying-to-azure-app-service
- /deploying-to-azure
- /deploying-to-google-kubernetes-engine
---

View File

@@ -43,7 +43,6 @@ includeGuides:
- /actions/using-containerized-services/creating-redis-service-containers
- /actions/using-containerized-services/creating-postgresql-service-containers
- /actions/deployment/deploying-to-amazon-elastic-container-service
- /actions/deployment/deploying-to-azure-app-service
- /actions/deployment/deploying-to-google-kubernetes-engine
- /actions/learn-github-actions/essential-features-of-github-actions
- /actions/security-guides/security-hardening-for-github-actions
@@ -64,5 +63,13 @@ includeGuides:
- /actions/managing-issues-and-pull-requests/removing-a-label-when-a-card-is-added-to-a-project-board-column
- /code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/automating-dependabot-with-github-actions
- /code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/keeping-your-actions-up-to-date-with-dependabot
- /actions/deployment/deploying-to-your-cloud-provider/deploying-to-azure/deploying-docker-to-azure-app-service
- /actions/deployment/deploying-to-your-cloud-provider/deploying-to-azure/deploying-java-to-azure-app-service
- /actions/deployment/deploying-to-your-cloud-provider/deploying-to-azure/deploying-net-to-azure-app-service
- /actions/deployment/deploying-to-your-cloud-provider/deploying-to-azure/deploying-nodejs-to-azure-app-service
- /actions/deployment/deploying-to-your-cloud-provider/deploying-to-azure/deploying-php-to-azure-app-service
- /actions/deployment/deploying-to-your-cloud-provider/deploying-to-azure/deploying-python-to-azure-app-service
- /actions/deployment/deploying-to-your-cloud-provider/deploying-to-azure/deploying-to-azure-static-web-app
- /actions/deployment/deploying-to-your-cloud-provider/deploying-to-azure/deploying-to-azure-kubernetes-service
---

View File

@@ -30,10 +30,10 @@ changelog:
examples_source: data/product-examples/actions/code-examples.yml
product_video: 'https://www.youtube-nocookie.com/embed/cP0I9w2coGU'
redirect_from:
- /articles/automating-your-workflow-with-github-actions/
- /articles/customizing-your-project-with-github-actions/
- /articles/automating-your-workflow-with-github-actions
- /articles/customizing-your-project-with-github-actions
- /github/automating-your-workflow-with-github-actions
- /actions/automating-your-workflow-with-github-actions/
- /actions/automating-your-workflow-with-github-actions
- /categories/automating-your-workflow-with-github-actions
- /marketplace/actions
- /actions/reference

View File

@@ -221,7 +221,7 @@ The following table indicates where each context and special function can be use
| Path | Context | Special functions |
| ---- | ------- | ----------------- |
| <code>concurrency</code> | <code>github</code> | |
| <code>concurrency</code> | <code>github, inputs</code> | |
| <code>env</code> | <code>github, secrets, inputs</code> | |
| <code>jobs.&lt;job_id&gt;.concurrency</code> | <code>github, needs, strategy, matrix, inputs</code> | |
| <code>jobs.&lt;job_id&gt;.container</code> | <code>github, needs, strategy, matrix, inputs</code> | |

View File

@@ -11,7 +11,7 @@ redirect_from:
- /actions/getting-started-with-github-actions/overview
- /actions/getting-started-with-github-actions/getting-started-with-github-actions
- /actions/configuring-and-managing-workflows/configuring-a-workflow
- /articles/creating-a-workflow-with-github-actions/
- /articles/creating-a-workflow-with-github-actions
- /articles/configuring-a-workflow
- /github/automating-your-workflow-with-github-actions/configuring-a-workflow
- /actions/automating-your-workflow-with-github-actions/configuring-a-workflow

View File

@@ -18,9 +18,9 @@ topics:
## Overview
Rather than copying and pasting from one workflow to another, you can make workflows reusable. You and anyone with access to the reusable workflow can then call the reusable workflow from another workflow.
Rather than copying and pasting from one workflow to another, you can make workflows reusable. You and anyone with access to the reusable workflow can then call the reusable workflow from another workflow.
Reusing workflows avoids duplication. This makes workflows easier to maintain and allows you to create new workflows more quickly by building on the work of others, just as you do with actions. Workflow reuse also promotes best practice by helping you to use workflows that are well designed, have already been tested, and have been proved to be effective. Your organization can build up a library of reusable workflows that can be centrally maintained.
Reusing workflows avoids duplication. This makes workflows easier to maintain and allows you to create new workflows more quickly by building on the work of others, just as you do with actions. Workflow reuse also promotes best practice by helping you to use workflows that are well designed, have already been tested, and have been proved to be effective. Your organization can build up a library of reusable workflows that can be centrally maintained.
The diagram below shows three build jobs on the left of the diagram. After each of these jobs completes successfully a dependent job called "Deploy" runs. This job calls a reusable workflow that contains three jobs: "Staging", "Review", and "Production." The "Production" deployment job only runs after the "Staging" job has completed successfully. Using a reusable workflow to run deployment jobs allows you to run those jobs for each build without duplicating code in workflows.
@@ -67,7 +67,6 @@ Called workflows can access self-hosted runners from caller's context. This mean
* Reusable workflows can't call other reusable workflows.
* Reusable workflows stored within a private repository can only be used by workflows within the same repository.
* Any environment variables set in an `env` context defined at the workflow level in the caller workflow are not propagated to the called workflow. For more information about the `env` context, see "[Context and expression syntax for GitHub Actions](/actions/reference/context-and-expression-syntax-for-github-actions#env-context)."
* You can't set the concurrency of a called workflow from the caller workflow. For more information about `jobs.<job_id>.concurrency`, see "[Workflow syntax for GitHub Actions](/actions/learn-github-actions/workflow-syntax-for-github-actions#jobsjob_idconcurrency)."
* The `strategy` property is not supported in any job that calls a reusable workflow.
## Creating a reusable workflow
@@ -77,13 +76,13 @@ Reusable workflows are YAML-formatted files, very similar to any other workflow
For a workflow to be reusable, the values for `on` must include `workflow_call`:
```yaml
on:
on:
workflow_call:
```
### Using inputs and secrets in a reusable workflow
You can define inputs and secrets, which can be passed from the caller workflow and then used within the called workflow. There are three stages to using an input or a secret in a reusable workflow.
You can define inputs and secrets, which can be passed from the caller workflow and then used within the called workflow. There are three stages to using an input or a secret in a reusable workflow.
1. In the reusable workflow, use the `inputs` and `secrets` keywords to define inputs or secrets that will be passed from a caller workflow.
{% raw %}
@@ -112,10 +111,10 @@ You can define inputs and secrets, which can be passed from the caller workflow
- uses: ./.github/actions/my-action@v1
with:
username: ${{ inputs.username }}
token: ${{ secrets.envPAT }}
token: ${{ secrets.envPAT }}
```
{% endraw %}
In the example above, `envPAT` is an environment secret that's been added to the `production` environment. This environment is therefore referenced within the job.
In the example above, `envPAT` is an environment secret that's been added to the `production` environment. This environment is therefore referenced within the job.
{% note %}
@@ -153,7 +152,7 @@ jobs:
- uses: ./.github/actions/my-action@v1
with:
username: ${{ inputs.username }}
token: ${{ secrets.token }}
token: ${{ secrets.token }}
```
{% endraw %}
@@ -163,7 +162,7 @@ You call a reusable workflow by using the `uses` keyword. Unlike when you are us
[`jobs.<job_id>.uses`](/actions/reference/workflow-syntax-for-github-actions#jobsjob_iduses)
You reference reusable workflow files using the syntax:
You reference reusable workflow files using the syntax:
`{owner}/{repo}/{path}/{filename}@{ref}`
@@ -191,7 +190,7 @@ When you call a reusable workflow, you can only use the following keywords in th
{% note %}
**Note:**
**Note:**
* If `jobs.<job_id>.permissions` is not specified in the calling job, the called workflow will have the default permissions for the `GITHUB_TOKEN`. For more information, see "[Authentication in a workflow](/actions/reference/authentication-in-a-workflow#permissions-for-the-github_token)."
* The `GITHUB_TOKEN` permissions passed from the caller workflow can be only downgraded (not elevated) by the called workflow.
@@ -226,7 +225,7 @@ jobs:
## Using outputs from a reusable workflow
A reusable workflow may generate data that you want to use in the caller workflow. To use these outputs, you must specify them as the outputs of the reusable workflow.
A reusable workflow may generate data that you want to use in the caller workflow. To use these outputs, you must specify them as the outputs of the reusable workflow.
The following reusable workflow has a single job containing two steps. In each of these steps we set a single word as the output: "hello" and "world." In the `outputs` section of the job, we map these step outputs to job outputs called: `output1` and `output2`. In the `on.workflow_call.outputs` section we then define two outputs for the workflow itself, one called `firstword` which we map to `output1`, and one called `secondword` which we map to `output2`.
@@ -243,12 +242,12 @@ on:
value: ${{ jobs.example_job.outputs.output1 }}
secondword:
description: "The second output string"
value: ${{ jobs.example_job.outputs.output2 }}
value: ${{ jobs.example_job.outputs.output2 }}
jobs:
example_job:
name: Generate output
runs-on: ubuntu-latest
runs-on: ubuntu-latest
# Map the job outputs to step outputs
outputs:
output1: ${{ steps.step1.outputs.firstword }}

View File

@@ -25,9 +25,9 @@ topics:
## About workflow templates
{% data variables.product.product_name %} offers workflow templates for a variety of languages and tooling. When you set up workflows in your repository, {% data variables.product.product_name %} analyzes the code in your repository and recommends workflows based on the language and framework in your repository. For example, if you use [Node.js](https://nodejs.org/en/), {% data variables.product.product_name %} will suggest a template file that installs your Node.js packages and runs your tests.
{% data variables.product.product_name %} offers workflow templates for a variety of languages and tooling. When you set up workflows in your repository, {% data variables.product.product_name %} analyzes the code in your repository and recommends workflows based on the language and framework in your repository. For example, if you use [Node.js](https://nodejs.org/en/), {% data variables.product.product_name %} will suggest a template file that installs your Node.js packages and runs your tests.{% if actions-starter-template-ui %} You can search and filter to find relevant workflow templates.{% endif %}
You can also create your own workflow templates to share with your organization. For more information, see "[Creating workflow templates](/actions/learn-github-actions/creating-workflow-templates)."
You can also create your own workflow templates to share with your organization. These templates will appear alongside the {% data variables.product.product_name %} workflow templates. For more information, see "[Creating workflow templates](/actions/learn-github-actions/creating-workflow-templates)."
## Using workflow templates
@@ -36,8 +36,8 @@ Anyone with write permission to a repository can set up {% data variables.produc
{% data reusables.repositories.navigate-to-repo %}
{% data reusables.repositories.actions-tab %}
1. If you already have a workflow in your repository, click **New workflow**.
1. Find the template that you want to use, then click **Set up this workflow**.
1. If the workflow template contains comments detailing additional setup steps, follow these steps.
1. Find the template that you want to use, then click **Set up this workflow**.{% if actions-starter-template-ui %} To help you find the template that you want, you can search for keywords or filter by category.{% endif %}
1. If the workflow template contains comments detailing additional setup steps, follow these steps. Many of the templates have corresponding guides. For more information, see [the {% data variables.product.prodname_actions %} guides](/actions/guides)."
1. Some workflow templates use secrets. For example, {% raw %}`${{ secrets.npm_token }}`{% endraw %}. If the workflow template uses a secret, store the value described in the secret name as a secret in your repository. For more information, see "[Encrypted secrets](/actions/reference/encrypted-secrets)."
1. Optionally, make additional changes. For example, you might want to change the value of `on` to change when the workflow runs.
1. Click **Start commit**.

View File

@@ -9,7 +9,7 @@ versions:
ghec: '*'
redirect_from:
- /actions/migrating-to-github-actions
- /articles/migrating-github-actions-from-hcl-syntax-to-yaml-syntax/
- /articles/migrating-github-actions-from-hcl-syntax-to-yaml-syntax
children:
- /migrating-from-azure-pipelines-to-github-actions
- /migrating-from-circleci-to-github-actions

View File

@@ -71,6 +71,15 @@ These attributes are available. You can change the attribute names in the [manag
| `public_keys` | Optional | The public SSH keys for the user. More than one can be specified. |
| `gpg_keys` | Optional | The GPG keys for the user. More than one can be specified. |
To specify more than one value for an attribute, use multiple `<saml2:AttributeValue>` elements.
```
<saml2:Attribute FriendlyName="public_keys" Name="urn:oid:1.2.840.113549.1.1.1" NameFormat="urn:oasis:names:tc:SAML:2.0:attrname-format:uri">
<saml2:AttributeValue>ssh-rsa LONG KEY</saml2:AttributeValue>
<saml2:AttributeValue>ssh-rsa LONG KEY 2</saml2:AttributeValue>
</saml2:Attribute>
```
## Configuring SAML settings
{% data reusables.enterprise_site_admin_settings.access-settings %}

View File

@@ -31,6 +31,8 @@ Because client connections to {% data variables.product.prodname_ghe_server %} c
{% data reusables.enterprise_clustering.proxy_xff_firewall_warning %}
{% data reusables.enterprise_installation.terminating-tls %}
### Enabling PROXY protocol support on {% data variables.product.product_location %}
We strongly recommend enabling PROXY protocol support for both your appliance and the load balancer. Use the instructions provided by your vendor to enable the PROXY protocol on your load balancer. For more information, see [the PROXY protocol documentation](http://www.haproxy.org/download/1.8/doc/proxy-protocol.txt).
@@ -50,8 +52,6 @@ We strongly recommend enabling PROXY protocol support for both your appliance an
{% data reusables.enterprise_clustering.x-forwarded-for %}
{% data reusables.enterprise_installation.terminating-tls %}
{% data reusables.enterprise_site_admin_settings.access-settings %}
{% data reusables.enterprise_site_admin_settings.management-console %}
{% data reusables.enterprise_management_console.privacy %}

View File

@@ -56,8 +56,8 @@ If you need to get information on the users, organizations, and repositories in
Specifically, you can download CSV reports that list
- all users
- all users who have been active within the last month
- all users who have been inactive for one month or more
- all active users
- all [dormant users](/admin/user-management/managing-dormant-users)
- all users who have been suspended
- all organizations
- all repositories

View File

@@ -10,7 +10,6 @@ redirect_from:
- /enterprise/admin/configuration/connecting-github-enterprise-server-to-github-enterprise-cloud
- /admin/configuration/connecting-github-enterprise-server-to-github-enterprise-cloud
- /admin/configuration/managing-connections-between-github-enterprise-server-and-github-enterprise-cloud/connecting-github-enterprise-server-to-github-enterprise-cloud
permissions: 'Enterprise owners who are also owners of a {% data variables.product.prodname_ghe_cloud %} organization or enterprise account can enable {% data variables.product.prodname_github_connect %}.'
versions:
ghes: '*'
ghae: '*'
@@ -60,6 +59,12 @@ Enabling {% data variables.product.prodname_github_connect %} will not allow {%
For more information about managing enterprise accounts using the GraphQL API, see "[Enterprise accounts](/graphql/guides/managing-enterprise-accounts)."
## Enabling {% data variables.product.prodname_github_connect %}
Enterprise owners who are also owners of an organization or enterprise account that uses {% data variables.product.prodname_ghe_cloud %} can enable {% data variables.product.prodname_github_connect %}.
If you're connecting {% data variables.product.product_location %} to an organization on {% data variables.product.prodname_dotcom_the_website %} that is not owned by an enterprise account, you must enable {% data variables.product.prodname_github_connect %} with a personal account on {% data variables.product.prodname_dotcom_the_website %} that is an owner of the organization.
If you're connecting {% data variables.product.product_location %} to an organization on {% data variables.product.prodname_dotcom_the_website %} that is owned by an enterprise account or to an enterprise account itself, you must enable {% data variables.product.prodname_github_connect %} with a personal account on {% data variables.product.prodname_dotcom_the_website %} that is an owner of the enterprise account.
{% ifversion ghes %}
1. Sign in to {% data variables.product.product_location %} and {% data variables.product.prodname_dotcom_the_website %}.
{% data reusables.enterprise-accounts.access-enterprise %}{% ifversion ghes < 3.1 %}{% data reusables.enterprise-accounts.settings-tab %}{% endif %}{% data reusables.enterprise-accounts.github-connect-tab %}{% else %}
@@ -73,7 +78,9 @@ For more information about managing enterprise accounts using the GraphQL API, s
1. Next to the enterprise account or organization you'd like to connect, click **Connect**.
![Connect button next to an enterprise account or business](/assets/images/enterprise/business-accounts/choose-enterprise-or-org-connect.png)
## Disconnecting a {% data variables.product.prodname_ghe_cloud %} organization or enterprise account from your enterprise account
## Disabling {% data variables.product.prodname_github_connect %}
Enterprise owners can disable {% data variables.product.prodname_github_connect %}.
When you disconnect from {% data variables.product.prodname_ghe_cloud %}, the {% data variables.product.prodname_github_connect %} {% data variables.product.prodname_github_app %} is deleted from your enterprise account or organization and credentials stored on {% data variables.product.product_location %} are deleted.

View File

@@ -37,6 +37,8 @@ For more information about these features, see "[About the dependency graph](/gi
You can connect {% data variables.product.product_location %} to {% data variables.product.prodname_dotcom_the_website %} with {% data variables.product.prodname_github_connect %}. Once connected, vulnerability data is synced from the {% data variables.product.prodname_advisory_database %} to your instance once every hour. You can also choose to manually sync vulnerability data at any time. No code or information about code from {% data variables.product.product_location %} is uploaded to {% data variables.product.prodname_dotcom_the_website %}.
Only {% data variables.product.company_short %}-reviewed advisories are synchronized. {% data reusables.security-advisory.link-browsing-advisory-db %}
### About generation of {% data variables.product.prodname_dependabot_alerts %}
If you enable vulnerability detection, when {% data variables.product.product_location %} receives information about a vulnerability, it identifies repositories in your instance that use the affected version of the dependency and generates {% data variables.product.prodname_dependabot_alerts %}. You can choose whether or not to notify users automatically about new {% data variables.product.prodname_dependabot_alerts %}.

View File

@@ -1,7 +1,7 @@
---
title: GitHub Actions を有効化して GitHub Enterprise Server をバックアップおよび復元する
shortTitle: バックアップと復元
intro: '外部ストレージプロバイダの {% data variables.product.prodname_actions %} データは、通常の {% data variables.product.prodname_ghe_server %} バックアップに含まれていないため、個別にバックアップする必要があります。'
title: Backing up and restoring GitHub Enterprise Server with GitHub Actions enabled
shortTitle: Backing up and restoring
intro: '{% data variables.product.prodname_actions %} data on your external storage provider is not included in regular {% data variables.product.prodname_ghe_server %} backups, and must be backed up separately.'
versions:
ghes: '*'
type: how_to
@@ -13,18 +13,43 @@ topics:
redirect_from:
- /admin/github-actions/backing-up-and-restoring-github-enterprise-server-with-github-actions-enabled
---
{% data reusables.actions.enterprise-storage-ha-backups %}
{% data variables.product.prodname_enterprise_backup_utilities %} を使用して {% data variables.product.product_location %} をバックアップする場合、外部ストレージプロバイダに保存されている {% data variables.product.prodname_actions %} データはバックアップに含まれないことにご注意ください。
If you use {% data variables.product.prodname_enterprise_backup_utilities %} to back up {% data variables.product.product_location %}, it's important to note that {% data variables.product.prodname_actions %} data stored on your external storage provider is not included in the backup.
以下は、{% data variables.product.product_location %} {% data variables.product.prodname_actions %} を新しいアプライアンスに復元するために必要なステップの概要です。
This is an overview of the steps required to restore {% data variables.product.product_location %} with {% data variables.product.prodname_actions %} to a new appliance:
1. 元のアプライアンスがオフラインであることを確認します。
1. 交換用の {% data variables.product.prodname_ghe_server %} アプライアンスでネットワーク設定を手動設定します。 ネットワーク設定はバックアップスナップショットから除外され、`ghe-restore` で上書きされません。
1. 元のアプライアンスと同じ {% data variables.product.prodname_actions %} 外部ストレージ設定を使用するように交換用アプライアンスを設定します。
1. 交換用アプライアンスで {% data variables.product.prodname_actions %} を有効化します。 これにより、交換用アプライアンスが {% data variables.product.prodname_actions %} の同じ外部ストレージに接続されます。
1. {% data variables.product.prodname_actions %} を外部ストレージプロバイダで設定したら、`ghe-restore` コマンドを使用して、バックアップから残りのデータを復元します。 詳しい情報については、「[バックアップを復元する](/admin/configuration/configuring-backups-on-your-appliance#restoring-a-backup)」を参照してください。
1. セルフホストランナーを交換用アプライアンスに再登録します。 詳しい情報については、「[セルフホストランナーを追加する](/actions/hosting-your-own-runners/adding-self-hosted-runners)」を参照してください。
1. Confirm that the original appliance is offline.
1. Manually configure network settings on the replacement {% data variables.product.prodname_ghe_server %} appliance. Network settings are excluded from the backup snapshot, and are not overwritten by `ghe-restore`.
1. To configure the replacement appliance to use the same {% data variables.product.prodname_actions %} external storage configuration as the original appliance, from the new appliance, set the required parameters with `ghe-config` command.
- Azure Blob Storage
```shell
ghe-config secrets.actions.storage.blob-provider "azure"
ghe-config secrets.actions.storage.azure.connection-string "_Connection_String_"
```
- Amazon S3
```shell
ghe-config secrets.actions.storage.blob-provider "s3"
ghe-config secrets.actions.storage.s3.bucket-name "_S3_Bucket_Name"
ghe-config secrets.actions.storage.s3.service-url "_S3_Service_URL_"
ghe-config secrets.actions.storage.s3.access-key-id "_S3_Access_Key_ID_"
ghe-config secrets.actions.storage.s3.access-secret "_S3_Access_Secret_"
```
- Optionally, to enable S3 force path style, enter the following command:
```shell
ghe-config secrets.actions.storage.s3.force-path-style true
```
{% data variables.product.prodname_ghe_server %} のバックアップと復元の詳細については、「[アプライアンスでバックアップを設定する](/admin/configuration/configuring-backups-on-your-appliance)」を参照してください。
1. Enable {% data variables.product.prodname_actions %} on the replacement appliance. This will connect the replacement appliance to the same external storage for {% data variables.product.prodname_actions %}.
```shell
ghe-config app.actions.enabled true
ghe-config-apply
```
1. After {% data variables.product.prodname_actions %} is configured and enabled, use the `ghe-restore` command to restore the rest of the data from the backup. For more information, see "[Restoring a backup](/admin/configuration/configuring-backups-on-your-appliance#restoring-a-backup)."
1. Re-register your self-hosted runners on the replacement appliance. For more information, see [Adding self-hosted runners](/actions/hosting-your-own-runners/adding-self-hosted-runners).
For more information on backing up and restoring {% data variables.product.prodname_ghe_server %}, see "[Configuring backups on your appliance](/admin/configuration/configuring-backups-on-your-appliance)."

View File

@@ -62,7 +62,7 @@ Before launching {% data variables.product.product_location %} on Azure, you'll
{% data reusables.enterprise_installation.necessary_ports %}
4. Create and attach a new unencrypted data disk to the VM, and configure the size based on your user license count. For more information, see "[az vm disk attach](https://docs.microsoft.com/cli/azure/vm/disk?view=azure-cli-latest#az_vm_disk_attach)" in the Microsoft documentation.
4. Create and attach a new managed data disk to the VM, and configure the size based on your license count. All Azure managed disks created since June 10, 2017 are encrypted at rest by default with Storage Service Encryption (SSE). For more information about the `az vm disk attach` command, see "[az vm disk attach](https://docs.microsoft.com/cli/azure/vm/disk?view=azure-cli-latest#az_vm_disk_attach)" in the Microsoft documentation.
Pass in options for the name of your VM (for example, `ghe-acme-corp`), the resource group, the premium storage SKU, the size of the disk (for example, `100`), and a name for the resulting VHD.

View File

@@ -1,6 +1,6 @@
---
title: GitHub AE について
intro: '{% data variables.product.prodname_ghe_managed %} は、クラウドで {% data variables.product.prodname_dotcom %} を使用するためにセキュリティが強化された準拠した方法です。'
title: About GitHub AE
intro: '{% data variables.product.prodname_ghe_managed %} is a security-enhanced and compliant way to use {% data variables.product.prodname_dotcom %} in the cloud.'
versions:
ghae: '*'
type: overview
@@ -9,32 +9,33 @@ topics:
- Fundamentals
---
## {% data variables.product.prodname_ghe_managed %}について
## About {% data variables.product.prodname_ghe_managed %}
{% data reusables.github-ae.github-ae-enables-you %} {% data variables.product.prodname_ghe_managed %} は完全に管理され、信頼性が高く、スケーラブルであるため、リスク管理を犠牲にすることなくデリバリを迅速化できます。
{% data reusables.github-ae.github-ae-enables-you %} {% data variables.product.prodname_ghe_managed %} is fully managed, reliable, and scalable, allowing you to accelerate delivery without sacrificing risk management.
{% data variables.product.prodname_ghe_managed %} は、アイデアから本番まで1つの開発者プラットフォームを提供します。 Team が使い慣れたツールを使用して開発速度を上げることができます。また、独自のセキュリティとアクセス制御、ワークフローの自動化、およびポリシーの適用により、業界と規制のコンプライアンスを維持できます。
{% data variables.product.prodname_ghe_managed %} offers one developer platform from idea to production. You can increase development velocity with the tools that teams know and love, while you maintain industry and regulatory compliance with unique security and access controls, workflow automation, and policy enforcement.
## 高可用性および地球規模のクラウド
## A highly available and planet-scale cloud
{% data variables.product.prodname_ghe_managed %} は、高可用性アーキテクチャでホストされているフルマネージドサービスです。 {% data variables.product.prodname_ghe_managed %} は、クラウドでグローバルにホストされており、無制限に開発ライフサイクル全体をサポートするように拡張できます。 {% data variables.product.prodname_dotcom %} は、バックアップ、フェイルオーバー、およびシステム災害復旧を完全に管理するため、サービスやデータについて心配する必要はありません。
{% data variables.product.prodname_ghe_managed %} is a fully managed service, hosted in a high availability architecture. {% data variables.product.prodname_ghe_managed %} is hosted globally in a cloud that can scale to support your full development lifecycle without limits. {% data variables.product.prodname_dotcom %} fully manages backups, failover, and disaster recovery, so you never need to worry about your service or data.
## データの常駐
## Data residency
すべてのデータは、ユーザが選択したリージョン内で保存されます。 すべてのデータを選択したリージョン内に保存することで、GDPR およびグローバルデータ保護基準に準拠できます。
All of your data is stored within the geographic region of your choosing. You can comply with GDPR and global data protection standards by keeping all of your data within your chosen region.
## 分離されたアカウント
## Isolated accounts
すべての開発者アカウントは、{% data variables.product.prodname_ghe_managed %} 内で完全に分離されています。 SAML シングルサインオンを必須として、アイデンティティプロバイダを介してアカウントを完全に制御できます。 SCIM を使用すると、中央のアイデンティティ管理システムで定義されているように、従業員が必要なリソースにのみアクセスできるようにすることができます。 詳しい情報については、「[Enterprise のアイデンティティとアクセスを管理する](/admin/authentication/managing-identity-and-access-for-your-enterprise)」を参照してください。
All developer accounts are fully isolated in {% data variables.product.prodname_ghe_managed %}. You can fully control the accounts through your identity provider, with SAML single sign on as mandatory. SCIM enables you to ensure that employees only have access to the resources they should, as defined in your central identity management system. For more information, see "[Managing identity and access for your enterprise](/admin/authentication/managing-identity-and-access-for-your-enterprise)."
## 制限付きネットワークアクセス
## Restricted network access
ネットワークアクセスが制限された {% data variables.product.prodname_ghe_managed %} での Enterprise への安全なアクセスにより、データはネットワーク内からのみアクセスできます。 詳しい情報については、「[Enterprise へのネットワークトラフィックを制限する](/admin/configuration/restricting-network-traffic-to-your-enterprise)」を参照してください。
Secure access to your enterprise on {% data variables.product.prodname_ghe_managed %} with restricted network access, so that your data can only be accessed from within your network. For more information, see "[Restricting network traffic to your enterprise](/admin/configuration/restricting-network-traffic-to-your-enterprise)."
## 商用および政府環境
## Commercial and government environments
{% data variables.product.prodname_ghe_managed %} は、Azure Government クラウドという、米国政府機関とそのパートナー向けの信頼できるクラウドで利用できます。 {% data variables.product.prodname_ghe_managed %} は商用クラウドでも利用できるため、Organization に適したホスティング環境を選択できます。
{% data variables.product.prodname_ghe_managed %} is available in the Azure Government cloud, the trusted cloud for US government agencies and their partners. {% data variables.product.prodname_ghe_managed %} is also available in the commercial cloud, so you can choose the hosting environment that is right for your organization.
## 参考リンク
## Further reading
- "[About versions of {% data variables.product.prodname_docs %}](/get-started/learning-about-github/about-versions-of-github-docs)"
- "[Receiving help from {% data variables.product.company_short %} Support](/admin/enterprise-support/receiving-help-from-github-support)"

View File

@@ -35,8 +35,13 @@ When your code depends on a package that has a security vulnerability, this vuln
{% data variables.product.prodname_dependabot %} detects vulnerable dependencies and sends {% data variables.product.prodname_dependabot_alerts %} when:
{% ifversion fpt or ghec %}
- A new vulnerability is added to the {% data variables.product.prodname_advisory_database %}. For more information, see "[Browsing security vulnerabilities in the {% data variables.product.prodname_advisory_database %}](/github/managing-security-vulnerabilities/browsing-security-vulnerabilities-in-the-github-advisory-database)" and "[About {% data variables.product.prodname_security_advisories %}](/code-security/security-advisories/about-github-security-advisories)."{% else %}
- A new vulnerability is added to the {% data variables.product.prodname_advisory_database %}. For more information, see "[Browsing security vulnerabilities in the {% data variables.product.prodname_advisory_database %}](/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/browsing-security-vulnerabilities-in-the-github-advisory-database)" and "[About {% data variables.product.prodname_security_advisories %}](/code-security/security-advisories/about-github-security-advisories)."{% else %}
- New advisory data is synchronized to {% data variables.product.product_location %} each hour from {% data variables.product.prodname_dotcom_the_website %}. {% data reusables.security-advisory.link-browsing-advisory-db %}{% endif %}
{% note %}
**Note:** Only advisories that have been reviewed by {% data variables.product.company_short %} will trigger {% data variables.product.prodname_dependabot_alerts %}.
{% endnote %}
- The dependency graph for a repository changes. For example, when a contributor pushes a commit to change the packages or versions it depends on{% ifversion fpt or ghec %}, or when the code of one of the dependencies changes{% endif %}. For more information, see "[About the dependency graph](/code-security/supply-chain-security/about-the-dependency-graph)."
{% data reusables.repositories.dependency-review %}

View File

@@ -2,6 +2,7 @@
title: Browsing security vulnerabilities in the GitHub Advisory Database
intro: 'The {% data variables.product.prodname_advisory_database %} allows you to browse or search for vulnerabilities that affect open source projects on {% data variables.product.company_short %}.'
shortTitle: Browse Advisory Database
miniTocMaxHeadingLevel: 3
redirect_from:
- /github/managing-security-vulnerabilities/browsing-security-vulnerabilities-in-the-github-advisory-database
- /code-security/supply-chain-security/browsing-security-vulnerabilities-in-the-github-advisory-database
@@ -22,13 +23,29 @@ topics:
{% data reusables.repositories.a-vulnerability-is %}
{% data variables.product.product_name %} will send you {% data variables.product.prodname_dependabot_alerts %} if we detect that any of the vulnerabilities from the {% data variables.product.prodname_advisory_database %} affect the packages that your repository depends on. For more information, see "[About alerts for vulnerable dependencies](/code-security/supply-chain-security/about-alerts-for-vulnerable-dependencies)."
## About the {% data variables.product.prodname_advisory_database %}
The {% data variables.product.prodname_advisory_database %} contains a curated list of security vulnerabilities that have been mapped to packages tracked by the {% data variables.product.company_short %} dependency graph. {% data reusables.repositories.tracks-vulnerabilities %}
The {% data variables.product.prodname_advisory_database %} contains a list of known security vulnerabilities, grouped in two categories: {% data variables.product.company_short %}-reviewed advisories and unreviewed advisories.
Each security advisory contains information about the vulnerability, including the description, severity, affected package, package ecosystem, affected versions and patched versions, impact, and optional information such as references, workarounds, and credits. In addition, advisories from the National Vulnerability Database list contain a link to the CVE record, where you can read more details about the vulnerability, its CVSS scores, and its qualitative severity level. For more information, see the "[National Vulnerability Database](https://nvd.nist.gov/)" from the National Institute of Standards and Technology.
{% data reusables.repositories.tracks-vulnerabilities %}
### About {% data variables.product.company_short %}-reviewed advisories
{% data variables.product.company_short %}-reviewed advisories are security vulnerabilities that have been mapped to packages tracked by the {% data variables.product.company_short %} dependency graph.
We carefully review each advisory for validity. Each {% data variables.product.company_short %}-reviewed advisory has a full description, and contains both ecosystem and package information.
If you enable {% data variables.product.prodname_dependabot_alerts %} for your repositories, you are automatically notified when a new {% data variables.product.company_short %}-reviewed advisory affects packages you depend on. For more information, see "[About alerts for vulnerable dependencies](/code-security/supply-chain-security/about-alerts-for-vulnerable-dependencies)."
### About unreviewed advisories
Unreviewed advisories are security vulnerabilites that we publish automatically into the {% data variables.product.prodname_advisory_database %}, directly from the National Vulnerability Database feed.
{% data variables.product.prodname_dependabot %} doesn't create {% data variables.product.prodname_dependabot_alerts %} for unreviewed advisories as this type of advisory isn't checked for validity or completion.
## About security advisories
Each security advisory contains information about the vulnerability, which may include the description, severity, affected package, package ecosystem, affected versions and patched versions, impact, and optional information such as references, workarounds, and credits. In addition, advisories from the National Vulnerability Database list contain a link to the CVE record, where you can read more details about the vulnerability, its CVSS scores, and its qualitative severity level. For more information, see the "[National Vulnerability Database](https://nvd.nist.gov/)" from the National Institute of Standards and Technology.
The severity level is one of four possible levels defined in the "[Common Vulnerability Scoring System (CVSS), Section 5](https://www.first.org/cvss/specification-document)."
- Low
@@ -45,6 +62,11 @@ The {% data variables.product.prodname_advisory_database %} uses the CVSS levels
1. Navigate to https://github.com/advisories.
2. Optionally, to filter the list, use any of the drop-down menus.
![Dropdown filters](/assets/images/help/security/advisory-database-dropdown-filters.png)
{% tip %}
**Tip:** You can use the sidebar on the left to explore {% data variables.product.company_short %}-reviewed and unreviewed advisories separately.
{% endtip %}
3. Click on any advisory to view details.
{% note %}
@@ -63,6 +85,8 @@ You can search the database, and use qualifiers to narrow your search. For examp
| Qualifier | Example |
| ------------- | ------------- |
| `type:reviewed`| [**type:reviewed**](https://github.com/advisories?query=type%3Areviewed) will show {% data variables.product.company_short %}-reviewed advisories. |
| `type:unreviewed`| [**type:unreviewed**](https://github.com/advisories?query=type%3Aunreviewed) will show unreviewed advisories. |
| `GHSA-ID`| [**GHSA-49wp-qq6x-g2rf**](https://github.com/advisories?query=GHSA-49wp-qq6x-g2rf) will show the advisory with this {% data variables.product.prodname_advisory_database %} ID. |
| `CVE-ID`| [**CVE-2020-28482**](https://github.com/advisories?query=CVE-2020-28482) will show the advisory with this CVE ID number. |
| `ecosystem:ECOSYSTEM`| [**ecosystem:npm**](https://github.com/advisories?utf8=%E2%9C%93&query=ecosystem%3Anpm) will show only advisories affecting NPM packages. |
@@ -80,7 +104,7 @@ You can search the database, and use qualifiers to narrow your search. For examp
## Viewing your vulnerable repositories
For any vulnerability in the {% data variables.product.prodname_advisory_database %}, you can see which of your repositories have a {% data variables.product.prodname_dependabot %} alert for that vulnerability. To see a vulnerable repository, you must have access to {% data variables.product.prodname_dependabot_alerts %} for that repository. For more information, see "[About alerts for vulnerable dependencies](/code-security/supply-chain-security/about-alerts-for-vulnerable-dependencies#access-to-dependabot-alerts)."
For any {% data variables.product.company_short %}-reviewed advisory in the {% data variables.product.prodname_advisory_database %}, you can see which of your repositories are affected by that security vulnerability. To see a vulnerable repository, you must have access to {% data variables.product.prodname_dependabot_alerts %} for that repository. For more information, see "[About alerts for vulnerable dependencies](/code-security/supply-chain-security/about-alerts-for-vulnerable-dependencies#access-to-dependabot-alerts)."
1. Navigate to https://github.com/advisories.
2. Click an advisory.

View File

@@ -2,7 +2,7 @@
title: About wikis
intro: 'You can host documentation for your repository in a wiki, so that others can use and contribute to your project.'
redirect_from:
- /articles/about-github-wikis/
- /articles/about-github-wikis
- /articles/about-wikis
- /github/building-a-strong-community/about-wikis
product: '{% data reusables.gated-features.wikis %}'

View File

@@ -1,11 +1,11 @@
---
title: ウィキページを追加または編集する
intro: 'ウィキページは、{% data variables.product.product_name %} 上で直接、あるいはコマンドラインを使ってローカルで追加および編集できます。'
title: Adding or editing wiki pages
intro: 'You can add and edit wiki pages directly on {% data variables.product.product_name %} or locally using the command line.'
redirect_from:
- /articles/adding-wiki-pages-via-the-online-interface/
- /articles/editing-wiki-pages-via-the-online-interface/
- /articles/adding-and-editing-wik-pages-locally/
- /articles/adding-and-editing-wiki-pages-locally/
- /articles/adding-wiki-pages-via-the-online-interface
- /articles/editing-wiki-pages-via-the-online-interface
- /articles/adding-and-editing-wik-pages-locally
- /articles/adding-and-editing-wiki-pages-locally
- /articles/adding-or-editing-wiki-pages
- /github/building-a-strong-community/adding-or-editing-wiki-pages
product: '{% data reusables.gated-features.wikis %}'
@@ -16,47 +16,55 @@ versions:
ghec: '*'
topics:
- Community
shortTitle: Wikiページの管理
shortTitle: Manage wiki pages
---
## ウィキページを追加する
## Adding wiki pages
{% data reusables.repositories.navigate-to-repo %}
{% data reusables.repositories.sidebar-wiki %}
3. ページの右上にある [**New Page**] をクリックします。 ![ウィキの新規ページボタン](/assets/images/help/wiki/wiki_new_page_button.png)
4. Markdown 以外のフォーマットで書くために、[Edit mode] ドロップダウンメニューを使い、他のフォーマットをクリックすることもできます。 ![ウィキのマークアップの選択](/assets/images/help/wiki/wiki_dropdown_markup.gif)
5. テキストエディタを使って、ページの内容を追加してください。 ![ウィキの WYSIWYG](/assets/images/help/wiki/wiki_wysiwyg.png)
6. 追加しようとしている新しいファイルを説明するコミットメッセージを入力してください。 ![ウィキのコミットメッセージ](/assets/images/help/wiki/wiki_commit_message.png)
7. 変更を wiki にコミットするには [**Save Page**] をクリックします。
3. In the upper-right corner of the page, click **New Page**.
![Wiki new page button](/assets/images/help/wiki/wiki_new_page_button.png)
4. Optionally, to write in a format other than Markdown, use the Edit mode drop-down menu, and click a different format.
![Wiki markup selection](/assets/images/help/wiki/wiki_dropdown_markup.gif)
5. Use the text editor to add your page's content.
![Wiki WYSIWYG](/assets/images/help/wiki/wiki_wysiwyg.png)
6. Type a commit message describing the new file youre adding.
![Wiki commit message](/assets/images/help/wiki/wiki_commit_message.png)
7. To commit your changes to the wiki, click **Save Page**.
## ウィキページを編集する
## Editing wiki pages
{% data reusables.repositories.navigate-to-repo %}
{% data reusables.repositories.sidebar-wiki %}
4. ウィキサイドバーを使用して、変更したいページに移動してください。 ページの右上にある [**Edit**] をクリックしてください。 ![ウィキのページ編集ボタン](/assets/images/help/wiki/wiki_edit_page_button.png)
5. テキストエディタを使って、ページの内容を編集します。 ![ウィキの WYSIWYG](/assets/images/help/wiki/wiki_wysiwyg.png)
6. 変更内容を説明するコミットメッセージを入力します。 ![ウィキのコミットメッセージ](/assets/images/help/wiki/wiki_commit_message.png)
7. 変更を wiki にコミットするには [**Save Page**] をクリックします。
4. Using the wiki sidebar, navigate to the page you want to change. In the upper-right corner of the page, click **Edit**.
![Wiki edit page button](/assets/images/help/wiki/wiki_edit_page_button.png)
5. Use the text editor edit the page's content.
![Wiki WYSIWYG](/assets/images/help/wiki/wiki_wysiwyg.png)
6. Type a commit message describing your changes.
![Wiki commit message](/assets/images/help/wiki/wiki_commit_message.png)
7. To commit your changes to the wiki, click **Save Page**.
## ローカルでウィキページを追加または編集する
## Adding or editing wiki pages locally
ウィキは Git のリポジトリの一部なので、Git ワークフローを使ってローカルで変更を加え、リポジトリにプッシュできます。
Wikis are part of Git repositories, so you can make changes locally and push them to your repository using a Git workflow.
### 手元のコンピュータへウィキをクローンする
### Cloning wikis to your computer
すべてのウィキは、その内容をあなたのコンピュータにクローンする簡単な方法を提供しています。 提供されている次の URL でお使いのコンピュータにリポジトリをクローンできます。
Every wiki provides an easy way to clone its contents down to your computer.
You can clone the repository to your computer with the provided URL:
```shell
$ git clone https://github.com/<em>YOUR_USERNAME</em>/<em>YOUR_REPOSITORY</em>.wiki.git
# ローカルに wiki をクローン
# Clones the wiki locally
```
wiki をクローンした後は、新しいファイルの追加、既存のファイルの編集、変更のコミットができます。 ユーザとコラボレータは、Wiki で作業するときにブランチを作成できますが、デフォルトブランチにプッシュされた変更のみがライブになり、読者はそれのみを利用できます。
Once you have cloned the wiki, you can add new files, edit existing ones, and commit your changes. You and your collaborators can create branches when working on wikis, but only changes pushed to the default branch will be made live and available to your readers.
## ウィキのファイル名について
## About wiki filenames
wiki のページのタイトルはファイル名で決まり、ファイルの拡張子で wiki の内容の描画方法が決まります。
The filename determines the title of your wiki page, and the file extension determines how your wiki content is rendered.
wiki は[弊社のオープンソースマークアップライブラリ](https://github.com/github/markup)でマークアップに変換され、ライブラリはファイルの拡張子によって使用するコンバータが決定されます。 たとえばファイルに *foo.md* あるいは *foo.markdown* という名前を付けた場合、wiki は Markdown コンバータを使います。一方で、*foo.textile* という名前のファイルには Textile コンバータが使われます。
Wikis use [our open-source Markup library](https://github.com/github/markup) to convert the markup, and it determines which converter to use by a file's extension. For example, if you name a file *foo.md* or *foo.markdown*, wiki will use the Markdown converter, while a file named *foo.textile* will use the Textile converter.
wiki ページのタイトルには `\ / : * ? " < > |` という文字は使わないでください。 特定のオペレーティングシステムのユーザは、これらの文字を含むファイル名を扱えません。 内容を書く上では、拡張子にマッチしたマークアップ言語を使ってください。そうなっていない場合、内容は正しく描画されません。
Don't use the following characters in your wiki page's titles: `\ / : * ? " < > |`. Users on certain operating systems won't be able to work with filenames containing these characters. Be sure to write your content using a markup language that matches the extension, or your content won't render properly.

View File

@@ -1,9 +1,9 @@
---
title: ウィキにフッタやサイドバーを作成する
intro: カスタムのサイドバーやフッタをウィキに追加して、さらに多くのコンテキスト情報を読者に提供できます。
title: Creating a footer or sidebar for your wiki
intro: You can add a custom sidebar or footer to your wiki to provide readers with more contextual information.
redirect_from:
- /articles/creating-a-footer/
- /articles/creating-a-sidebar/
- /articles/creating-a-footer
- /articles/creating-a-sidebar
- /articles/creating-a-footer-or-sidebar-for-your-wiki
- /github/building-a-strong-community/creating-a-footer-or-sidebar-for-your-wiki
product: '{% data reusables.gated-features.wikis %}'
@@ -14,27 +14,33 @@ versions:
ghec: '*'
topics:
- Community
shortTitle: フッターまたはサイドバーの作成
shortTitle: Create footer or sidebar
---
## フッタの作成
## Creating a footer
{% data reusables.repositories.navigate-to-repo %}
{% data reusables.repositories.sidebar-wiki %}
3. ページの下部にある [**Add a custom footer**] をクリックします。 ![ウィキのフッタセクションの追加](/assets/images/help/wiki/wiki_add_footer.png)
4. テキストエディタを使用して、フッタに表示するコンテンツを入力します。 ![ウィキの WYSIWYG](/assets/images/help/wiki/wiki-footer.png)
5. 追加中のフッタを説明するコミットメッセージを入力します。 ![ウィキのコミットメッセージ](/assets/images/help/wiki/wiki_commit_message.png)
6. 変更を wiki にコミットするには [**Save Page**] をクリックします。
3. At the bottom of the page, click **Add a custom footer**.
![Wiki add footer section](/assets/images/help/wiki/wiki_add_footer.png)
4. Use the text editor to type the content you want your footer to have.
![Wiki WYSIWYG](/assets/images/help/wiki/wiki-footer.png)
5. Enter a commit message describing the footer youre adding.
![Wiki commit message](/assets/images/help/wiki/wiki_commit_message.png)
6. To commit your changes to the wiki, click **Save Page**.
## サイドバーの作成
## Creating a sidebar
{% data reusables.repositories.navigate-to-repo %}
{% data reusables.repositories.sidebar-wiki %}
3. [**Add a custom sidebar**] をクリックします。 ![ウィキのサイドバーの追加](/assets/images/help/wiki/wiki_add_sidebar.png)
4. テキストエディタを使って、ページの内容を追加してください。 ![ウィキの WYSIWYG](/assets/images/help/wiki/wiki-sidebar.png)
5. 追加するサイドバーを説明するコミットメッセージを入力します。 ![ウィキのコミットメッセージ](/assets/images/help/wiki/wiki_commit_message.png)
6. 変更を wiki にコミットするには [**Save Page**] をクリックします。
3. Click **Add a custom sidebar**.
![Wiki add sidebar section](/assets/images/help/wiki/wiki_add_sidebar.png)
4. Use the text editor to add your page's content.
![Wiki WYSIWYG](/assets/images/help/wiki/wiki-sidebar.png)
5. Enter a commit message describing the sidebar youre adding.
![Wiki commit message](/assets/images/help/wiki/wiki_commit_message.png)
6. To commit your changes to the wiki, click **Save Page**.
## フッタまたはサイドバーをローカルで作成
## Creating a footer or sidebar locally
`_Footer.<extension>` というファイルがフッタの、そして `_Sidebar.<extension>` というファイルがサイドバーの内容として使われます。 他のすべてのウィキページと同じく、これらのファイルは、その拡張子に応じて描画されます。
If you create a file named `_Footer.<extension>` or `_Sidebar.<extension>`, we'll use them to populate the footer and sidebar of your wiki, respectively. Like every other wiki page, the extension you choose for these files determines how we render them.

View File

@@ -1,14 +1,14 @@
---
title: ウィキのコンテンツを編集する
intro: ウィキ内のコンテンツに画像やリンクを追加したり、一部のサポートされている MediaWiki 形式を使用したりできます。
title: Editing wiki content
intro: 'You can add images and links to content in your wiki, and use some supported MediaWiki formats.'
redirect_from:
- /articles/adding-links-to-wikis/
- /articles/how-do-i-add-links-to-my-wiki/
- /articles/how-do-i-add-or-upload-images-to-the-wiki/
- /articles/needs-writing-review-how-do-i-add-or-upload-images-to-the-wiki/
- /articles/how-do-i-add-images-to-my-wiki/
- /articles/adding-images-to-wikis/
- /articles/supported-mediawiki-formats/
- /articles/adding-links-to-wikis
- /articles/how-do-i-add-links-to-my-wiki
- /articles/how-do-i-add-or-upload-images-to-the-wiki
- /articles/needs-writing-review-how-do-i-add-or-upload-images-to-the-wiki
- /articles/how-do-i-add-images-to-my-wiki
- /articles/adding-images-to-wikis
- /articles/supported-mediawiki-formats
- /articles/editing-wiki-content
- /github/building-a-strong-community/editing-wiki-content
product: '{% data reusables.gated-features.wikis %}'
@@ -21,39 +21,40 @@ topics:
- Community
---
## リンクの追加
## Adding links
ページでサポートされている標準的なマークアップや MediaWiki の構文を使ってウィキにリンクを作成できます。 例:
You can create links in wikis using the standard markup supported by your page, or using MediaWiki syntax. For example:
- ページが Markdown でレンダリングされる場合、リンクの構文は `[Link Text](full-URL-of-wiki-page)` です。
- MediaWiki 構文では、リンクの構文は `[[Link Text|nameofwikipage]]` となります。
- If your pages are rendered with Markdown, the link syntax is `[Link Text](full-URL-of-wiki-page)`.
- With MediaWiki syntax, the link syntax is `[[Link Text|nameofwikipage]]`.
## 画像の追加
## Adding images
ウィキでは PNGJPEG、および GIF 画像を表示できます。
Wikis can display PNG, JPEG, and GIF images.
{% data reusables.repositories.navigate-to-repo %}
{% data reusables.repositories.sidebar-wiki %}
3. ウィキ サイドバーを使って、変更したいページにアクセスし、[**Edit**] をクリックします。
4. ウィキ ツールバーで [**Image**] をクリックします。 ![ウィキの画像追加ボタン](/assets/images/help/wiki/wiki_add_image.png)
5. [Insert Image] ダイアログボックスで、画像の URL と代替テキスト (これは検索エンジンや画像リーダーで使われます) を入力します。
6. [**OK**] をクリックします。
3. Using the wiki sidebar, navigate to the page you want to change, and then click **Edit**.
4. On the wiki toolbar, click **Image**.
![Wiki Add image button](/assets/images/help/wiki/wiki_add_image.png)
5. In the "Insert Image" dialog box, type the image URL and the alt text (which is used by search engines and screen readers).
6. Click **OK**.
### リポジトリでの画像へのリンク
### Linking to images in a repository
{% data variables.product.product_name %}上のリポジトリにある画像は、ブラウザで URL をコピーし、それを画像へのパスとして利用することでリンクできます。 たとえば、Markdown を使ってウィキに画像を埋め込むと、以下のようになります:
You can link to an image in a repository on {% data variables.product.product_name %} by copying the URL in your browser and using that as the path to the image. For example, embedding an image in your wiki using Markdown might look like this:
[[https://github.com/USERNAME/REPOSITORY/blob/main/img/octocat.png|alt=octocat]]
## サポートされる MediaWiki 形式
## Supported MediaWiki formats
ウィキがどのマークアップ言語で書かれたかにかかわらず、特定の MediaWiki 構文を常に使用できます。
- リンク ([Asciidoc を除く](https://github.com/gollum/gollum/commit/d1cf698b456cd6a35a54c6a8e7b41d3068acec3b))
- 水平罫線: `---`
- 省略記号エンティティ (`&delta;` `&euro;` など)
No matter which markup language your wiki page is written in, certain MediaWiki syntax will always be available to you.
- Links ([except Asciidoc](https://github.com/gollum/gollum/commit/d1cf698b456cd6a35a54c6a8e7b41d3068acec3b))
- Horizontal rules via `---`
- Shorthand symbol entities (such as `&delta;` or `&euro;`)
セキュリティとパフォーマンス上の理由により、一部の構文はサポートされていません。
- [トランスクルージョン](https://www.mediawiki.org/wiki/Transclusion)
- 定義リスト
- インデント
- 目次
For security and performance reasons, some syntaxes are unsupported.
- [Transclusion](https://www.mediawiki.org/wiki/Transclusion)
- Definition lists
- Indentation
- Table of contents

View File

@@ -1,10 +1,10 @@
---
title: ウィキでプロジェクトを文書化する
shortTitle: Wikiを使用する
intro: ウィキを使用してプロジェクトに関する具体的な長文形式の情報を共有できます。
title: Documenting your project with wikis
shortTitle: Using wikis
intro: 'You can use a wiki to share detailed, long-form information about your project.'
redirect_from:
- /categories/49/articles/
- /categories/wiki/
- /categories/49/articles
- /categories/wiki
- /articles/documenting-your-project-with-wikis
- /github/building-a-strong-community/documenting-your-project-with-wikis
product: '{% data reusables.gated-features.wikis %}'

View File

@@ -1,8 +1,8 @@
---
title: リポジトリでのインタラクションを制限する
intro: パブリックリポジトリ上の特定のユーザに対して、一定期間アクティビティ制限を適用することができます。
title: Limiting interactions in your repository
intro: You can temporarily enforce a period of limited activity for certain users on a public repository.
redirect_from:
- /articles/limiting-interactions-with-your-repository/
- /articles/limiting-interactions-with-your-repository
- /articles/limiting-interactions-in-your-repository
- /github/building-a-strong-community/limiting-interactions-in-your-repository
versions:
@@ -11,30 +11,32 @@ versions:
permissions: People with admin permissions to a repository can temporarily limit interactions in that repository.
topics:
- Community
shortTitle: リポジトリ内でのインタラクションの制限
shortTitle: Limit interactions in repo
---
## 一時的なインタラクションの制限について
## About temporary interaction limits
{% data reusables.community.interaction-limits-restrictions %}
{% data reusables.community.interaction-limits-duration %} 制限期間が過ぎると、ユーザはリポジトリで通常のアクティビティを再開できます。
{% data reusables.community.interaction-limits-duration %} After the duration of your limit passes, users can resume normal activity in your repository.
{% data reusables.community.types-of-interaction-limits %}
ユーザアカウントまたは Organization が所有するすべてのリポジトリでアクティビティ制限を有効にすることもできます。 ユーザ全体または Organization 全体の制限が有効になっている場合、そのアカウントが所有する個々のリポジトリのアクティビティを制限することはできません。 詳しい情報については、「[ユーザアカウントのインタラクションを制限する](/communities/moderating-comments-and-conversations/limiting-interactions-for-your-user-account)」と「[Organization 内のインタラクションを制限する](/communities/moderating-comments-and-conversations/limiting-interactions-in-your-organization)」を参照してください。
You can also enable activity limitations on all repositories owned by your user account or an organization. If a user-wide or organization-wide limit is enabled, you can't limit activity for individual repositories owned by the account. For more information, see "[Limiting interactions for your user account](/communities/moderating-comments-and-conversations/limiting-interactions-for-your-user-account)" and "[Limiting interactions in your organization](/communities/moderating-comments-and-conversations/limiting-interactions-in-your-organization)."
## リポジトリでのインタラクションを制限する
## Limiting interactions in your repository
{% data reusables.repositories.navigate-to-repo %}
{% data reusables.repositories.sidebar-settings %}
1. 左サイドバーで [**Moderation settings**] をクリックします。 ![[Repository settings] サイトバーの [Moderation settings]](/assets/images/help/repository/repo-settings-moderation-settings.png)
1. [Moderation settings] で、[**Interaction limits**] をクリックします。 ![リポジトリの設定での [Interaction limits] ](/assets/images/help/repository/repo-settings-interaction-limits.png)
1. In the left sidebar, click **Moderation settings**.
!["Moderation settings" in repository settings sidebar](/assets/images/help/repository/repo-settings-moderation-settings.png)
1. Under "Moderation settings", click **Interaction limits**.
![Interaction limits in repository settings ](/assets/images/help/repository/repo-settings-interaction-limits.png)
{% data reusables.community.set-interaction-limit %}
![[Temporary interaction limits] のオプション](/assets/images/help/repository/temporary-interaction-limits-options.png)
![Temporary interaction limit options](/assets/images/help/repository/temporary-interaction-limits-options.png)
## 参考リンク
- [悪用あるいはスパムのレポート](/communities/maintaining-your-safety-on-github/reporting-abuse-or-spam)
- [Organizationのリポジトリへの個人のアクセスの管理](/articles/managing-an-individual-s-access-to-an-organization-repository)
- [ユーザアカウントのリポジトリ権限レベル](/articles/permission-levels-for-a-user-account-repository)
## Further reading
- "[Reporting abuse or spam](/communities/maintaining-your-safety-on-github/reporting-abuse-or-spam)"
- "[Managing an individual's access to an organization repository](/articles/managing-an-individual-s-access-to-an-organization-repository)"
- "[Permission levels for a user account repository](/articles/permission-levels-for-a-user-account-repository)"
- "[Repository roles for an organization](/organizations/managing-access-to-your-organizations-repositories/repository-roles-for-an-organization)"

View File

@@ -1,8 +1,8 @@
---
title: パブリックリポジトリのコミュニティプロフィールについて
intro: リポジトリメンテナは、コミュニティの成長を支援し、コントリビューターをサポートする方法を学ぶために、パブリックリポジトリのコミュニティプロフィールをレビューできます。 コントリビューターは、プロジェクトにコントリビュートしたいかを知るために、パブリックリポジトリのコミュニティプロフィールを見ることができます。
title: About community profiles for public repositories
intro: Repository maintainers can review their public repository's community profile to learn how they can help grow their community and support contributors. Contributors can view a public repository's community profile to see if they want to contribute to the project.
redirect_from:
- /articles/viewing-your-community-profile/
- /articles/viewing-your-community-profile
- /articles/about-community-profiles-for-public-repositories
- /github/building-a-strong-community/about-community-profiles-for-public-repositories
versions:
@@ -10,36 +10,36 @@ versions:
ghec: '*'
topics:
- Community
shortTitle: コミュニティプロフィール
shortTitle: Community profiles
---
コミュニティプロフィールチェックリストは、READMECODE_OF_CONDUCTLICENSECONTRIBUTING といった推奨されるコミュニティ健全性ファイル群が、サポートされている場所でプロジェクトに含まれているかをチェックします。 詳しい情報については[プロジェクトのコミュニティプロフィールへのアクセス](/articles/accessing-a-project-s-community-profile)を参照してください。
The community profile checklist checks to see if a project includes recommended community health files, such as README, CODE_OF_CONDUCT, LICENSE, or CONTRIBUTING, in a supported location. For more information, see "[Accessing a project's community profile](/articles/accessing-a-project-s-community-profile)."
## リポジトリメンテナとしてのコミュニティプロフィールチェックリストの利用
## Using the community profile checklist as a repository maintainer
リポジトリメンテナとして、人々がプロジェクトを使い、コントリビュートするのを助けるための推奨されるコミュニティ標準をプロジェクトが満たしているかを確認するために、コミュニティプロフィールチェックリストを使ってください。 詳しい情報についてはOpen Source Guides中の[コミュニティの構築](https://opensource.guide/building-community/)を参照してください。
As a repository maintainer, use the community profile checklist to see if your project meets the recommended community standards to help people use and contribute to your project. For more information, see "[Building community](https://opensource.guide/building-community/)" in the Open Source Guides.
プロジェクトが持っていない推奨されているファイルがあるなら、**Add追加**をクリックしてファイルのドラフトを作成し、サブミットしてください。
If a project doesn't have a recommended file, you can click **Add** to draft and submit a file.
{% data reusables.repositories.valid-community-issues %}詳細は「[Issue およびプルリクエストのテンプレートについて](/articles/about-issue-and-pull-request-templates)」を参照してください。
{% data reusables.repositories.valid-community-issues %} For more information, see "[About issue and pull request templates](/articles/about-issue-and-pull-request-templates)."
![メンテナのための推奨されるコミュニティ標準を持つコミュニティプロフィールチェックリスト](/assets/images/help/repository/add-button-community-profile.png)
![Community profile checklist with recommended community standards for maintainers](/assets/images/help/repository/add-button-community-profile.png)
{% data reusables.repositories.security-guidelines %}
## コミュニティメンバーあるいはコラボレータとしてのコミュニティプロフィールチェックリストの利用
## Using the community profile checklist as a community member or collaborator
コントリビューターになりたい場合は、コミュニティプロフィールチェックリストで、参加したいプロジェクトが推奨されるコミュニティ基準を満たしているかを確認してから、コントリビュートするかを決めてください。 詳しい情報については、Open Source Guides の「[コントリビュートの方法](https://opensource.guide/how-to-contribute/#anatomy-of-an-open-source-project)」を参照してください。
As a potential contributor, use the community profile checklist to see if a project meets the recommended community standards and decide if you'd like to contribute. For more information, see "[How to contribute](https://opensource.guide/how-to-contribute/#anatomy-of-an-open-source-project)" in the Open Source Guides.
プロジェクトに推奨されているファイルがないなら、**[Propose]** をクリックし、ファイルのドラフトを作成してから、そのファイルをサブミットしてリポジトリメンテナに承認を仰ぐことができます。
If a project doesn't have a recommended file, you can click **Propose** to draft and submit a file to the repository maintainer for approval.
![コントリビューターのための推奨されるコミュニティ標準を持つコミュニティプロフィールチェックリスト](/assets/images/help/repository/propose-button-community-profile.png)
![Community profile checklist with recommended community standards for contributors](/assets/images/help/repository/propose-button-community-profile.png)
## 参考リンク
## Further reading
- [プロジェクトへの行動規範の追加](/articles/adding-a-code-of-conduct-to-your-project)
- [リポジトリコントリビューターのためのガイドラインを定める](/articles/setting-guidelines-for-repository-contributors)
- [リポジトリへのライセンスの追加](/articles/adding-a-license-to-a-repository)
- [Issueとプルリクエストのテンプレートについて](/articles/about-issue-and-pull-request-templates)
- "[Adding a code of conduct to your project](/articles/adding-a-code-of-conduct-to-your-project)"
- "[Setting guidelines for repository contributors](/articles/setting-guidelines-for-repository-contributors)"
- "[Adding a license to a repository](/articles/adding-a-license-to-a-repository)"
- "[About issue and pull request templates](/articles/about-issue-and-pull-request-templates)"
- "[Open Source Guides](https://opensource.guide/)"
- [{% data variables.product.prodname_learning %}]({% data variables.product.prodname_learning_link %})

View File

@@ -1,9 +1,9 @@
---
title: 健全なコントリビューションを促すプロジェクトをセットアップする
shortTitle: 健全なコントリビューション
intro: リポジトリメンテナは、コントリビューションガイドラインを設定することで、コントリビュータがプロジェクトに対して意味のある有益なコントリビューションを行うことに役立ちます。
title: Setting up your project for healthy contributions
shortTitle: Healthy contributions
intro: 'Repository maintainers can set contributing guidelines to help collaborators make meaningful, useful contributions to a project.'
redirect_from:
- /articles/helping-people-contribute-to-your-project/
- /articles/helping-people-contribute-to-your-project
- /articles/setting-up-your-project-for-healthy-contributions
- /github/building-a-strong-community/setting-up-your-project-for-healthy-contributions
versions:

View File

@@ -7,7 +7,7 @@ versions:
ghae: '*'
ghec: '*'
redirect_from:
- /articles/how-do-i-set-up-guidelines-for-contributors/
- /articles/how-do-i-set-up-guidelines-for-contributors
- /articles/setting-guidelines-for-repository-contributors
- /github/building-a-strong-community/setting-guidelines-for-repository-contributors
topics:

View File

@@ -1,10 +1,10 @@
---
title: テンプレートを使用して便利な Issue やプルリクエストを推進する
shortTitle: Issue および PR テンプレート
intro: リポジトリメンテナは、コントリビューターが質の高い Issue とプルリクエストを作成できるように、リポジトリにテンプレートを追加できます。
title: Using templates to encourage useful issues and pull requests
shortTitle: Issue & PR templates
intro: Repository maintainers can add templates in a repository to help contributors create high-quality issues and pull requests.
redirect_from:
- /github/building-a-strong-community/using-issue-and-pull-request-templates
- /articles/using-templates-to-encourage-high-quality-issues-and-pull-requests-in-your-repository/
- /articles/using-templates-to-encourage-high-quality-issues-and-pull-requests-in-your-repository
- /articles/using-issue-and-pull-request-templates
- /github/building-a-strong-community/using-templates-to-encourage-useful-issues-and-pull-requests
versions:

View File

@@ -1,8 +1,8 @@
---
title: リポジトリ用の単一 Issue テンプレートを手動で作成する
intro: 手動で作成した Issue テンプレートをリポジトリに追加すると、プロジェクトのコントリビューターは自動的に Issue の本体でテンプレートの内容が見えるようになります。
title: Manually creating a single issue template for your repository
intro: 'When you add a manually-created issue template to your repository, project contributors will automatically see the template''s contents in the issue body.'
redirect_from:
- /articles/creating-an-issue-template-for-your-repository/
- /articles/creating-an-issue-template-for-your-repository
- /articles/manually-creating-a-single-issue-template-for-your-repository
- /github/building-a-strong-community/manually-creating-a-single-issue-template-for-your-repository
versions:
@@ -12,16 +12,16 @@ versions:
ghec: '*'
topics:
- Community
shortTitle: Issue テンプレートの作成
shortTitle: Create an issue template
---
{% data reusables.repositories.legacy-issue-template-tip %}
サポートしているどのフォルダーにでも *ISSUE_TEMPLATE/* サブディレクトリを作成し、Issue テンプレートを複数含めることができます。また、`template` クエリパラメータで Issue の本文に使用するテンプレートを指定できます。 詳細は「[クエリパラメータによる Issue およびプルリクエストの自動化について](/articles/about-automation-for-issues-and-pull-requests-with-query-parameters)」を参照してください。
You can create an *ISSUE_TEMPLATE/* subdirectory in any of the supported folders to contain multiple issue templates, and use the `template` query parameter to specify the template that will fill the issue body. For more information, see "[About automation for issues and pull requests with query parameters](/articles/about-automation-for-issues-and-pull-requests-with-query-parameters)."
YAML frontmatter を各 Issue テンプレートに追加して、Issue のタイトルを事前に入力したり、ラベルおよびアサインされた人を自動追加したり、リポジトリに新しい Issue を作成するときに表示されるテンプレート選択画面に表示されるテンプレートの名前と説明を指定したりすることができます。
You can add YAML frontmatter to each issue template to pre-fill the issue title, automatically add labels and assignees, and give the template a name and description that will be shown in the template chooser that people see when creating a new issue in your repository.
YAML front matter の例は次のとおりです。
Here is example YAML front matter.
```yaml
---
@@ -34,7 +34,7 @@ assignees: octocat
```
{% note %}
**注釈:** フロントマター値に `:` などの YAML特殊文字が含まれている場合は、値全体を引用符で囲む必要があります。 たとえば、`":bug: Bug"` または `":new: triage needed, :bug: bug"` などです。
**Note:** If a front matter value includes a YAML-reserved character such as `:` , you must put the whole value in quotes. For example, `":bug: Bug"` or `":new: triage needed, :bug: bug"`.
{% endnote %}
@@ -50,27 +50,31 @@ assignees: octocat
{% endif %}
## Issue テンプレートを追加する
## Adding an issue template
{% data reusables.repositories.navigate-to-repo %}
{% data reusables.files.add-file %}
3. ファイル名フィールドで:
- Issue テンプレートをリポジトリのルートディレクトリで表示するには、*issue_template* の名前を入力します。 たとえば、`issue_template.md` です。 ![ルートディレクトリの新しい Issue テンプレート名](/assets/images/help/repository/issue-template-file-name.png)
- リポジトリの `docs` ディレクトリに Issue テンプレートを表示するには、*docs/* に続けて *issue_template* の名前を入力します。 たとえば、`docs/issue_template.md` です。 ![docs ディレクトリの新しい Issue テンプレート](/assets/images/help/repository/issue-template-file-name-docs.png)
- ファイルを隠しディレクトリに格納するには、*.github/* と入力し、続いて *issue_template* という名前を入力します。 たとえば、`.github/issue_template.md` です。 ![隠しディレクトリの新しい Issue テンプレート](/assets/images/help/repository/issue-template-hidden-directory.png)
- 複数 Issue テンプレートを作成し、`template` クエリパラメータを使用して Issue の本文に使用するテンプレートを指定するには、*.github/ISSUE_TEMPLATE/* と入力し、続けて Issue テンプレートの名前を入力します。 たとえば、`.github/ISSUE_TEMPLATE/issue_template.md` です。 複数 Issue テンプレートをルートディレクトリや `docs/` ディレクトリにある `ISSUE_TEMPLATE` サブディレクトリに格納することもできます。 詳細は「[クエリパラメータによる Issue およびプルリクエストの自動化について](/articles/about-automation-for-issues-and-pull-requests-with-query-parameters)」を参照してください。 ![隠しディレクトリの新しい複数 Issue テンプレート](/assets/images/help/repository/issue-template-multiple-hidden-directory.png)
4. 新しいファイルの本文に Issue テンプレートを追加します。 そこに盛り込むべき項目として、以下のようなものがあります:
3. In the file name field:
- To make your issue template visible in the repository's root directory, type the name of your *issue_template*. For example, `issue_template.md`.
![New issue template name in root directory](/assets/images/help/repository/issue-template-file-name.png)
- To make your issue template visible in the repository's `docs` directory, type *docs/* followed by the name of your *issue_template*. For example, `docs/issue_template.md`,
![New issue template in docs directory](/assets/images/help/repository/issue-template-file-name-docs.png)
- To store your file in a hidden directory, type *.github/* followed by the name of your *issue_template*. For example, `.github/issue_template.md`.
![New issue template in hidden directory](/assets/images/help/repository/issue-template-hidden-directory.png)
- To create multiple issue templates and use the `template` query parameter to specify a template to fill the issue body, type *.github/ISSUE_TEMPLATE/*, then the name of your issue template. For example, `.github/ISSUE_TEMPLATE/issue_template.md`. You can also store multiple issue templates in an `ISSUE_TEMPLATE` subdirectory within the root or `docs/` directories. For more information, see "[About automation for issues and pull requests with query parameters](/articles/about-automation-for-issues-and-pull-requests-with-query-parameters)."
![New multiple issue template in hidden directory](/assets/images/help/repository/issue-template-multiple-hidden-directory.png)
4. In the body of the new file, add your issue template. This could include:
- YAML frontmatter
- 予測される動作と実際の動作
- 問題の再現手順
- プロジェクトのベンダー、オペレーティング システム、ハードウェアなどの仕様
- Expected behavior and actual behavior
- Steps to reproduce the problem
- Specifications like the version of the project, operating system, or hardware
{% data reusables.files.write_commit_message %}
{% data reusables.files.choose_commit_branch %} テンプレートがリポジトリのデフォルトブランチにマージされると、コラボレーターがテンプレートを使用できるようになります。
{% data reusables.files.choose_commit_branch %} Templates are available to collaborators when they are merged into the repository's default branch.
{% data reusables.files.propose_new_file %}
## 参考リンク
## Further reading
- [Issueとプルリクエストのテンプレートについて](/articles/about-issue-and-pull-request-templates)
- [リポジトリ用に Issue テンプレートを設定する](/articles/configuring-issue-templates-for-your-repository)
- [クエリパラメータによる Issue およびプルリクエストの自動化について](/articles/about-automation-for-issues-and-pull-requests-with-query-parameters)
- [Issue の作成](/articles/creating-an-issue)
- "[About issue and pull request templates](/articles/about-issue-and-pull-request-templates)"
- "[Configuring issue templates for your repository](/articles/configuring-issue-templates-for-your-repository)"
- "[About automation for issues and pull requests with query parameters](/articles/about-automation-for-issues-and-pull-requests-with-query-parameters)"
- "[Creating an issue](/articles/creating-an-issue)"

View File

@@ -1,9 +1,9 @@
---
title: GitHub App による認証
title: Authenticating with GitHub Apps
intro: '{% data reusables.shortdesc.authenticating_with_github_apps %}'
redirect_from:
- /apps/building-integrations/setting-up-and-registering-github-apps/about-authentication-options-for-github-apps/
- /apps/building-github-apps/authentication-options-for-github-apps/
- /apps/building-integrations/setting-up-and-registering-github-apps/about-authentication-options-for-github-apps
- /apps/building-github-apps/authentication-options-for-github-apps
- /apps/building-github-apps/authenticating-with-github-apps
- /developers/apps/authenticating-with-github-apps
versions:
@@ -13,59 +13,61 @@ versions:
ghec: '*'
topics:
- GitHub Apps
shortTitle: 認証
shortTitle: Authentication
---
## 秘密鍵を生成する
## Generating a private key
GitHub App の作成後は、1 つ以上の秘密鍵を生成する必要があります。 アクセストークンのリクエストに署名するには、この秘密鍵を使用します。
After you create a GitHub App, you'll need to generate one or more private keys. You'll use the private key to sign access token requests.
鍵が危殆化したり、鍵を紛失した場合にダウンタイムを回避するため、複数の秘密鍵を作成してローテーションすることができます。 秘密鍵が公開鍵と適合することを確認するには、[秘密鍵を検証する](#verifying-private-keys)を参照してください。
You can create multiple private keys and rotate them to prevent downtime if a key is compromised or lost. To verify that a private key matches a public key, see [Verifying private keys](#verifying-private-keys).
秘密鍵を生成するには、以下の手順に従います。
To generate a private key:
{% data reusables.user-settings.access_settings %}
{% data reusables.user-settings.developer_settings %}
{% data reusables.user-settings.github_apps %}
{% data reusables.user-settings.modify_github_app %}
5. [Private keys] で、[**Generate a private key**] をクリックします。 ![秘密鍵の生成](/assets/images/github-apps/github_apps_generate_private_keys.png)
6. お手元のコンピュータにダウンロードされた PEM フォーマットの秘密鍵が表示されます。 このファイルは必ず保存してください。GitHub では公開鍵の部分しか保存しません。
5. In "Private keys", click **Generate a private key**.
![Generate private key](/assets/images/github-apps/github_apps_generate_private_keys.png)
6. You will see a private key in PEM format downloaded to your computer. Make sure to store this file because GitHub only stores the public portion of the key.
{% note %}
**注釈:** 特定のファイルフォーマットが必要なライブラリを使用している場合、ダウンロードする PEM ファイルは `PKCS#1 RSAPrivateKey` フォーマットになります。
**Note:** If you're using a library that requires a specific file format, the PEM file you download will be in `PKCS#1 RSAPrivateKey` format.
{% endnote %}
## 秘密鍵を検証する
{% data variables.product.product_name %} generates a fingerprint for each private and public key pair using the SHA-256 hash function. 秘密鍵のフィンガープリントを生成し、{% data variables.product.product_name %} で表示されているフィンガープリントと比較することにより、秘密鍵が {% data variables.product.product_name %} に保存宇されている公開鍵と適合することを検証できます。
## Verifying private keys
{% data variables.product.product_name %} generates a fingerprint for each private and public key pair using the SHA-256 hash function. You can verify that your private key matches the public key stored on {% data variables.product.product_name %} by generating the fingerprint of your private key and comparing it to the fingerprint shown on {% data variables.product.product_name %}.
秘密鍵を検証するには、以下の手順に従います。
To verify a private key:
1. {% data variables.product.prodname_github_app %} の開発者設定ページにある [Private keys] セクションで、検証する秘密鍵と公開鍵のペアを見つけます。 詳しい情報については、[秘密鍵を生成する](#generating-a-private-key)を参照してください。 ![秘密鍵のフィンガープリント](/assets/images/github-apps/github_apps_private_key_fingerprint.png)
2. 次のコマンドを使用して、秘密鍵 (PEM) のフィンガープリントをローカルで生成します。
1. Find the fingerprint for the private and public key pair you want to verify in the "Private keys" section of your {% data variables.product.prodname_github_app %}'s developer settings page. For more information, see [Generating a private key](#generating-a-private-key).
![Private key fingerprint](/assets/images/github-apps/github_apps_private_key_fingerprint.png)
2. Generate the fingerprint of your private key (PEM) locally by using the following command:
```shell
$ openssl rsa -in <em>PATH_TO_PEM_FILE</em> -pubout -outform DER | openssl sha256 -binary | openssl base64
```
3. ローカルで生成されたフィンガープリントの結果と、{% data variables.product.product_name %} に表示されているフィンガープリントを比較します。
3. Compare the results of the locally generated fingerprint to the fingerprint you see in {% data variables.product.product_name %}.
## 秘密鍵を削除する
紛失や危殆化した秘密鍵は削除できますが、最低 1 つは秘密鍵を所有する必要があります。 鍵が 1 つしかない場合、その鍵を削除する前に新しい鍵を生成する必要があります。 ![直近の秘密鍵を削除する](/assets/images/github-apps/github_apps_delete_key.png)
## Deleting private keys
You can remove a lost or compromised private key by deleting it, but you must have at least one private key. When you only have one key, you will need to generate a new one before deleting the old one.
![Deleting last private key](/assets/images/github-apps/github_apps_delete_key.png)
## {% data variables.product.prodname_github_app %} として認証を行う
## Authenticating as a {% data variables.product.prodname_github_app %}
{% data variables.product.prodname_github_app %} として認証を行うと、以下のことが可能になります。
Authenticating as a {% data variables.product.prodname_github_app %} lets you do a couple of things:
* {% data variables.product.prodname_github_app %} について管理情報の概要を取得できます。
* アプリケーションのインストールのため、アクセストークンをリクエストできます。
* You can retrieve high-level management information about your {% data variables.product.prodname_github_app %}.
* You can request access tokens for an installation of the app.
{% data variables.product.prodname_github_app %} として認証するには、PEM フォーマットで[秘密鍵を生成](#generating-a-private-key)し、ローカルマシンにダウンロードします。 この鍵を使用して [JSON Web Token (JWT)](https://jwt.io/introduction) に署名し、`RS256` アルゴリズムを使用してエンコードします。 {% data variables.product.product_name %} は、トークンをアプリケーションが保存する公開鍵で検証することにより、リクエストが認証されていることを確認します。
To authenticate as a {% data variables.product.prodname_github_app %}, [generate a private key](#generating-a-private-key) in PEM format and download it to your local machine. You'll use this key to sign a [JSON Web Token (JWT)](https://jwt.io/introduction) and encode it using the `RS256` algorithm. {% data variables.product.product_name %} checks that the request is authenticated by verifying the token with the app's stored public key.
JWT を生成するために使用できる簡単な Ruby スクリプトを掲載します。 `gem install jwt` を実行してから、このスクリプトを使用してください。
Here's a quick Ruby script you can use to generate a JWT. Note you'll have to run `gem install jwt` before using it.
<a name="jwt-payload"></a>
```ruby
require 'openssl'
require 'jwt' # https://rubygems.org/gems/jwt
@@ -88,19 +90,19 @@ jwt = JWT.encode(payload, private_key, "RS256")
puts jwt
```
`YOUR_PATH_TO_PEM` `YOUR_APP_ID` の値は置き換えてください。 値はダブルクオートで囲んでください。
`YOUR_PATH_TO_PEM` and `YOUR_APP_ID` are the values you must replace. Make sure to enclose the values in double quotes.
{% data variables.product.prodname_github_app %} の識別子 (`YOUR_APP_ID`) を、JWT [iss](https://tools.ietf.org/html/rfc7519#section-4.1.1) (発行者) クレームの値として使用します。 {% data variables.product.prodname_github_app %} 識別子は、[アプリケーションを作成](/apps/building-github-apps/creating-a-github-app/)後の最初の webhook ping から、または GitHub.com UI のアプリケーション設定ページからいつでも取得できます。
Use your {% data variables.product.prodname_github_app %}'s identifier (`YOUR_APP_ID`) as the value for the JWT [iss](https://tools.ietf.org/html/rfc7519#section-4.1.1) (issuer) claim. You can obtain the {% data variables.product.prodname_github_app %} identifier via the initial webhook ping after [creating the app](/apps/building-github-apps/creating-a-github-app/), or at any time from the app settings page in the GitHub.com UI.
JWT を作成後は、それを API リクエストの `Header` に設定します。
After creating the JWT, set it in the `Header` of the API request:
```shell
$ curl -i -H "Authorization: Bearer YOUR_JWT" -H "Accept: application/vnd.github.v3+json" {% data variables.product.api_url_pre %}/app
```
`YOUR_JWT` の値は置き換えてください。
`YOUR_JWT` is the value you must replace.
上記の例では、最大有効期限として 10 分間を設定し、その後は API が `401` エラーを返し始めます。
The example above uses the maximum expiration time of 10 minutes, after which the API will start returning a `401` error:
```json
{
@@ -109,19 +111,19 @@ $ curl -i -H "Authorization: Bearer YOUR_JWT" -H "Accept: application/vnd.github
}
```
有効期限が経過した後は、JWT を新しく作成する必要があります。
You'll need to create a new JWT after the time expires.
## {% data variables.product.prodname_github_app %} として API エンドポイントにアクセスする
## Accessing API endpoints as a {% data variables.product.prodname_github_app %}
{% data variables.product.prodname_github_app %} の概要を取得するために使用できる REST API エンドポイントの一覧については、「[GitHub App](/rest/reference/apps)」を参照してください。
For a list of REST API endpoints you can use to get high-level information about a {% data variables.product.prodname_github_app %}, see "[GitHub Apps](/rest/reference/apps)."
## インストールとして認証を行う
## Authenticating as an installation
インストールとして認証を行うと、そのインストールの API でアクションを実行できます。 インストールとして認証を行う前に、インストールアクセストークンを作成する必要があります。 GitHub Appが少なくとも1つのリポジトリにインストールされていることを確認してください。まったくインストールされていない場合、インストールトークンを作成することは不可能です。 インストールアクセストークンは、認証を行うため {% data variables.product.prodname_github_apps %} により使用されます。 詳しい情報については「[GitHub Appのインストール](/developers/apps/managing-github-apps/installing-github-apps)」を参照してください。
Authenticating as an installation lets you perform actions in the API for that installation. Before authenticating as an installation, you must create an installation access token. Ensure that you have already installed your GitHub App to at least one repository; it is impossible to create an installation token without a single installation. These installation access tokens are used by {% data variables.product.prodname_github_apps %} to authenticate. For more information, see "[Installing GitHub Apps](/developers/apps/managing-github-apps/installing-github-apps)."
デフォルトでは、インストールトークンのスコープは、インストールがアクセスできるすべてのリポジトリにアクセスできるよう設定されています。 `repository_ids` パラメータを使用すると、インストールアクセストークンのスコープを特定のリポジトリに限定できます。 詳細については、[アプリケーション (エンドポイント) に対するアクセストークンの作成](/rest/reference/apps#create-an-installation-access-token-for-an-app)を参照してください。 インストールアクセストークンは {% data variables.product.prodname_github_app %} によって設定された権限を持ち、1 時間後に期限切れになります。
By default, installation access tokens are scoped to all the repositories that an installation can access. You can limit the scope of the installation access token to specific repositories by using the `repository_ids` parameter. See the [Create an installation access token for an app](/rest/reference/apps#create-an-installation-access-token-for-an-app) endpoint for more details. Installation access tokens have the permissions configured by the {% data variables.product.prodname_github_app %} and expire after one hour.
認証されたアプリケーションのインストールを一覧表示するには、[上記で生成した](#jwt-payload) JWT を API リクエストの Authorization ヘッダに含めます。
To list the installations for an authenticated app, include the JWT [generated above](#jwt-payload) in the Authorization header in the API request:
```shell
$ curl -i -X GET \
@@ -130,9 +132,9 @@ $ curl -i -X GET \
{% data variables.product.api_url_pre %}/app/installations
```
レスポンスには、インストールのリストが含まれ、各インストールの `id` がインストールのアクセストークンを作成するために利用できます。 レスポンスのフォーマットに関する詳しい情報については、「[認証されたアプリケーションのインストールの一覧表示](/rest/reference/apps#list-installations-for-the-authenticated-app)」を参照してください。
The response will include a list of installations where each installation's `id` can be used for creating an installation access token. For more information about the response format, see "[List installations for the authenticated app](/rest/reference/apps#list-installations-for-the-authenticated-app)."
インストールアクセストークンを作成するには、[上記で生成した](#jwt-payload) JWT を API リクエストの Authorization ヘッダに含め、`:installation_id` をインストールの `id` に置き換えます。
To create an installation access token, include the JWT [generated above](#jwt-payload) in the Authorization header in the API request and replace `:installation_id` with the installation's `id`:
```shell
$ curl -i -X POST \
@@ -141,9 +143,9 @@ $ curl -i -X POST \
{% data variables.product.api_url_pre %}/app/installations/:installation_id/access_tokens
```
レスポンスには、インストールアクセストークン、有効期限、トークンの権限、およびトークンがアクセスできるリポジトリが含まれます。 レスポンスのフォーマットに関する詳しい情報については、[アプリケーション (エンドポイント) に対するアクセストークンの作成](/rest/reference/apps#create-an-installation-access-token-for-an-app)を参照してください。
The response will include your installation access token, the expiration date, the token's permissions, and the repositories that the token can access. For more information about the response format, see the [Create an installation access token for an app](/rest/reference/apps#create-an-installation-access-token-for-an-app) endpoint.
インストールアクセストークンで認証を行うには、インストールアクセストークンを API リクエストの Authorization ヘッダに含めます。
To authenticate with an installation access token, include it in the Authorization header in the API request:
```shell
$ curl -i \
@@ -152,17 +154,17 @@ $ curl -i \
{% data variables.product.api_url_pre %}/installation/repositories
```
`YOUR_INSTALLATION_ACCESS_TOKEN` の値は置き換えてください。
`YOUR_INSTALLATION_ACCESS_TOKEN` is the value you must replace.
## インストールとして API エンドポイントにアクセスする
## Accessing API endpoints as an installation
インストールアクセストークンを使用して {% data variables.product.prodname_github_apps %} の概要を取得するために利用できる REST API エンドポイントの一覧については、「[利用可能なエンドポイント](/rest/overview/endpoints-available-for-github-apps)」を参照してください。
For a list of REST API endpoints that are available for use by {% data variables.product.prodname_github_apps %} using an installation access token, see "[Available Endpoints](/rest/overview/endpoints-available-for-github-apps)."
インストールに関連するエンドポイントの一覧については、「[インストール](/rest/reference/apps#installations)」を参照してください。
For a list of endpoints related to installations, see "[Installations](/rest/reference/apps#installations)."
## インストールによる HTTP ベースの Git アクセス
## HTTP-based Git access by an installation
リポジトリの `contents` に[権限](/apps/building-github-apps/setting-permissions-for-github-apps/)があるインストールは、インストールアクセストークンを使用して Git へのアクセスを認証できます。 インストールアクセストークンを HTTP パスワードとして使用してください。
Installations with [permissions](/apps/building-github-apps/setting-permissions-for-github-apps/) on `contents` of a repository, can use their installation access tokens to authenticate for Git access. Use the installation access token as the HTTP password:
```shell
git clone https://x-access-token:&lt;token&gt;@github.com/owner/repo.git

View File

@@ -1,9 +1,9 @@
---
title: GitHub App を作成する
title: Creating a GitHub App
intro: '{% data reusables.shortdesc.creating_github_apps %}'
redirect_from:
- /early-access/integrations/creating-an-integration/
- /apps/building-integrations/setting-up-and-registering-github-apps/registering-github-apps/
- /early-access/integrations/creating-an-integration
- /apps/building-integrations/setting-up-and-registering-github-apps/registering-github-apps
- /apps/building-github-apps/creating-a-github-app
- /developers/apps/creating-a-github-app
versions:
@@ -14,13 +14,12 @@ versions:
topics:
- GitHub Apps
---
{% ifversion fpt or ghec %}構成済みの GitHub App を作成できる GitHub App Manifest の使い方については、「[マニフェストから GitHub App を作成する](/apps/building-github-apps/creating-github-apps-from-a-manifest/)」を参照してください。{% endif %}
{% ifversion fpt or ghec %}To learn how to use GitHub App Manifests, which allow people to create preconfigured GitHub Apps, see "[Creating GitHub Apps from a manifest](/apps/building-github-apps/creating-github-apps-from-a-manifest/)."{% endif %}
{% ifversion fpt or ghec %}
{% note %}
**ノート:** {% data reusables.apps.maximum-github-apps-allowed %}
**Note:** {% data reusables.apps.maximum-github-apps-allowed %}
{% endnote %}
{% endif %}
@@ -28,44 +27,57 @@ topics:
{% data reusables.apps.settings-step %}
{% data reusables.user-settings.developer_settings %}
{% data reusables.user-settings.github_apps %}
1. [**New GitHub App**] をクリックします。 ![新しい GitHub App を作成するボタン](/assets/images/github-apps/github_apps_new.png)
1. [GitHub App name] に、アプリケーションの名前を入力します。 ![GitHub App の名前フィールド](/assets/images/github-apps/github_apps_app_name.png)
1. Click **New GitHub App**.
![Button to create a new GitHub App](/assets/images/github-apps/github_apps_new.png)
1. In "GitHub App name", type the name of your app.
![Field for the name of your GitHub App](/assets/images/github-apps/github_apps_app_name.png)
アプリケーションには簡潔で明快な名前を付けましょう。 アプリケーションの名前は、既存の GitHub アカウントと同じ名前にできません。ただし、その名前があなた自身のユーザ名や Organization 名である場合は例外です。 インテグレーションが動作すると、ユーザインターフェース上にアプリケーション名のスラッグが表示されます。
Give your app a clear and succinct name. Your app cannot have the same name as an existing GitHub account, unless it is your own user or organization name. A slugged version of your app's name will be shown in the user interface when your integration takes an action.
1. 必要に応じて、ユーザーに表示されるアプリケーションの説明を [Description] に入力します。 ![GitHub App の説明フィールド](/assets/images/github-apps/github_apps_description.png)
1. [Homepage URL] に、アプリケーションのウェブサイトの完全な URL を入力します。 ![GitHub App のホームページ URL フィールド](/assets/images/github-apps/github_apps_homepage_url.png)
1. Optionally, in "Description", type a description of your app that users will see.
![Field for a description of your GitHub App](/assets/images/github-apps/github_apps_description.png)
1. In "Homepage URL", type the full URL to your app's website.
![Field for the homepage URL of your GitHub App](/assets/images/github-apps/github_apps_homepage_url.png)
{% ifversion fpt or ghes > 3.0 or ghec %}
1. [Callback URL] に、ユーザがインストールを認可した後にリダイレクトされる URL を完全な形で入力します。 この URL は、アプリケーションがユーザからサーバへのリクエストを識別して承認する必要がある場合に使用されます。
1. In "Callback URL", type the full URL to redirect to after a user authorizes the installation. This URL is used if your app needs to identify and authorize user-to-server requests.
[**Add callback URL**] を使用して、コールバック URL を最大 10 個追加できます。
You can use **Add callback URL** to provide additional callback URLs, up to a maximum of 10.
![[Add callback URL] のボタンと コールバック URL のフィールド](/assets/images/github-apps/github_apps_callback_url_multiple.png)
![Button for 'Add callback URL' and field for callback URL](/assets/images/github-apps/github_apps_callback_url_multiple.png)
{% else %}
1. [User authorization callback URL] に、ユーザーがインストールを認可した後にリダイレクトされる URL を完全な形で入力します。 この URL は、アプリケーションがユーザからサーバへのリクエストを識別して承認する必要がある場合に使用されます。 ![GitHub App のユーザ認可コールバック URL フィールド](/assets/images/github-apps/github_apps_user_authorization.png)
1. In "User authorization callback URL", type the full URL to redirect to after a user authorizes an installation. This URL is used if your app needs to identify and authorize user-to-server requests.
![Field for the user authorization callback URL of your GitHub App](/assets/images/github-apps/github_apps_user_authorization.png)
{% endif %}
1. デフォルトでは、アプリケーションのセキュリティを高めるため、アプリケーションは期限付きのユーザ認可トークンを使用します。 期限付きのユーザトークンの使用をオプトアウトするには、[Expire user authorization tokens] の選択を解除する必要があります。 リフレッシュトークンフローの設定と、期限付きユーザトークンの利点に関する詳細については、「[ユーザからサーバーに対するアクセストークンをリフレッシュする](/apps/building-github-apps/refreshing-user-to-server-access-tokens/)」を参照してください。 ![GitHub App のセットアップ中に期限付きユーザトークンをオプトインするオプション](/assets/images/github-apps/expire-user-tokens-selection.png)
1. アプリケーションが OAuth フローを使用してユーザを認可する場合、[**Request user authorization (OAuth) during installation**] を選択して、ユーザーかアプリをインストール時に認可するようにできます。 このオプションを選択した場合、[Setup URL] が利用できなくなり、アプリケーションのインストール後にユーザはあなたが設定した [User authorization callback URL] にリダイレクトされます。 詳しい情報については「[インストール中にユーザを認可する](/apps/installing-github-apps/#authorizing-users-during-installation)」を参照してください。 ![インストール時にユーザの認可を要求する](/assets/images/github-apps/github_apps_request_auth_upon_install.png)
1. インストール後に追加の設定が必要な場合、[Setup URL] を追加して、アプリケーションをインストールした後にユーザをリダイレクトします。 ![GitHub App のセットアップ URL フィールド ](/assets/images/github-apps/github_apps_setup_url.png)
1. By default, to improve your app's security, your app will use expiring user authorization tokens. To opt-out of using expiring user tokens, you must deselect "Expire user authorization tokens". To learn more about setting up a refresh token flow and the benefits of expiring user tokens, see "[Refreshing user-to-server access tokens](/apps/building-github-apps/refreshing-user-to-server-access-tokens/)."
![Option to opt-in to expiring user tokens during GitHub Apps setup](/assets/images/github-apps/expire-user-tokens-selection.png)
1. If your app authorizes users using the OAuth flow, you can select **Request user authorization (OAuth) during installation** to allow people to authorize the app when they install it, saving a step. If you select this option, the "Setup URL" becomes unavailable and users will be redirected to your "User authorization callback URL" after installing the app. See "[Authorizing users during installation](/apps/installing-github-apps/#authorizing-users-during-installation)" for more information.
![Request user authorization during installation](/assets/images/github-apps/github_apps_request_auth_upon_install.png)
1. If additional setup is required after installation, add a "Setup URL" to redirect users to after they install your app.
![Field for the setup URL of your GitHub App ](/assets/images/github-apps/github_apps_setup_url.png)
{% note %}
**注釈:** 前のステップで [**Request user authorization (OAuth) during installation**] を選択した場合、このフィールドは利用できなくなり、アプリケーションのインストール後にユーザは [User authorization callback URL] にリダイレクトされます。
**Note:** When you select **Request user authorization (OAuth) during installation** in the previous step, this field becomes unavailable and people will be redirected to the "User authorization callback URL" after installing the app.
{% endnote %}
1. [Webhook URL] に、イベントが POST する URL を入力します。 各アプリケーションは、アプリケーションがインストールまたは変更されたり、アプリケーションがサブスクライブしているその他のイベントが発生したりするたびに、アプリケーションで設定した webhook を受信します。 ![GitHub App の webhook URL フィールド](/assets/images/github-apps/github_apps_webhook_url.png)
1. In "Webhook URL", type the URL that events will POST to. Each app receives its own webhook which will notify you every time the app is installed or modified, as well as any other events the app subscribes to.
![Field for the webhook URL of your GitHub App](/assets/images/github-apps/github_apps_webhook_url.png)
1. 必要に応じて、webhook を保護するための、オプションのシークレットトークンを [Webhook Secret] に入力します。 ![webhook にシークレットトークンを追加するフィールド](/assets/images/github-apps/github_apps_webhook_secret.png)
1. Optionally, in "Webhook Secret", type an optional secret token used to secure your webhooks.
![Field to add a secret token for your webhook](/assets/images/github-apps/github_apps_webhook_secret.png)
{% note %}
**注釈:** シークレットトークンは、設定することを強くお勧めします。 詳しい情報については「[webhookをセキュアにする](/webhooks/securing/)」を参照してください。
**Note:** We highly recommend that you set a secret token. For more information, see "[Securing your webhooks](/webhooks/securing/)."
{% endnote %}
1. [Permissions] で、アプリケーションが要求する権限を選択します。 権限の各タイプで、ドロップダウンメニューを使用して [**Read-only**]、[**Read & write**]、または[**No access**] をクリックします。 ![GitHub App のさまざまな権限](/assets/images/github-apps/github_apps_new_permissions_post2dot13.png)
1. [Subscribe to events] で、アプリケーションが受け取るイベントを選択します。
1. アプリケーションをインストールする場所を、[**Only on this account**] (このアカウントのみ) と [**Any account**] (すべてのアカウント) から選びます。 これらのオプションに関する詳しい情報については、「[GitHub App をパブリックまたはプライベートにする](/apps/managing-github-apps/making-a-github-app-public-or-private/)」を参照してください。 ![GitHub App のインストールオプション](/assets/images/github-apps/github_apps_installation_options.png)
1. [**Create GitHub App**] をクリックします。 ![GitHub App を作成するボタン](/assets/images/github-apps/github_apps_create_github_app.png)
1. In "Permissions", choose the permissions your app will request. For each type of permission, use the drop-down menu and click **Read-only**, **Read & write**, or **No access**.
![Various permissions for your GitHub App](/assets/images/github-apps/github_apps_new_permissions_post2dot13.png)
1. In "Subscribe to events", choose the events you want your app to receive.
1. To choose where the app can be installed, select either **Only on this account** or **Any account**. For more information on installation options, see "[Making a GitHub App public or private](/apps/managing-github-apps/making-a-github-app-public-or-private/)."
![Installation options for your GitHub App](/assets/images/github-apps/github_apps_installation_options.png)
1. Click **Create GitHub App**.
![Button to create your GitHub App](/assets/images/github-apps/github_apps_create_github_app.png)

View File

@@ -2,8 +2,8 @@
title: Identifying and authorizing users for GitHub Apps
intro: '{% data reusables.shortdesc.identifying_and_authorizing_github_apps %}'
redirect_from:
- /early-access/integrations/user-identification-authorization/
- /apps/building-integrations/setting-up-and-registering-github-apps/identifying-users-for-github-apps/
- /early-access/integrations/user-identification-authorization
- /apps/building-integrations/setting-up-and-registering-github-apps/identifying-users-for-github-apps
- /apps/building-github-apps/identifying-and-authorizing-users-for-github-apps
- /developers/apps/identifying-and-authorizing-users-for-github-apps
versions:

View File

@@ -1,8 +1,8 @@
---
title: GitHub App を構築する
intro: GitHub App を、あなた自身や他の人が使うために構築できます。 GitHub App の登録と、権限および認証オプションの設定方法について学びましょう。
title: Building GitHub Apps
intro: You can build GitHub Apps for yourself or others to use. Learn how to register and set up permissions and authentication options for GitHub Apps.
redirect_from:
- /apps/building-integrations/setting-up-and-registering-github-apps/
- /apps/building-integrations/setting-up-and-registering-github-apps
- /apps/building-github-apps
versions:
fpt: '*'

View File

@@ -1,10 +1,10 @@
---
title: GitHub Appのレート制限
title: Rate limits for GitHub Apps
intro: '{% data reusables.shortdesc.rate_limits_github_apps %}'
redirect_from:
- /early-access/integrations/rate-limits/
- /apps/building-integrations/setting-up-and-registering-github-apps/about-rate-limits-for-github-apps/
- /apps/building-github-apps/rate-limits-for-github-apps/
- /early-access/integrations/rate-limits
- /apps/building-integrations/setting-up-and-registering-github-apps/about-rate-limits-for-github-apps
- /apps/building-github-apps/rate-limits-for-github-apps
- /apps/building-github-apps/understanding-rate-limits-for-github-apps
- /developers/apps/rate-limits-for-github-apps
versions:
@@ -14,16 +14,15 @@ versions:
ghec: '*'
topics:
- GitHub Apps
shortTitle: レート制限
shortTitle: Rate limits
---
## サーバーからサーバーへのリクエスト
## Server-to-server requests
{% ifversion ghec %}
The rate limits for server-to-server requests made by {% data variables.product.prodname_github_apps %} depend on where the app is installed. If the app is installed on organizations or repositories owned by an enterprise on {% data variables.product.product_location %}, then the rate is higher than for installations outside an enterprise.
### 通常のサーバーからサーバーへのレート制限
### Normal server-to-server rate limits
{% endif %}
@@ -31,32 +30,32 @@ The rate limits for server-to-server requests made by {% data variables.product.
{% ifversion ghec %}
### {% data variables.product.prodname_ghe_cloud %}のサーバーからサーバーへのレート制限
### {% data variables.product.prodname_ghe_cloud %} server-to-server rate limits
{% data variables.product.prodname_github_apps %} that are installed on an organization or repository owned by an enterprise on {% data variables.product.product_location %} have a rate limit of 15,000 requests per hour for server-to-server requests.
{% endif %}
## ユーザからサーバーへのリクエスト
## User-to-server requests
{% data variables.product.prodname_github_apps %}[ユーザの代わりに](/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/#identifying-and-authorizing-users-for-github-apps)動作し、ユーザからサーバーへのリクエストを発行することができます。
{% data variables.product.prodname_github_apps %} can also act [on behalf of a user](/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/#identifying-and-authorizing-users-for-github-apps), making user-to-server requests.
{% ifversion ghec %}
The rate limits for user-to-server requests made by {% data variables.product.prodname_github_apps %} depend on where the app is installed. If the app is installed on organizations or repositories owned by an enterprise on {% data variables.product.product_location %}, then the rate is higher than for installations outside an enterprise.
### 通常のユーザからサーバーへのレート制限
### Normal user-to-server rate limits
{% endif %}
User-to-server requests are rate limited at {% ifversion ghae %}15,000{% else %}5,000{% endif %} requests per hour and per authenticated user. ユーザが認可したすべてのOAuthアプリケーション、ユーザが所有する個人アクセストークン、ユーザの{% ifversion ghae %} トークン{% else %} ユーザ名およびパスワード{% endif %} で認証されたリクエストは、ユーザに対する1時間あたり5,000リクエストという割り当てを共有します。
User-to-server requests are rate limited at {% ifversion ghae %}15,000{% else %}5,000{% endif %} requests per hour and per authenticated user. All OAuth applications authorized by that user, personal access tokens owned by that user, and requests authenticated with that user's{% ifversion ghae %} token{% else %} username and password{% endif %} share the same quota of 5,000 requests per hour for that user.
{% ifversion ghec %}
### {% data variables.product.prodname_ghe_cloud %}のユーザからサーバーへのレート制限
### {% data variables.product.prodname_ghe_cloud %} user-to-server rate limits
When a user belongs to an enterprise on {% data variables.product.product_location %}, user-to-server requests to resources owned by the same enterprise are rate limited at 15,000 requests per hour and per authenticated user. All OAuth applications authorized by that user, personal access tokens owned by that user, and requests authenticated with that user's username and password share the same quota of 5,000 requests per hour for that user.
{% endif %}
レート制限に関する詳細な情報については、REST APIについては「[レート制限](/rest/overview/resources-in-the-rest-api#rate-limiting)」を、GraphQL APIについては「[リソース制限]({% ifversion ghec %}/free-pro-team@latest{% endif %}/graphql/overview/resource-limitations)」を参照してください。
For more detailed information about rate limits, see "[Rate limiting](/rest/overview/resources-in-the-rest-api#rate-limiting)" for REST API and "[Resource limitations]({% ifversion ghec %}/free-pro-team@latest{% endif %}/graphql/overview/resource-limitations)" for GraphQL API.

View File

@@ -1,9 +1,9 @@
---
title: GitHub Appの権限の設定
title: Setting permissions for GitHub Apps
intro: '{% data reusables.shortdesc.permissions_github_apps %}'
redirect_from:
- /apps/building-integrations/setting-up-and-registering-github-apps/about-permissions-for-github-apps/
- /apps/building-github-apps/permissions-for-github-apps/
- /apps/building-integrations/setting-up-and-registering-github-apps/about-permissions-for-github-apps
- /apps/building-github-apps/permissions-for-github-apps
- /apps/building-github-apps/setting-permissions-for-github-apps
- /developers/apps/setting-permissions-for-github-apps
versions:
@@ -13,7 +13,6 @@ versions:
ghec: '*'
topics:
- GitHub Apps
shortTitle: 権限の設定
shortTitle: Set permissions
---
GitHub Appは、デフォルトでは何の権限も持っていません。 GitHub Appを作成する際に、そのアプリケーションがエンドユーザのデータにアクセスするために必要な権限を選択できます。 権限は、追加することも削除することもできます。 詳しい情報については「[GitHub Appの権限の編集](/apps/managing-github-apps/editing-a-github-app-s-permissions/)」を参照してください。
GitHub Apps don't have any permissions by default. When you create a GitHub App, you can select the permissions it needs to access end user data. Permissions can also be added and removed. For more information, see "[Editing a GitHub App's permissions](/apps/managing-github-apps/editing-a-github-app-s-permissions/)."

View File

@@ -2,11 +2,11 @@
title: Authorizing OAuth Apps
intro: '{% data reusables.shortdesc.authorizing_oauth_apps %}'
redirect_from:
- /apps/building-integrations/setting-up-and-registering-oauth-apps/about-authorization-options-for-oauth-apps/
- /apps/building-integrations/setting-up-and-registering-oauth-apps/directing-users-to-review-their-access/
- /apps/building-integrations/setting-up-and-registering-oauth-apps/creating-multiple-tokens-for-oauth-apps/
- /v3/oauth/
- /apps/building-oauth-apps/authorization-options-for-oauth-apps/
- /apps/building-integrations/setting-up-and-registering-oauth-apps/about-authorization-options-for-oauth-apps
- /apps/building-integrations/setting-up-and-registering-oauth-apps/directing-users-to-review-their-access
- /apps/building-integrations/setting-up-and-registering-oauth-apps/creating-multiple-tokens-for-oauth-apps
- /v3/oauth
- /apps/building-oauth-apps/authorization-options-for-oauth-apps
- /apps/building-oauth-apps/authorizing-oauth-apps
- /developers/apps/authorizing-oauth-apps
versions:

View File

@@ -1,8 +1,8 @@
---
title: OAuthアプリの作成
title: Creating an OAuth App
intro: '{% data reusables.shortdesc.creating_oauth_apps %}'
redirect_from:
- /apps/building-integrations/setting-up-and-registering-oauth-apps/registering-oauth-apps/
- /apps/building-integrations/setting-up-and-registering-oauth-apps/registering-oauth-apps
- /apps/building-oauth-apps/creating-an-oauth-app
- /developers/apps/creating-an-oauth-app
versions:
@@ -13,11 +13,10 @@ versions:
topics:
- OAuth Apps
---
{% ifversion fpt or ghec %}
{% note %}
**ノート:** {% data reusables.apps.maximum-oauth-apps-allowed %}
**Note:** {% data reusables.apps.maximum-oauth-apps-allowed %}
{% endnote %}
{% endif %}
@@ -25,29 +24,35 @@ topics:
{% data reusables.user-settings.access_settings %}
{% data reusables.user-settings.developer_settings %}
{% data reusables.user-settings.oauth_apps %}
4. [**New OAuth App**] をクリックします。 ![新しい OAuth App を作成するボタン](/assets/images/oauth-apps/oauth_apps_new_app.png)
4. Click **New OAuth App**.
![Button to create a new OAuth app](/assets/images/oauth-apps/oauth_apps_new_app.png)
{% note %}
**注釈:** アプリをまだ作成したことがない場合、このボタンに [**Register a new application**] と表示されます。
**Note:** If you haven't created an app before, this button will say, **Register a new application**.
{% endnote %}
6. [Application name] に、アプリケーションの名前を入力します。 ![アプリケーションの名前フィールド](/assets/images/oauth-apps/oauth_apps_application_name.png)
6. In "Application name", type the name of your app.
![Field for the name of your app](/assets/images/oauth-apps/oauth_apps_application_name.png)
{% warning %}
**警告:** 公にしてよいと思われる OAuth App の情報のみを使用します。 OAuth App を作成する場合、内部 URL などの機密データを使用することは避けてください。
**Warning:** Only use information in your OAuth app that you consider public. Avoid using sensitive data, such as internal URLs, when creating an OAuth App.
{% endwarning %}
7. [Homepage URL] に、アプリケーションのウェブサイトの完全な URL を入力します。 ![アプリケーションのホームページ URL フィールド](/assets/images/oauth-apps/oauth_apps_homepage_url.png)
8. 必要に応じて、ユーザーに表示されるアプリケーションの説明を [Application description] に入力します。 ![アプリケーションの説明フィールド](/assets/images/oauth-apps/oauth_apps_application_description.png)
9. [Authorization callback URL] に、アプリケーションのコールバック URL を入力します。 ![アプリケーションの認可コールバック URL フィールド](/assets/images/oauth-apps/oauth_apps_authorization_callback_url.png)
7. In "Homepage URL", type the full URL to your app's website.
![Field for the homepage URL of your app](/assets/images/oauth-apps/oauth_apps_homepage_url.png)
8. Optionally, in "Application description", type a description of your app that users will see.
![Field for a description of your app](/assets/images/oauth-apps/oauth_apps_application_description.png)
9. In "Authorization callback URL", type the callback URL of your app.
![Field for the authorization callback URL of your app](/assets/images/oauth-apps/oauth_apps_authorization_callback_url.png)
{% ifversion fpt or ghes > 3.0 or ghec %}
{% note %}
**注釈:** {% data variables.product.prodname_github_apps %} と異なり、OAuth App は複数のコールバック URL を持つことはできません。
**Note:** OAuth Apps cannot have multiple callback URLs, unlike {% data variables.product.prodname_github_apps %}.
{% endnote %}
{% endif %}
10. **Register application** をクリックする。 ![アプリケーションを登録するボタン](/assets/images/oauth-apps/oauth_apps_register_application.png)
10. Click **Register application**.
![Button to register an application](/assets/images/oauth-apps/oauth_apps_register_application.png)

View File

@@ -1,8 +1,8 @@
---
title: OAuth App を構築する
intro: OAuth Apps を、あなた自身や他の人が使うために構築できます。 OAuth App の登録と、権限および認可オプションの設定方法について学びましょう。
title: Building OAuth Apps
intro: You can build OAuth Apps for yourself or others to use. Learn how to register and set up permissions and authorization options for OAuth Apps.
redirect_from:
- /apps/building-integrations/setting-up-and-registering-oauth-apps/
- /apps/building-integrations/setting-up-and-registering-oauth-apps
- /apps/building-oauth-apps
versions:
fpt: '*'

View File

@@ -2,8 +2,8 @@
title: Scopes for OAuth Apps
intro: '{% data reusables.shortdesc.understanding_scopes_for_oauth_apps %}'
redirect_from:
- /apps/building-integrations/setting-up-and-registering-oauth-apps/about-scopes-for-oauth-apps/
- /apps/building-oauth-apps/scopes-for-oauth-apps/
- /apps/building-integrations/setting-up-and-registering-oauth-apps/about-scopes-for-oauth-apps
- /apps/building-oauth-apps/scopes-for-oauth-apps
- /apps/building-oauth-apps/understanding-scopes-for-oauth-apps
- /developers/apps/scopes-for-oauth-apps
versions:

View File

@@ -2,9 +2,9 @@
title: About apps
intro: 'You can build integrations with the {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} APIs to add flexibility and reduce friction in your own workflow.{% ifversion fpt or ghec %} You can also share integrations with others on [{% data variables.product.prodname_marketplace %}](https://github.com/marketplace).{% endif %}'
redirect_from:
- /apps/building-integrations/setting-up-a-new-integration/
- /apps/building-integrations/
- /apps/getting-started-with-building-apps/
- /apps/building-integrationssetting-up-a-new-integration
- /apps/building-integrations
- /apps/getting-started-with-building-apps
- /apps/about-apps
- /developers/apps/about-apps
versions:

View File

@@ -2,8 +2,8 @@
title: Differences between GitHub Apps and OAuth Apps
intro: 'Understanding the differences between {% data variables.product.prodname_github_apps %} and {% data variables.product.prodname_oauth_apps %} will help you decide which app you want to create. An {% data variables.product.prodname_oauth_app %} acts as a GitHub user, whereas a {% data variables.product.prodname_github_app %} uses its own identity when installed on an organization or on repositories within an organization.'
redirect_from:
- /early-access/integrations/integrations-vs-oauth-applications/
- /apps/building-integrations/setting-up-a-new-integration/about-choosing-an-integration-type/
- /early-access/integrations/integrations-vs-oauth-applications
- /apps/building-integrations/setting-up-a-new-integration/about-choosing-an-integration-type
- /apps/differences-between-apps
- /developers/apps/differences-between-github-apps-and-oauth-apps
versions:

View File

@@ -2,7 +2,7 @@
title: Using the GitHub API in your app
intro: Learn how to set up your app to listen for events and use the Octokit library to perform REST API operations.
redirect_from:
- /apps/building-your-first-github-app/
- /apps/building-your-first-github-app
- /apps/quickstart-guides/using-the-github-api-in-your-app
- /developers/apps/using-the-github-api-in-your-app
versions:

View File

@@ -1,12 +1,12 @@
---
title: アプリ
intro: 独自のアプリケーションを構築して、ワークフローを自動化および効率化できます。
title: Apps
intro: You can automate and streamline your workflow by building your own apps.
redirect_from:
- /early-access/integrations/
- /early-access/integrations/authentication/
- /early-access/integrations/install-an-integration/
- /apps/adding-integrations/
- /apps/building-integrations/setting-up-a-new-integration/about-integrations/
- /early-access/integrations
- /early-access/integrations/authentication
- /early-access/integrations/install-an-integration
- /apps/adding-integrations
- /apps/building-integrations/setting-up-a-new-integration/about-integrations
- /apps
- /v3/integrations
versions:

View File

@@ -1,8 +1,8 @@
---
title: GitHub App を削除する。
title: Deleting a GitHub App
intro: '{% data reusables.shortdesc.deleting_github_apps %}'
redirect_from:
- /apps/building-integrations/managing-github-apps/deleting-a-github-app/
- /apps/building-integrations/managing-github-apps/deleting-a-github-app
- /apps/managing-github-apps/deleting-a-github-app
- /developers/apps/deleting-a-github-app
versions:
@@ -13,12 +13,15 @@ versions:
topics:
- GitHub Apps
---
{% data reusables.user-settings.access_settings %}
{% data reusables.user-settings.developer_settings %}
{% data reusables.user-settings.github_apps %}
4. 削除する GitHub App を選択します。 ![アプリケーションの選択](/assets/images/github-apps/github_apps_select-app.png)
4. Select the GitHub App you want to delete.
![App selection](/assets/images/github-apps/github_apps_select-app.png)
{% data reusables.user-settings.github_apps_advanced %}
6. [**Delete GitHub App**] をクリックします。 ![GitHub App を削除するボタン](/assets/images/github-apps/github_apps_delete.png)
7. 削除する GitHub App の名前を入力して、削除を確認します。 ![削除する GitHub App の名前を確認するフィールド](/assets/images/github-apps/github_apps_delete_integration_name.png)
8. [**I understand the consequences, delete this GitHub App**] をクリックします。 ![GitHub App の削除を確認するボタン](/assets/images/github-apps/github_apps_confirm_deletion.png)
6. Click **Delete GitHub App**.
![Button to delete a GitHub App](/assets/images/github-apps/github_apps_delete.png)
7. Type the name of the GitHub App to confirm you want to delete it.
![Field to confirm the name of the GitHub App you want to delete](/assets/images/github-apps/github_apps_delete_integration_name.png)
8. Click **I understand the consequences, delete this GitHub App**.
![Button to confirm the deletion of your GitHub App](/assets/images/github-apps/github_apps_confirm_deletion.png)

View File

@@ -1,8 +1,8 @@
---
title: GitHub App の権限を編集する
title: Editing a GitHub App's permissions
intro: '{% data reusables.shortdesc.editing_permissions_for_github_apps %}'
redirect_from:
- /apps/building-integrations/managing-github-apps/editing-a-github-app-s-permissions/
- /apps/building-integrations/managing-github-apps/editing-a-github-app-s-permissions
- /apps/managing-github-apps/editing-a-github-app-s-permissions
- /developers/apps/editing-a-github-apps-permissions
versions:
@@ -12,21 +12,26 @@ versions:
ghec: '*'
topics:
- GitHub Apps
shortTitle: 権限を編集する
shortTitle: Edit permissions
---
{% note %}
**注釈:** アカウントまたは Organization のオーナーが変更を承認するまで、更新した権限はインストールしたアプリケーションに反映されません。 [InstallationEvent webhook](/webhooks/event-payloads/#installation) を使用すると、ユーザがアプリケーションの新しい権限を受け入れた時に確認できます。 ただし[ユーザレベルの権限](/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/#user-level-permissions)は例外で、アカウントの所有者が変更を承認する必要はありません。
**Note:** Updated permissions won't take effect on an installation until the owner of the account or organization approves the changes. You can use the [InstallationEvent webhook](/webhooks/event-payloads/#installation) to find out when people accept new permissions for your app. One exception is [user-level permissions](/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/#user-level-permissions), which don't require the account owner to approve permission changes.
{% endnote %}
{% data reusables.user-settings.access_settings %}
{% data reusables.user-settings.developer_settings %}
{% data reusables.user-settings.github_apps %}
4. 権限を変更する GitHub App を選択します。 ![アプリケーションの選択](/assets/images/github-apps/github_apps_select-app.png)
5. 左サイドバーで、[**Permissions & webhooks**] をクリックします。 ![権限と webhook](/assets/images/github-apps/github_apps_permissions_and_webhooks.png)
6. 変更したい権限を修正します。 権限の各タイプで、ドロップダウンメニューから [Read-only]、[Read & write]、[No access] のいずれかを選択します。 ![GitHub App に対する権限の選択](/assets/images/github-apps/github_apps_permissions_post2dot13.png)
7. [Subscribe to events] で、アプリケーションがサブスクライブするイベントを選択します。 ![GitHub App がイベントにサブスクライブするための権限の選択](/assets/images/github-apps/github_apps_permissions_subscribe_to_events.png)
8. O必要に応じて、[Add a note to users] で注釈を追加し、GitHub App がリクエストする権限を変更する理由をユーザに伝えます。 ![GitHub App の権限を変更した理由をユーザに説明する注釈を追加するための入力ボックス](/assets/images/github-apps/github_apps_permissions_note_to_users.png)
9. [**Save changes**] をクリックします。 ![権限の変更を保存するボタン](/assets/images/github-apps/github_apps_save_changes.png)
4. Select the GitHub App whose permissions you want to change.
![App selection](/assets/images/github-apps/github_apps_select-app.png)
5. In the left sidebar, click **Permissions & webhooks**.
![Permissions and webhooks](/assets/images/github-apps/github_apps_permissions_and_webhooks.png)
6. Modify the permissions you'd like to change. For each type of permission, select either "Read-only", "Read & write", or "No access" from the dropdown.
![Permissions selections for your GitHub App](/assets/images/github-apps/github_apps_permissions_post2dot13.png)
7. In "Subscribe to events", select any events to which you'd like to subscribe your app.
![Permissions selections for subscribing your GitHub App to events](/assets/images/github-apps/github_apps_permissions_subscribe_to_events.png)
8. Optionally, in "Add a note to users", add a note telling your users why you are changing the permissions that your GitHub App requests.
![Input box to add a note to users explaining why your GitHub App permissions have changed](/assets/images/github-apps/github_apps_permissions_note_to_users.png)
9. Click **Save changes**.
![Button to save permissions changes](/assets/images/github-apps/github_apps_save_changes.png)

View File

@@ -1,8 +1,8 @@
---
title: GitHub Appの管理
intro: GitHub Appを作成して登録した後、そのアプリケーションを変更したり、権限を変更したり、所有権を移譲したり、アプリケーションを削除したりできます。
title: Managing GitHub Apps
intro: 'After you create and register a GitHub App, you can make modifications to the app, change permissions, transfer ownership, and delete the app.'
redirect_from:
- /apps/building-integrations/managing-github-apps/
- /apps/building-integrations/managing-github-apps
- /apps/managing-github-apps
versions:
fpt: '*'

View File

@@ -2,10 +2,10 @@
title: Making a GitHub App public or private
intro: '{% data reusables.shortdesc.making-a-github-app-public-or-private %}'
redirect_from:
- /apps/building-integrations/setting-up-and-registering-github-apps/about-installation-options-for-github-apps/
- /apps/building-github-apps/installation-options-for-github-apps/
- /apps/building-integrations/managing-github-apps/changing-a-github-app-s-installation-option/
- /apps/managing-github-apps/changing-a-github-app-s-installation-option/
- /apps/building-integrations/setting-up-and-registering-github-apps/about-installation-options-for-github-apps
- /apps/building-github-apps/installation-options-for-github-apps
- /apps/building-integrations/managing-github-apps/changing-a-github-app-s-installation-option
- /apps/managing-github-apps/changing-a-github-app-s-installation-option
- /apps/managing-github-apps/making-a-github-app-public-or-private
- /developers/apps/making-a-github-app-public-or-private
versions:

View File

@@ -1,8 +1,8 @@
---
title: GitHub Appの変更
title: Modifying a GitHub App
intro: '{% data reusables.shortdesc.modifying_github_apps %}'
redirect_from:
- /apps/building-integrations/managing-github-apps/modifying-a-github-app/
- /apps/building-integrations/managing-github-apps/modifying-a-github-app
- /apps/managing-github-apps/modifying-a-github-app
- /developers/apps/modifying-a-github-app
versions:
@@ -13,10 +13,11 @@ versions:
topics:
- GitHub Apps
---
{% data reusables.user-settings.access_settings %}
{% data reusables.user-settings.developer_settings %}
{% data reusables.user-settings.github_apps %}
{% data reusables.user-settings.modify_github_app %}
5. Basic information基本情報」で、修正したいGitHub Appの情報を変更してください。 ![GitHub Appの基本情報セクション](/assets/images/github-apps/github_apps_basic_information.png)
6. [**Save changes**] をクリックします。 ![GitHub Appの変更保存ボタン](/assets/images/github-apps/github_apps_save_changes.png)
5. In "Basic information", modify the GitHub App information that you'd like to change.
![Basic information section for your GitHub App](/assets/images/github-apps/github_apps_basic_information.png)
6. Click **Save changes**.
![Button to save changes for your GitHub App](/assets/images/github-apps/github_apps_save_changes.png)

View File

@@ -1,8 +1,8 @@
---
title: GitHub Appの所有権を移譲する
title: Transferring ownership of a GitHub App
intro: '{% data reusables.shortdesc.transferring_ownership_of_github_apps %}'
redirect_from:
- /apps/building-integrations/managing-github-apps/transferring-ownership-of-a-github-app/
- /apps/building-integrations/managing-github-apps/transferring-ownership-of-a-github-app
- /apps/managing-github-apps/transferring-ownership-of-a-github-app
- /developers/apps/transferring-ownership-of-a-github-app
versions:
@@ -12,15 +12,19 @@ versions:
ghec: '*'
topics:
- GitHub Apps
shortTitle: 所有権の移譲
shortTitle: Transfer ownership
---
{% data reusables.user-settings.access_settings %}
{% data reusables.user-settings.developer_settings %}
{% data reusables.user-settings.github_apps %}
4. 所有権を移譲するGitHub Appを選択します。 ![アプリケーションの選択](/assets/images/github-apps/github_apps_select-app.png)
4. Select the GitHub App whose ownership you want to transfer.
![App selection](/assets/images/github-apps/github_apps_select-app.png)
{% data reusables.user-settings.github_apps_advanced %}
6. [**Transfer ownership**]をクリックします。 ![所有権を移譲するボタン](/assets/images/github-apps/github_apps_transfer_ownership.png)
7. 移譲するGitHub Appの名前を入力します。 ![移譲するアプリケーションの名前を入力するフィールド](/assets/images/github-apps/github_apps_transfer_app_name.png)
8. GitHub Appの移譲先のユーザまたはOrganizationの名前を入力します。 ![移譲先のユーザまたはOrganizationの名前を入力するフィールド](/assets/images/github-apps/github_apps_transfer_new_owner.png)
9. [**Transfer this GitHub App**]をクリックします。 ![GitHub Appの移譲を確認するボタン](/assets/images/github-apps/github_apps_transfer_integration.png)
6. Click **Transfer ownership**.
![Button to transfer ownership](/assets/images/github-apps/github_apps_transfer_ownership.png)
7. Type the name of the GitHub App you want to transfer.
![Field to enter the name of the app to transfer](/assets/images/github-apps/github_apps_transfer_app_name.png)
8. Type the name of the user or organization you want to transfer the GitHub App to.
![Field to enter the user or org to transfer to](/assets/images/github-apps/github_apps_transfer_new_owner.png)
9. Click **Transfer this GitHub App**.
![Button to confirm the transfer of a GitHub App](/assets/images/github-apps/github_apps_transfer_integration.png)

View File

@@ -1,8 +1,8 @@
---
title: OAuth App を削除する
title: Deleting an OAuth App
intro: '{% data reusables.shortdesc.deleting_oauth_apps %}'
redirect_from:
- /apps/building-integrations/managing-oauth-apps/deleting-an-oauth-app/
- /apps/building-integrations/managing-oauth-apps/deleting-an-oauth-app
- /apps/managing-oauth-apps/deleting-an-oauth-app
- /developers/apps/deleting-an-oauth-app
versions:
@@ -13,10 +13,12 @@ versions:
topics:
- OAuth Apps
---
{% data reusables.user-settings.access_settings %}
{% data reusables.user-settings.developer_settings %}
{% data reusables.user-settings.oauth_apps %}
4. 変更する {% data variables.product.prodname_oauth_app %} を選択します。 ![アプリケーションの選択](/assets/images/oauth-apps/oauth_apps_choose_app_post2dot12.png)
5. [**Delete application**] をクリックします。 ![アプリケーションを削除するボタン](/assets/images/oauth-apps/oauth_apps_delete_application.png)
6. [**Delete this OAuth Application**] をクリックします。 ![削除を確認するボタン](/assets/images/oauth-apps/oauth_apps_delete_confirm.png)
4. Select the {% data variables.product.prodname_oauth_app %} you want to modify.
![App selection](/assets/images/oauth-apps/oauth_apps_choose_app_post2dot12.png)
5. Click **Delete application**.
![Button to delete the application](/assets/images/oauth-apps/oauth_apps_delete_application.png)
6. Click **Delete this OAuth Application**.
![Button to confirm the deletion](/assets/images/oauth-apps/oauth_apps_delete_confirm.png)

View File

@@ -1,8 +1,8 @@
---
title: OAuth Appの管理
intro: OAuth Appを作成して登録した後、そのアプリケーションを変更したり、権限を変更したり、所有権を移譲したり、アプリケーションを削除したりできます。
title: Managing OAuth Apps
intro: 'After you create and register an OAuth App, you can make modifications to the app, change permissions, transfer ownership, and delete the app.'
redirect_from:
- /apps/building-integrations/managing-oauth-apps/
- /apps/building-integrations/managing-oauth-apps
- /apps/managing-oauth-apps
versions:
fpt: '*'

View File

@@ -1,8 +1,8 @@
---
title: OAuth Appの変更
title: Modifying an OAuth App
intro: '{% data reusables.shortdesc.modifying_oauth_apps %}'
redirect_from:
- /apps/building-integrations/managing-oauth-apps/modifying-an-oauth-app/
- /apps/building-integrations/managing-oauth-apps/modifying-an-oauth-app
- /apps/managing-oauth-apps/modifying-an-oauth-app
- /developers/apps/modifying-an-oauth-app
versions:
@@ -13,10 +13,9 @@ versions:
topics:
- OAuth Apps
---
{% data reusables.user-settings.access_settings %}
{% data reusables.user-settings.developer_settings %}
{% data reusables.user-settings.oauth_apps %}
{% data reusables.user-settings.modify_oauth_app %}
1. 修正したい{% data variables.product.prodname_oauth_app %}の情報を変更してください。
1. Modify the {% data variables.product.prodname_oauth_app %} information that you'd like to change.
{% data reusables.user-settings.update_oauth_app %}

View File

@@ -1,8 +1,8 @@
---
title: OAuth App の所有権を移譲する
title: Transferring ownership of an OAuth App
intro: '{% data reusables.shortdesc.transferring_ownership_of_oauth_apps %}'
redirect_from:
- /apps/building-integrations/managing-oauth-apps/transferring-ownership-of-an-oauth-app/
- /apps/building-integrations/managing-oauth-apps/transferring-ownership-of-an-oauth-app
- /apps/managing-oauth-apps/transferring-ownership-of-an-oauth-app
- /developers/apps/transferring-ownership-of-an-oauth-app
versions:
@@ -12,14 +12,18 @@ versions:
ghec: '*'
topics:
- OAuth Apps
shortTitle: 所有権の移譲
shortTitle: Transfer ownership
---
{% data reusables.user-settings.access_settings %}
{% data reusables.user-settings.developer_settings %}
{% data reusables.user-settings.oauth_apps %}
4. 変更する {% data variables.product.prodname_oauth_app %} を選択します。 ![アプリケーションの選択](/assets/images/oauth-apps/oauth_apps_choose_app_post2dot12.png)
5. [**Transfer ownership**]をクリックします。 ![所有権を移譲するボタン](/assets/images/oauth-apps/oauth_apps_transfer_ownership.png)
6. 移譲する {% data variables.product.prodname_oauth_app %} の名前を入力します。 ![移譲するアプリケーションの名前を入力するフィールド](/assets/images/oauth-apps/oauth_apps_transfer_oauth_name.png)
7. {% data variables.product.prodname_oauth_app %} を移譲するユーザまたは Organization の名前を入力します。 ![移譲先のユーザまたはOrganizationの名前を入力するフィールド](/assets/images/oauth-apps/oauth_apps_transfer_new_owner.png)
8. [**Transfer this application**] をクリックします。 ![アプリケーションを移譲するボタン](/assets/images/oauth-apps/oauth_apps_transfer_application.png)
4. Select the {% data variables.product.prodname_oauth_app %} you want to modify.
![App selection](/assets/images/oauth-apps/oauth_apps_choose_app_post2dot12.png)
5. Click **Transfer ownership**.
![Button to transfer ownership](/assets/images/oauth-apps/oauth_apps_transfer_ownership.png)
6. Type the name of the {% data variables.product.prodname_oauth_app %} you want to transfer.
![Field to enter the name of the app to transfer](/assets/images/oauth-apps/oauth_apps_transfer_oauth_name.png)
7. Type the name of the user or organization you want to transfer the {% data variables.product.prodname_oauth_app %} to.
![Field to enter the user or org to transfer to](/assets/images/oauth-apps/oauth_apps_transfer_new_owner.png)
8. Click **Transfer this application**.
![Button to transfer the application](/assets/images/oauth-apps/oauth_apps_transfer_application.png)

View File

@@ -1,8 +1,8 @@
---
title: 認可リクエストエラーのトラブルシューティング
title: Troubleshooting authorization request errors
intro: '{% data reusables.shortdesc.troubleshooting_authorization_request_errors_oauth_apps %}'
redirect_from:
- /apps/building-integrations/managing-oauth-apps/troubleshooting-authorization-request-errors/
- /apps/building-integrations/managing-oauth-apps/troubleshooting-authorization-request-errors
- /apps/managing-oauth-apps/troubleshooting-authorization-request-errors
- /developers/apps/troubleshooting-authorization-request-errors
versions:
@@ -12,38 +12,42 @@ versions:
ghec: '*'
topics:
- GitHub Apps
shortTitle: 認可のトラブルシューティング
shortTitle: Troubleshoot authorization
---
## Application suspended
## アプリケーションのサスペンド
設定した OAuth Appが (不正利用の報告、スパム、APIの誤用により) サスペンドされた場合、GitHubは以下のパラメータを使用して、エラーを手短に説明する、登録されたコールバックURLにリダイレクトします。
If the OAuth App you set up has been suspended (due to reported abuse, spam, or a mis-use of the API), GitHub will redirect to the registered callback URL using the following parameters to summarize the error:
http://your-application.com/callback?error=application_suspended
&error_description=Your+application+has+been+suspended.+Contact+support@github.com.
&error_uri=/apps/building-integrations/setting-up-and-registering-oauth-apps/troubleshooting-authorization-request-errors/%23application-suspended
&state=xyz
サスペンドされたアプリケーションに関する問題を解決するには、{% data variables.contact.contact_support %} までご連絡ください。
To solve issues with suspended applications, please contact {% data variables.contact.contact_support %}.
## リダイレクトURIの不一致
## Redirect URI mismatch
指定した`redirect_uri`がアプリケーションで登録したものと一致しない場合、GitHubは以下のパラメータを使用して、エラーを手短に説明する、登録されたコールバックURLにリダイレクトします。
If you provide a `redirect_uri` that doesn't match what you've registered with your application, GitHub will redirect to the registered callback URL with the following parameters summarizing the error:
http://your-application.com/callback?error=redirect_uri_mismatch
&error_description=The+redirect_uri+MUST+match+the+registered+callback+URL+for+this+application.
&error_uri=/apps/building-integrations/setting-up-and-registering-oauth-apps/troubleshooting-authorization-request-errors/%23redirect-uri-mismatch
&state=xyz
このエラーを修正するには、登録したものと一致する`redirect_uri`を指定するか、アプリケーションで登録されているデフォルトのURIを使用するためパラメータを省略します。
To correct this error, either provide a `redirect_uri` that matches what you registered or leave out this parameter to use the default one registered with your application.
### アクセス拒否
### Access denied
If the ユーザがアプリケーションへのアクセスを拒否している場合、GitHubは以下のパラメータを使用して、エラーを手短に説明する、登録されたコールバックURLにリダイレクトします。
If the user rejects access to your application, GitHub will redirect to
the registered callback URL with the following parameters summarizing
the error:
http://your-application.com/callback?error=access_denied
&error_description=The+user+has+denied+your+application+access.
&error_uri=/apps/building-integrations/setting-up-and-registering-oauth-apps/troubleshooting-authorization-request-errors/%23access-denied
&state=xyz
このような場合、あなたにできることは何もありません。ユーザには、あなたのアプリケーションを使用しない自由があります。 ユーザはウインドウを閉じるかブラウザで戻ることが多いため、このエラーをあなたが見ることはないかもしれません。
There's nothing you can do here as users are free to choose not to use
your application. More often than not, users will just close the window
or press back in their browser, so it is likely that you'll never see
this error.

View File

@@ -1,8 +1,8 @@
---
title: OAuth Appアクセストークンのリクエストエラーのトラブルシューティング
title: Troubleshooting OAuth App access token request errors
intro: '{% data reusables.shortdesc.troubleshooting_access_token_reques_errors_oauth_apps %}'
redirect_from:
- /apps/building-integrations/managing-oauth-apps/troubleshooting-oauth-app-access-token-request-errors/
- /apps/building-integrations/managing-oauth-apps/troubleshooting-oauth-app-access-token-request-errors
- /apps/managing-oauth-apps/troubleshooting-oauth-app-access-token-request-errors
- /developers/apps/troubleshooting-oauth-app-access-token-request-errors
versions:
@@ -12,18 +12,18 @@ versions:
ghec: '*'
topics:
- OAuth Apps
shortTitle: トークンリクエストのトラブルシューティング
shortTitle: Troubleshoot token request
---
{% note %}
**注釈:** この例ではJSONのレスポンスのみ示しています。
**Note:** These examples only show JSON responses.
{% endnote %}
## 不正なクライアント認識情報
## Incorrect client credentials
渡した client\_id client\_secret が正しくない場合は、以下のエラーレスポンスを受け取ります。
If the client\_id and or client\_secret you pass are incorrect you will
receive this error response.
```json
{
@@ -33,11 +33,12 @@ shortTitle: トークンリクエストのトラブルシューティング
}
```
このエラーを解決するには、{% data variables.product.prodname_oauth_app %} の正しい認証情報を持っているかを確認します。 `client_id` `client_secret` が間違っていないか、また {% data variables.product.product_name %} に正しく渡されているかを再確認してください。
To solve this error, make sure you have the correct credentials for your {% data variables.product.prodname_oauth_app %}. Double check the `client_id` and `client_secret` to make sure they are correct and being passed correctly
to {% data variables.product.product_name %}.
## リダイレクトURIの不一致
## Redirect URI mismatch
指定した `redirect_uri` {% data variables.product.prodname_oauth_app %} で登録したものと一致しない場合、次のエラーメッセージが表示されます。
If you provide a `redirect_uri` that doesn't match what you've registered with your {% data variables.product.prodname_oauth_app %}, you'll receive this error message:
```json
{
@@ -47,9 +48,11 @@ shortTitle: トークンリクエストのトラブルシューティング
}
```
このエラーを修正するには、登録したものと一致する`redirect_uri`を指定するか、アプリケーションで登録されているデフォルトのURIを使用するためパラメータを省略します。
To correct this error, either provide a `redirect_uri` that matches what
you registered or leave out this parameter to use the default one
registered with your application.
## 不正な検証コード
## Bad verification code
```json
{
@@ -60,7 +63,9 @@ shortTitle: トークンリクエストのトラブルシューティング
}
```
渡した検証コードが間違っている、有効期限切れ、または最初の認可リクエストで受け取ったものと一致しない場合、このエラーを受信します。
If the verification code you pass is incorrect, expired, or doesn't
match what you received in the first request for authorization you will
receive this error.
```json
{
@@ -70,4 +75,5 @@ shortTitle: トークンリクエストのトラブルシューティング
}
```
この問題を解決するには、[OAuth Appの認可](/apps/building-oauth-apps/authorizing-oauth-apps/)のプロセスを再び開始し、新しいコードを取得します。
To solve this error, start the [OAuth authorization process again](/apps/building-oauth-apps/authorizing-oauth-apps/)
and get a new code.

View File

@@ -1,12 +1,12 @@
---
title: アプリケーションのリストのための要件
intro: '{% data variables.product.prodname_marketplace %}上のアプリケーションは、リストを公開する前にこのページに概要がある要件を満たさなければなりません。'
title: Requirements for listing an app
intro: 'Apps on {% data variables.product.prodname_marketplace %} must meet the requirements outlined on this page before the listing can be published.'
redirect_from:
- /apps/adding-integrations/listing-apps-on-github-marketplace/requirements-for-listing-an-app-on-github-marketplace/
- /apps/marketplace/listing-apps-on-github-marketplace/requirements-for-listing-an-app-on-github-marketplace/
- /apps/marketplace/getting-started-with-github-marketplace-listings/requirements-for-listing-an-app-on-github-marketplace/
- /apps/marketplace/creating-and-submitting-your-app-for-approval/requirements-for-listing-an-app-on-github-marketplace/
- /apps/marketplace/getting-started/requirements-for-listing-an-app-on-github-marketplace/
- /apps/adding-integrations/listing-apps-on-github-marketplace/requirements-for-listing-an-app-on-github-marketplace
- /apps/marketplace/listing-apps-on-github-marketplace/requirements-for-listing-an-app-on-github-marketplace
- /apps/marketplace/getting-started-with-github-marketplace-listings/requirements-for-listing-an-app-on-github-marketplace
- /apps/marketplace/creating-and-submitting-your-app-for-approval/requirements-for-listing-an-app-on-github-marketplace
- /apps/marketplace/getting-started/requirements-for-listing-an-app-on-github-marketplace
- /marketplace/getting-started/requirements-for-listing-an-app-on-github-marketplace
- /developers/github-marketplace/requirements-for-listing-an-app
versions:
@@ -14,68 +14,67 @@ versions:
ghec: '*'
topics:
- Marketplace
shortTitle: リストの要件
shortTitle: Listing requirements
---
<!--UI-LINK: Displayed as a link on the https://github.com/marketplace/new page.-->
{% data variables.product.prodname_marketplace %}上にアプリケーションをリストするための要件は、提供するのが無料なのか有料アプリケーションなのかによって変わります。
The requirements for listing an app on {% data variables.product.prodname_marketplace %} vary according to whether you want to offer a free or a paid app.
## すべての{% data variables.product.prodname_marketplace %}リストの要件
## Requirements for all {% data variables.product.prodname_marketplace %} listings
{% data variables.product.prodname_marketplace %}上のすべてのリストは、{% data variables.product.product_name %}コミュニティに価値を提供するツールのためのものでなければなりません。 公開のためにリストをサブミットする際には、[{% data variables.product.prodname_marketplace %}開発者契約](/free-pro-team@latest/github/site-policy/github-marketplace-developer-agreement)の条項を読んで同意しなければなりません。
All listings on {% data variables.product.prodname_marketplace %} should be for tools that provide value to the {% data variables.product.product_name %} community. When you submit your listing for publication, you must read and accept the terms of the "[{% data variables.product.prodname_marketplace %} Developer Agreement](/free-pro-team@latest/github/site-policy/github-marketplace-developer-agreement)."
### すべてのアプリケーションに対するユーザ体験の要件
### User experience requirements for all apps
すべてのリストは、無料のアプリケーションのためのものか、有料アプリケーションのためのものであるかにかかわらず、以下の要件を満たさなければなりません。
All listings should meet the following requirements, regardless of whether they are for a free or paid app.
- リストはユーザを積極的に{% data variables.product.product_name %}から離れさせようとしてはなりません。
- リストは、パブリッシャーの有効な連絡先の情報を含んでいなければなりません。
- リストには、アプリケーションの適切な説明がなければなりません。
- リストは価格プランを指定しなければなりません。
- アプリケーションは顧客に価値を提供し、認証以外の方法でプラットフォームと統合されていなければなりません
- アプリケーションケーションは{% data variables.product.prodname_marketplace %}で公開されなければならず、ベータや招待のみでの利用であってはなりません。
- アプリケーションは、{% data variables.product.prodname_marketplace %} APIを使ってプランの変更やキャンセルがあったことをパブリッシャーに知らせるために、webhookイベントがセットアップされていなければなりません。 詳しい情報については「[アプリケーションでの{% data variables.product.prodname_marketplace %} APIの利用](/developers/github-marketplace/using-the-github-marketplace-api-in-your-app)」を参照してください。
- Listings must not actively persuade users away from {% data variables.product.product_name %}.
- Listings must include valid contact information for the publisher.
- Listings must have a relevant description of the application.
- Listings must specify a pricing plan.
- Apps must provide value to customers and integrate with the platform in some way beyond authentication.
- Apps must be publicly available in {% data variables.product.prodname_marketplace %} and cannot be in beta or available by invite only.
- Apps must have webhook events set up to notify the publisher of any plan changes or cancellations using the {% data variables.product.prodname_marketplace %} API. For more information, see "[Using the {% data variables.product.prodname_marketplace %} API in your app](/developers/github-marketplace/using-the-github-marketplace-api-in-your-app)."
優れた顧客体験を提供することに関する詳細な情報については、「[アプリケーションの顧客体験のベストプラクティス](/developers/github-marketplace/customer-experience-best-practices-for-apps)」を参照してください。
For more information on providing a good customer experience, see "[Customer experience best practices for apps](/developers/github-marketplace/customer-experience-best-practices-for-apps)."
### すべてのアプリケーションに対するブランドとリストの要件
### Brand and listing requirements for all apps
- GitHubのログを使用するアプリケーションは、{% data variables.product.company_short %}ガイドラインに従わなければなりません。 詳しい情報については「[{% data variables.product.company_short %}ロゴと利用](https://github.com/logos)」を参照してください。
- アプリケーションは、「[{% data variables.product.prodname_marketplace %}リストの説明の作成](/marketplace/listing-on-github-marketplace/writing-github-marketplace-listing-descriptions/)」にある推奨事項を満たすロゴ、機能カード、スクリーンショット画像を持っていなければなりません。
- リストには、十分に書かれた文法上の誤りがない説明が含まれていなければなりません。 リストの作成のガイダンスとしては、「[{% data variables.product.prodname_marketplace %}リストの説明の作成](/marketplace/listing-on-github-marketplace/writing-github-marketplace-listing-descriptions/)」を参照してください。
- Apps that use GitHub logos must follow the {% data variables.product.company_short %} guidelines. For more information, see "[{% data variables.product.company_short %} Logos and Usage](https://github.com/logos)."
- Apps must have a logo, feature card, and screenshots images that meet the recommendations provided in "[Writing {% data variables.product.prodname_marketplace %} listing descriptions](/marketplace/listing-on-github-marketplace/writing-github-marketplace-listing-descriptions/)."
- Listings must include descriptions that are well written and free of grammatical errors. For guidance in writing your listing, see "[Writing {% data variables.product.prodname_marketplace %} listing descriptions](/marketplace/listing-on-github-marketplace/writing-github-marketplace-listing-descriptions/)."
顧客を保護するために、セキュリティのベストプラクティスにも従うことをおすすめします。 詳しい情報については「[アプリケーションのセキュリティのベストプラクティス](/developers/github-marketplace/security-best-practices-for-apps)」を参照してください。
To protect your customers, we recommend that you also follow security best practices. For more information, see "[Security best practices for apps](/developers/github-marketplace/security-best-practices-for-apps)."
## 無料アプリケーションに関する留意点
## Considerations for free apps
{% data reusables.marketplace.free-apps-encouraged %}
{% data reusables.marketplace.free-apps-encouraged %}
## 有料アプリケーションの要件
## Requirements for paid apps
{% data variables.product.prodname_marketplace %}でアプリケーションの有料プランを公開するには、そのアプリケーションが検証済みパブリッシャーであるOrganizationの所有である必要があります。 検証プロセスやアプリケーションの所有権移譲の詳細については、「[Organizationのパブリッシャー検証プロセスを申請する](/developers/github-marketplace/applying-for-publisher-verification-for-your-organization)」を参照してください。
To publish a paid plan for your app on {% data variables.product.prodname_marketplace %}, your app must be owned by an organization that is a verified publisher. For more information about the verification process or transferring ownership of your app, see "[Applying for publisher verification for your organization](/developers/github-marketplace/applying-for-publisher-verification-for-your-organization)."
アプリケーションが既に公開されており、あなたが検証済みパブリッシャーである場合は、価格プランエディタから新しく有料プランを公開できます。 詳しい情報については、「[リストに対する価格プランの設定](/developers/github-marketplace/setting-pricing-plans-for-your-listing)」を参照してください。
If your app is already published and you're a verified publisher, then you can publish a new paid plan from the pricing plan editor. For more information, see "[Setting pricing plans for your listing](/developers/github-marketplace/setting-pricing-plans-for-your-listing)."
有料アプリケーション (または有料プランを提供するアプリケーション) を公開するには、以下の要件も満たす必要があります。
To publish a paid app (or an app that offers a paid plan), you must also meet the following requirements:
- {% data variables.product.prodname_github_apps %}は最低100件のインストールが必要です。
- {% data variables.product.prodname_oauth_apps %}は最低200ユーザが必要です。
- すべての有料アプリケーションは、新規購入、アップグレード、ダウングレード、キャンセル、無料トライアルの{% data variables.product.prodname_marketplace %}購入イベントを処理できなければなりません。 詳しい情報については、以下の「[有料アプリケーションの支払い要件](#billing-requirements-for-paid-apps)」を参照してください。
- {% data variables.product.prodname_github_apps %} should have a minimum of 100 installations.
- {% data variables.product.prodname_oauth_apps %} should have a minimum of 200 users.
- All paid apps must handle {% data variables.product.prodname_marketplace %} purchase events for new purchases, upgrades, downgrades, cancellations, and free trials. For more information, see "[Billing requirements for paid apps](#billing-requirements-for-paid-apps)" below.
アプリケーションを{% data variables.product.prodname_marketplace %}上で公開する準備ができたら、アプリケーション掲載のために検証をリクエストする必要があります。
When you are ready to publish the app on {% data variables.product.prodname_marketplace %} you must request verification for the app listing.
{% note %}
**注釈:** {% data reusables.marketplace.app-transfer-to-org-for-verification %}アプリケーションをOrganizationに移譲する方法については、[公開のためのリストのサブミット](/developers/github-marketplace/submitting-your-listing-for-publication#transferring-an-app-to-an-organization-before-you-submit)」を参照してください。
**Note:** {% data reusables.marketplace.app-transfer-to-org-for-verification %} For information on how to transfer an app to an organization, see: "[Submitting your listing for publication](/developers/github-marketplace/submitting-your-listing-for-publication#transferring-an-app-to-an-organization-before-you-submit)."
{% endnote %}
## 有料アプリケーションの支払い要件
## Billing requirements for paid apps
アプリケーションは支払いを処理する必要はありませんが、{% data variables.product.prodname_marketplace %}購入イベントを使って新規の購入、アップグレード、ダウングレード、キャンセル、無料トライアルを管理できなければなりません。 これらのイベントをアプリケーションに統合する方法については、「[アプリケーションでの{% data variables.product.prodname_marketplace %} APIの利用](/developers/github-marketplace/using-the-github-marketplace-api-in-your-app)」を参照してください。
Your app does not need to handle payments but does need to use {% data variables.product.prodname_marketplace %} purchase events to manage new purchases, upgrades, downgrades, cancellations, and free trials. For information about how integrate these events into your app, see "[Using the {% data variables.product.prodname_marketplace %} API in your app](/developers/github-marketplace/using-the-github-marketplace-api-in-your-app)."
GitHubの支払いAPIを使えば、顧客はGitHubを離れることなくアプリケーションを購入し、自分の{% data variables.product.product_location %}のアカウントにすでに結合されている支払い方法でサービスに対する支払いを行えます。
Using GitHub's billing API allows customers to purchase an app without leaving GitHub and to pay for the service with the payment method already attached to their account on {% data variables.product.product_location %}.
- アプリケーションは、有料のサブスクリプションの購入について、月次及び年次の支払いをサポートしなければなりません。
- リストは、無料及び有料プランの任意の組み合わせを提供できます。 無料プランはオプションですが、推奨されます。 詳しい情報については「[{% data variables.product.prodname_marketplace %}リストの価格プランの設定](/marketplace/listing-on-github-marketplace/setting-a-github-marketplace-listing-s-pricing-plan/)」を参照してください。
- Apps must support both monthly and annual billing for paid subscriptions purchases.
- Listings may offer any combination of free and paid plans. Free plans are optional but encouraged. For more information, see "[Setting a {% data variables.product.prodname_marketplace %} listing's pricing plan](/marketplace/listing-on-github-marketplace/setting-a-github-marketplace-listing-s-pricing-plan/)."

View File

@@ -1,63 +1,63 @@
---
title: アプリケーションのセキュリティベストプラクティス
intro: '{% data variables.product.prodname_marketplace %}上でセキュアなアプリケーションを共有する準備のガイドライン'
title: Security best practices for apps
intro: 'Guidelines for preparing a secure app to share on {% data variables.product.prodname_marketplace %}.'
redirect_from:
- /apps/marketplace/getting-started/security-review-process/
- /apps/marketplace/getting-started/security-review-process
- /marketplace/getting-started/security-review-process
- /developers/github-marketplace/security-review-process-for-submitted-apps
- /developers/github-marketplace/security-best-practices-for-apps
shortTitle: セキュリティベストプラクティス
shortTitle: Security best practice
versions:
fpt: '*'
ghec: '*'
topics:
- Marketplace
---
If you follow these best practices it will help you to provide a secure user experience.
以下のベストプラクティスに従えば、セキュアなユーザ体験を提供するための役に立つでしょう。
## Authorization, authentication, and access control
## 認可、認証、アクセスコントロール
We recommend creating a GitHub App rather than an OAuth App. {% data reusables.marketplace.github_apps_preferred %}. See "[Differences between GitHub Apps and OAuth Apps](/apps/differences-between-apps/)" for more details.
- Apps should use the principle of least privilege and should only request the OAuth scopes and GitHub App permissions that the app needs to perform its intended functionality. For more information, see [Principle of least privilege](https://en.wikipedia.org/wiki/Principle_of_least_privilege) in Wikipedia.
- Apps should provide customers with a way to delete their account, without having to email or call a support person.
- Apps should not share tokens between different implementations of the app. For example, a desktop app should have a separate token from a web-based app. Individual tokens allow each app to request the access needed for GitHub resources separately.
- Design your app with different user roles, depending on the functionality needed by each type of user. For example, a standard user should not have access to admin functionality, and billing managers might not need push access to repository code.
- Apps should not share service accounts such as email or database services to manage your SaaS service.
- All services used in your app should have unique login and password credentials.
- Admin privilege access to the production hosting infrastructure should only be given to engineers and employees with administrative duties.
- Apps should not use personal access tokens to authenticate and should authenticate as an [OAuth App](/apps/about-apps/#about-oauth-apps) or a [GitHub App](/apps/about-apps/#about-github-apps):
- OAuth Apps should authenticate using an [OAuth token](/apps/building-oauth-apps/authorizing-oauth-apps/).
- GitHub Apps should authenticate using either a [JSON Web Token (JWT)](/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app), [OAuth token](/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/), or [installation access token](/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation).
OAuth AppよりもGitHub Appを作成することをおすすめします。 {% data reusables.marketplace.github_apps_preferred %}. 詳細については、「[GitHub AppsとOAuth Appsの違い](/apps/differences-between-apps/)」を参照してください。
- アプリケーションは、最小権限の原則を用い、アプリケーションが意図された機能を実行するために必要なOAuthのスコープとGitHub Appの権限だけをリクエストすべきです。 詳しい情報については、Wikipediaで[最小権限の原則](https://ja.wikipedia.org/wiki/最小権限の原則)を参照してください。
- アプリケーションは、サポート担当者にメールや連絡をすることなく、顧客が自分のアカウントを削除する方法を提供しなければなりません。
- アプリケーションは、異なる実装間でトークンを共有してはなりません。 たとえば、デスクトップのアプリケーションはWebベースのアプリケーションとは別のトークンを持つべきです。 個々のトークンを使うことで、それぞれのアプリケーションはGitHubのリソースに必要なアクセスを個別にリクエストできます。
- ユーザの種類に応じて求められる機能によって、様々なユーザのロールを持たせてアプリケーションを設計してください。 たとえば、標準的なユーザは管理機能を利用できるべきではなく、支払いマネージャーはリポジトリのコードにプッシュアクセスできるべきではありません。
- アプリケーションは、SaaSサービスを管理するためのメールやデータベースサービスのようなサービスアカウントを共有するべきではありません。
- アプリケーションで使用されるすべてのサービスは、固有のログインとパスワードクレデンシャルを持たなければなりません。
- プロダクションのホスティングインフラストラクチャへの管理権限でのアクセスは、管理業務を持つエンジニアや従業員にのみ与えられるべきです。
- アプリケーションは、認証に個人アクセストークンを使うべきではなく、[OAuth App](/apps/about-apps/#about-oauth-apps)あるいは[GitHub App](/apps/about-apps/#about-github-apps)として認証されなければなりません。
- OAuth Appsは、[OAuthトークン](/apps/building-oauth-apps/authorizing-oauth-apps/)を使って認証を受けるべきです。
- GitHub Appは、[JSON Webトークン (JWT)](/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app)、[OAuthトークン](/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/)、[インストールアクセストークン](/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation)のいずれかで認証を受けるべきです。
## Data protection
## データの保護
- Apps should encrypt data transferred over the public internet using HTTPS, with a valid TLS certificate, or SSH for Git.
- Apps should store client ID and client secret keys securely. We recommend storing them as [environmental variables](http://en.wikipedia.org/wiki/Environment_variable#Getting_and_setting_environment_variables).
- Apps should delete all GitHub user data within 30 days of receiving a request from the user, or within 30 days of the end of the user's legal relationship with GitHub.
- Apps should not require the user to provide their GitHub password.
- Apps should encrypt tokens, client IDs, and client secrets.
- アプリケーションは、パブリックなインターネット上で転送されるデータを、有効なTLS証明書を用いたHTTPSもしくはSSH for Gitで暗号化すべきです。
- アプリケーションは、クライアントIDとクライアントシークレットキーをセキュアに保存すべきです。 それらは[環境変数](http://en.wikipedia.org/wiki/Environment_variable#Getting_and_setting_environment_variables)に保存することをおすすめします。
- アプリケーションは、ユーザからの要求を受けてから30日以内、あるいはユーザのGitHubとの法的な関係が終了してから30日以内に、すべてのGitHubユーザデータを削除すべきです。
- アプリケーションは、ユーザにGitHubパスワードの提供を求めるべきではありません。
- アプリケーションは、トークン、クライアントID、クライアントシークレットを暗号化すべきです。
## Logging and monitoring
## ロギング及びモニタリング
Apps should have logging and monitoring capabilities. App logs should be retained for at least 30 days and archived for at least one year.
A security log should include:
アプリケーションは、ロギング及びモニタリングの機能を持つべきです。 アプリケーションのログは最低でも30日間保存され、最低でも1年間アーカイブされるべきです。 セキュリティログは以下を含まなければなりません。
- Authentication and authorization events
- Service configuration changes
- Object reads and writes
- All user and group permission changes
- Elevation of role to admin
- Consistent timestamping for each event
- Source users, IP addresses, and/or hostnames for all logged actions
- 認証及び認可イベント
- サービス設定の変更
- オブジェクトの読み書き
- すべてのユーザ及びグループの権限変更
- ロールの管理者への昇格
- 各イベントに対する一貫したタイムスタンプ
- 記録されたすべてのアクションのソースユーザ、IPアドレス及びホスト名
## Incident response workflow
## インシデントレスポンスのワークフロー
To provide a secure experience for users, you should have a clear incident response plan in place before listing your app. We recommend having a security and operations incident response team in your company rather than using a third-party vendor. You should have the capability to notify {% data variables.product.product_name %} within 24 hours of a confirmed incident.
ユーザのセキュアな体験を提供するためには、アプリケーションをリストする前に明確なインシデントレスポンスプランを用意しておくべきです。 サードパーティのベンダを利用するよりは、自社内にセキュリティ及び運用インシデントレスポンスチームを持つことをおすすめします。 インシデントの確認から24時間以内に{% data variables.product.product_name %}に通知する機能を持っていなければなりません。
For an example of an incident response workflow, see the "Data Breach Response Policy" on the [SANS Institute website](https://www.sans.org/information-security-policy/). A short document with clear steps to take in the event of an incident is more valuable than a lengthy policy template.
インシデントレスポンスのワークフローの例としては、[SANS Institute website](https://www.sans.org/information-security-policy/)の"Data Breach Response Policy"を参照してください。 インシデントが生じた際に取るべき明確なステップを記した短いドキュメントは、長いポリシーテンプレートよりも価値があります。
## Vulnerability management and patching workflow
## 脆弱性管理とパッチ適用ワークフロー
You should conduct regular vulnerability scans of production infrastructure. You should triage the results of vulnerability scans and define a period of time in which you agree to remediate the vulnerability.
プロダクションインフラストラクチャーの定期的な脆弱性スキャンを行わなければなりません。 脆弱性スキャンの結果をトリアージし、脆弱性の修正までの期間を定義して同意しなければなりません。
完全な脆弱性管理のプログラムをセットアップする準備ができていない場合は、パッチ適用のプロセスを作成することから始めると役立ちます。 パッチ管理ポリシーを作成するためのガイダンスとしては、TechRepublicの記事「[Establish a patch management policy](https://www.techrepublic.com/blog/it-security/establish-a-patch-management-policy-87756/)」を参照してください。
If you are not ready to set up a full vulnerability management program, it's useful to start by creating a patching process. For guidance in creating a patch management policy, see this TechRepublic article "[Establish a patch management policy](https://www.techrepublic.com/blog/it-security/establish-a-patch-management-policy-87756/)."

View File

@@ -1,10 +1,10 @@
---
title: リストのメトリクスの参照
intro: '{% data variables.product.prodname_marketplace %} Insightsのページは、{% data variables.product.prodname_github_app %}のメトリクスを表示します。 このメトリクスを使って{% data variables.product.prodname_github_app %}のパフォーマンスを追跡し、価格、プラン、無料トライアル、マーケティングキャンペーンの効果の可視化の方法に関する判断を、より多くの情報に基づいて行えます。'
title: Viewing metrics for your listing
intro: 'The {% data variables.product.prodname_marketplace %} Insights page displays metrics for your {% data variables.product.prodname_github_app %}. You can use the metrics to track your {% data variables.product.prodname_github_app %}''s performance and make more informed decisions about pricing, plans, free trials, and how to visualize the effects of marketing campaigns.'
redirect_from:
- /apps/marketplace/managing-github-marketplace-listings/viewing-performance-metrics-for-a-github-marketplace-listing/
- /apps/marketplace/viewing-performance-metrics-for-a-github-marketplace-listing/
- /apps/marketplace/github-marketplace-insights/
- /apps/marketplace/managing-github-marketplace-listings/viewing-performance-metrics-for-a-github-marketplace-listing
- /apps/marketplace/viewing-performance-metrics-for-a-github-marketplace-listing
- /apps/marketplace/github-marketplace-insights
- /marketplace/github-marketplace-insights
- /developers/github-marketplace/viewing-metrics-for-your-listing
versions:
@@ -12,45 +12,45 @@ versions:
ghec: '*'
topics:
- Marketplace
shortTitle: リストのメトリクスの表示
shortTitle: View listing metrics
---
過去の日24時間、週、月、あるいは{% data variables.product.prodname_github_app %}がリストされた期間全体に対するメトリクスを見ることができます。
You can view metrics for the past day (24 hours), week, month, or for the entire duration of time that your {% data variables.product.prodname_github_app %} has been listed.
{% note %}
**ノート:** データの集計には時間がかかるので、表示される日付には若干の遅れが生じます。 期間を選択すると、ページの上部にそのメトリクスの正確な日付が表示されます。
**Note:** Because it takes time to aggregate data, you'll notice a slight delay in the dates shown. When you select a time period, you can see exact dates for the metrics at the top of the page.
{% endnote %}
## パフォーマンスメトリクス
## Performance metrics
Insightsページには、選択された期間に対する以下のパフォーマンスメトリクスが表示されます。
The Insights page displays these performance metrics, for the selected time period:
* **Subscription value:** サブスクリプションで可能な合計収入(米ドル)。 この値は、プランや無料トライアルがまったくキャンセルされず、すべてのクレジット取引が成功した場合に可能な収入を示します。 subscription valueには、選択された期間内に無料トライアルで始まったプランの全額が、仮にその期間に金銭取引がなかったとしても含まれます。 subscription valueには、選択された期間内にアップグレードされたプランの全額も含まれますが、日割り計算の文は含まれません。 個別の取引を見てダウンロードするには、「[GitHub Marketplaceの取引](/marketplace/github-marketplace-transactions/)」を参照してください。
* **Visitors:** GitHub Appのリスト内のページを見た人数。 この数字には、ログインした訪問者とログアウトした訪問者がどちらも含まれます。
* **Pageviews:** GitHub Appのリスト内のページが受けた閲覧数です。 一人の訪問者が複数のページビューを生成できます。
* **Subscription value:** Total possible revenue (in US dollars) for subscriptions. This value represents the possible revenue if no plans or free trials are cancelled and all credit transactions are successful. The subscription value includes the full value for plans that begin with a free trial in the selected time period, even when there are no financial transactions in that time period. The subscription value also includes the full value of upgraded plans in the selected time period but does not include the prorated amount. To see and download individual transactions, see "[GitHub Marketplace transactions](/marketplace/github-marketplace-transactions/)."
* **Visitors:** Number of people that have viewed a page in your GitHub Apps listing. This number includes both logged in and logged out visitors.
* **Pageviews:** Number of views the pages in your GitHub App's listing received. A single visitor can generate more than one pageview.
{% note %}
**ノート:** 推定されたsubscription valueは、その期間に処理された取引よりもはるかに高くなることがあります。
**Note:** Your estimated subscription value could be much higher than the transactions processed for this period.
{% endnote %}
### コンバージョンパフォーマンス
### Conversion performance
* **Unique visitors to landing page:** GitHub Appのランディングページを閲覧した人数。
* **Unique visitors to checkout page:** GitHub Appのチェックアウトページのいずれかを閲覧した人数。
* **Checkout page to new subscriptions:** 有料サブスクリプション、無料トライアル、無料サブスクリプションの総数。 それぞれの種類のサブスクリプションの特定の数値については「合計サブスクリプションの内訳」を参照してください。
* **Unique visitors to landing page:** Number of people who viewed your GitHub App's landing page.
* **Unique visitors to checkout page:** Number of people who viewed one of your GitHub App's checkout pages.
* **Checkout page to new subscriptions:** Total number of paid subscriptions, free trials, and free subscriptions. See the "Breakdown of total subscriptions" for the specific number of each type of subscription.
![Marketplace insights](/assets/images/marketplace/marketplace_insights.png)
{% data variables.product.prodname_marketplace %} Insightsには以下のようにしてアクセスしてください。
To access {% data variables.product.prodname_marketplace %} Insights:
{% data reusables.user-settings.access_settings %}
{% data reusables.user-settings.developer_settings %}
{% data reusables.user-settings.marketplace_apps %}
4. Insightを表示させる{% data variables.product.prodname_github_app %}を選択します。
4. Select the {% data variables.product.prodname_github_app %} that you'd like to view Insights for.
{% data reusables.user-settings.edit_marketplace_listing %}
6. **Insights**タブをクリックしてください。
7. Insightsページの右上にあるPeriod期間ドロップダウンをクリックして、異なる期間を選択することもできます。 ![Marketplaceの期間](/assets/images/marketplace/marketplace_insights_time_period.png)
6. Click the **Insights** tab.
7. Optionally, select a different time period by clicking the Period dropdown in the upper-right corner of the Insights page.
![Marketplace time period](/assets/images/marketplace/marketplace_insights_time_period.png)

View File

@@ -2,7 +2,7 @@
title: About GitHub Marketplace
intro: 'Learn about {% data variables.product.prodname_marketplace %} where you can share your apps and actions publicly with all {% data variables.product.product_name %} users.'
redirect_from:
- /apps/marketplace/getting-started/
- /apps/marketplace/getting-started
- /marketplace/getting-started
- /developers/github-marketplace/about-github-marketplace
versions:

View File

@@ -1,9 +1,9 @@
---
title: GitHub Marketplace
intro: '{% data variables.product.prodname_dotcom %} Marketplaceで開発者が利用したり購入したりできるように、ツールをリストしてください。'
intro: 'List your tools in {% data variables.product.prodname_dotcom %} Marketplace for developers to use or purchase.'
redirect_from:
- /apps/adding-integrations/listing-apps-on-github-marketplace/about-github-marketplace/
- /apps/marketplace/
- /apps/adding-integrations/listing-apps-on-github-marketplace/about-github-marketplace
- /apps/marketplace
- /marketplace
versions:
fpt: '*'

View File

@@ -1,11 +1,11 @@
---
title: プランの変更を通知するようwebhookを設定する
intro: '[ドラフトの{% data variables.product.prodname_marketplace %}リストを作成](/marketplace/listing-on-github-marketplace/creating-a-draft-github-marketplace-listing/)したあと、顧客のアカウントのプランに変更があった場合に通知するよう、webhookを設定できます。 webhookを設定すると、アプリケーション中で[`marketplace_purchase`イベントタイプを処理](/marketplace/integrating-with-the-github-marketplace-api/github-marketplace-webhook-events/)できるようになります。'
title: Configuring a webhook to notify you of plan changes
intro: 'After [creating a draft {% data variables.product.prodname_marketplace %} listing](/marketplace/listing-on-github-marketplace/creating-a-draft-github-marketplace-listing/), you can configure a webhook that notifies you when changes to customer account plans occur. After you configure the webhook, you can [handle the `marketplace_purchase` event types](/marketplace/integrating-with-the-github-marketplace-api/github-marketplace-webhook-events/) in your app.'
redirect_from:
- /apps/adding-integrations/managing-listings-on-github-marketplace/adding-webhooks-for-a-github-marketplace-listing/
- /apps/marketplace/managing-github-marketplace-listings/adding-webhooks-for-a-github-marketplace-listing/
- /apps/marketplace/setting-up-github-marketplace-webhooks/creating-a-webhook-for-a-github-marketplace-listing/
- /apps/marketplace/listing-on-github-marketplace/configuring-the-github-marketplace-webhook/
- /apps/adding-integrations/managing-listings-on-github-marketplace/adding-webhooks-for-a-github-marketplace-listing
- /apps/marketplace/managing-github-marketplace-listings/adding-webhooks-for-a-github-marketplace-listing
- /apps/marketplace/setting-up-github-marketplace-webhooks/creating-a-webhook-for-a-github-marketplace-listing
- /apps/marketplace/listing-on-github-marketplace/configuring-the-github-marketplace-webhook
- /marketplace/listing-on-github-marketplace/configuring-the-github-marketplace-webhook
- /developers/github-marketplace/configuring-a-webhook-to-notify-you-of-plan-changes
versions:
@@ -13,14 +13,13 @@ versions:
ghec: '*'
topics:
- Marketplace
shortTitle: プラン変更のwebhook
shortTitle: Webhooks for plan changes
---
The {% data variables.product.prodname_marketplace %} event webhook can only be set up from your application's {% data variables.product.prodname_marketplace %} listing page. You can configure all other events from your [application's developer settings page](https://github.com/settings/developers). If you haven't created a {% data variables.product.prodname_marketplace %} listing, read "[Creating a draft {% data variables.product.prodname_marketplace %} listing](/marketplace/listing-on-github-marketplace/creating-a-draft-github-marketplace-listing/)" to learn how.
{% data variables.product.prodname_marketplace %}のイベントwebhookは、アプリケーションの{% data variables.product.prodname_marketplace %}リストページからのみセットアップできます。 他のすべてのイベントは、[アプリケーションの開発者設定ページ](https://github.com/settings/developers)から設定できます。 {% data variables.product.prodname_marketplace %}のリストを作成していない場合は、「[ドラフトの{% data variables.product.prodname_marketplace %}リストの作成](/marketplace/listing-on-github-marketplace/creating-a-draft-github-marketplace-listing/)」を読んで、その方法を学んでください。
## Creating a webhook
## webhookの作成
{% data variables.product.prodname_marketplace %}リストのwebhookを作成するには、[{% data variables.product.prodname_marketplace %}リストページ](https://github.com/marketplace/manage)の左のサイドバーで**Webhook**をクリックしてください。 webhookを設定するのに必要な、以下のwebhookの設定オプションが表示されます。
To create a webhook for your {% data variables.product.prodname_marketplace %} listing, click **Webhook** in the left sidebar of your [{% data variables.product.prodname_marketplace %} listing page](https://github.com/marketplace/manage). You'll see the following webhook configuration options needed to configure your webhook:
### Payload URL
@@ -28,7 +27,7 @@ shortTitle: プラン変更のwebhook
### Content type
{% data reusables.webhooks.content_type %} GitHubは、`application/json`コンテンツタイプの利用をおすすめします。
{% data reusables.webhooks.content_type %} GitHub recommends using the `application/json` content type.
### Secret
@@ -36,10 +35,10 @@ shortTitle: プラン変更のwebhook
### Active
デフォルトでは、webhookの配信は「Active」です。 「Active」の選択を解除すれば、開発の間webhookペイロードの配信を無効にできます。 webhookの配信を無効にした場合、レビューのためにアプリケーションをサブミットする前には「Active」を選択しなければなりません。
By default, webhook deliveries are "Active." You can choose to disable the delivery of webhook payloads during development by deselecting "Active." If you've disabled webhook deliveries, you will need to select "Active" before you submit your app for review.
## webhookの配信の表示
## Viewing webhook deliveries
{% data variables.product.prodname_marketplace %} webhookを設定すると、アプリケーションの[{% data variables.product.prodname_marketplace %}リスト](https://github.com/marketplace/manage)の**Webhook**ページから、`POST`リクエストのペイロードを調べることができるようになります。 GitHubは、失敗した配信の試行を再送信しません。 GitHubが送信したすべてのwebhookのペイロードを、アプリケーションが確実に受信できるようにしてください。
Once you've configured your {% data variables.product.prodname_marketplace %} webhook, you'll be able to inspect `POST` request payloads from the **Webhook** page of your application's [{% data variables.product.prodname_marketplace %} listing](https://github.com/marketplace/manage). GitHub doesn't resend failed delivery attempts. Ensure your app can receive all webhook payloads sent by GitHub.
![最近の{% data variables.product.prodname_marketplace %} webhookの配信の調査](/assets/images/marketplace/marketplace_webhook_deliveries.png)
![Inspect recent {% data variables.product.prodname_marketplace %} webhook deliveries](/assets/images/marketplace/marketplace_webhook_deliveries.png)

View File

@@ -1,16 +1,16 @@
---
title: アプリケーションのリストのドラフト
intro: '{% data variables.product.prodname_marketplace %}のリストを作成すると、GitHubは承認のためにアプリケーションがサブミットされるまで、そのリストをドラフトモードで保存します。 このリストは、顧客に対してアプリケーションがどのように使えるのかを示します。'
title: Drafting a listing for your app
intro: 'When you create a {% data variables.product.prodname_marketplace %} listing, GitHub saves it in draft mode until you submit the app for approval. Your listing shows customers how they can use your app.'
redirect_from:
- /apps/adding-integrations/listing-apps-on-github-marketplace/listing-an-app-on-github-marketplace/
- /apps/marketplace/listing-apps-on-github-marketplace/listing-an-app-on-github-marketplace/
- /apps/marketplace/getting-started-with-github-marketplace-listings/listing-an-app-on-github-marketplace/
- /apps/marketplace/creating-and-submitting-your-app-for-approval/listing-an-app-on-github-marketplace/
- /apps/adding-integrations/managing-listings-on-github-marketplace/removing-a-listing-from-github-marketplace/
- /apps/marketplace/managing-github-marketplace-listings/removing-a-listing-from-github-marketplace/
- /apps/adding-integrations/managing-listings-on-github-marketplace/editing-a-github-marketplace-listing/
- /apps/marketplace/managing-github-marketplace-listings/editing-a-github-marketplace-listing/
- /apps/marketplace/listing-on-github-marketplace/creating-a-draft-github-marketplace-listing/
- /apps/adding-integrations/listing-apps-on-github-marketplace/listing-an-app-on-github-marketplace
- /apps/marketplace/listing-apps-on-github-marketplace/listing-an-app-on-github-marketplace
- /apps/marketplace/getting-started-with-github-marketplace-listings/listing-an-app-on-github-marketplace
- /apps/marketplace/creating-and-submitting-your-app-for-approval/listing-an-app-on-github-marketplace
- /apps/adding-integrations/managing-listings-on-github-marketplace/removing-a-listing-from-github-marketplace
- /apps/marketplace/managing-github-marketplace-listings/removing-a-listing-from-github-marketplace
- /apps/adding-integrations/managing-listings-on-github-marketplace/editing-a-github-marketplace-listing
- /apps/marketplace/managing-github-marketplace-listings/editing-a-github-marketplace-listing
- /apps/marketplace/listing-on-github-marketplace/creating-a-draft-github-marketplace-listing
- /marketplace/listing-on-github-marketplace/creating-a-draft-github-marketplace-listing
- /developers/github-marketplace/drafting-a-listing-for-your-app
versions:
@@ -18,50 +18,51 @@ versions:
ghec: '*'
topics:
- Marketplace
shortTitle: アプリケーションリストのドラフト
shortTitle: Draft an app listing
---
## Create a new draft {% data variables.product.prodname_marketplace %} listing
## 新しいドラフトの{% data variables.product.prodname_marketplace %}リストの作成
You can only create draft listings for apps that are public. Before creating your draft listing, you can read the following guidelines for writing and configuring settings in your {% data variables.product.prodname_marketplace %} listing:
パブリックなアプリケーションについては、ドラフトのリストだけが作成できます。 ドラフトのリストを作成する前に、{% data variables.product.prodname_marketplace %}リストの設定を書いて構成するための以下のガイドラインを読んでください。
* [Writing {% data variables.product.prodname_marketplace %} listing descriptions](/marketplace/listing-on-github-marketplace/writing-github-marketplace-listing-descriptions/)
* [Setting a {% data variables.product.prodname_marketplace %} listing's pricing plan](/marketplace/listing-on-github-marketplace/setting-a-github-marketplace-listing-s-pricing-plan/)
* [Configuring the {% data variables.product.prodname_marketplace %} Webhook](/marketplace/listing-on-github-marketplace/configuring-the-github-marketplace-webhook/)
* [{% data variables.product.prodname_marketplace %}リストの説明を書く](/marketplace/listing-on-github-marketplace/writing-github-marketplace-listing-descriptions/)
* [{% data variables.product.prodname_marketplace %}リストの価格プランの設定](/marketplace/listing-on-github-marketplace/setting-a-github-marketplace-listing-s-pricing-plan/)
* [{% data variables.product.prodname_marketplace %} webhookの設定](/marketplace/listing-on-github-marketplace/configuring-the-github-marketplace-webhook/)
{% data variables.product.prodname_marketplace %}のリストを作成するには、以下のようにします。
To create a {% data variables.product.prodname_marketplace %} listing:
{% data reusables.user-settings.access_settings %}
{% data reusables.user-settings.developer_settings %}
3. 左のサイドバーで、{% data variables.product.prodname_marketplace %}に追加しようとしているアプリケーションに応じて、**OAuth Apps**もしくは**GitHub Apps**をクリックしてください。
3. In the left sidebar, click either **OAuth Apps** or **GitHub Apps** depending on the app you're adding to {% data variables.product.prodname_marketplace %}.
{% note %}
**ノート**: https://github.com/marketplace/new にアクセスし、利用可能なアプリケーションを見て、**Create draft listingドラフトのリストの作成**をクリックしても、リストを追加できます。
**Note**: You can also add a listing by navigating to https://github.com/marketplace/new, viewing your available apps, and clicking **Create draft listing**.
{% endnote %}
![アプリケーションの種類の選択](/assets/images/settings/apps_choose_app.png)
![App type selection](/assets/images/settings/apps_choose_app.png)
4. {% data variables.product.prodname_marketplace %}に追加するアプリケーションを選択します。 ![{% data variables.product.prodname_marketplace %}リストのアプリケーションの選択](/assets/images/github-apps/github_apps_select-app.png)
4. Select the app you'd like to add to {% data variables.product.prodname_marketplace %}.
![App selection for {% data variables.product.prodname_marketplace %} listing](/assets/images/github-apps/github_apps_select-app.png)
{% data reusables.user-settings.edit_marketplace_listing %}
5. 新しいドラフトのリストを作成すると、{% data variables.product.prodname_marketplace %}のリストの完成前にアクセスしておかなければならないセクションの概要が表示されます。 ![GitHub Marketplaceのリスト](/assets/images/marketplace/marketplace_listing_overview.png)
5. Once you've created a new draft listing, you'll see an overview of the sections that you'll need to visit before your {% data variables.product.prodname_marketplace %} listing will be complete.
![GitHub Marketplace listing](/assets/images/marketplace/marketplace_listing_overview.png)
{% note %}
**ノート:** リストの"Contact info(連絡先の情報)"セクションでは、support@domain.comというようなグループメールアドレスよりは、個人のメールアドレスを使うことをおすすめします。 GitHubはこれらのメールアドレスを、リストに影響するかもしれない{% data variables.product.prodname_marketplace %}のアップデート、新機能、マーケティングの機会、支払い、カンファレンスやスポンサーシップに関する情報などに関する連絡に使用します。
**Note:** In the "Contact info" section of your listing, we recommend using individual email addresses, rather than group emails addresses like support@domain.com. GitHub will use these email addresses to contact you about updates to {% data variables.product.prodname_marketplace %} that might affect your listing, new feature releases, marketing opportunities, payouts, and information on conferences and sponsorships.
{% endnote %}
## リストの編集
## Editing your listing
{% data variables.product.prodname_marketplace %}のドラフトリストを作成した後は、いつでもリスト内の情報を変更するために戻ってくることができます。 アプリケーションが検証済みで{% data variables.product.prodname_marketplace %}にあるなら、リスト中の情報や画像を編集することはできますが、公開された既存の価格プランを変更することはできません。 「[{% data variables.product.prodname_marketplace %}リストの価格プランの設定](/marketplace/listing-on-github-marketplace/setting-a-github-marketplace-listing-s-pricing-plan/)」を参照してください。
Once you've created a {% data variables.product.prodname_marketplace %} draft listing, you can come back to modify information in your listing anytime. If your app is already approved and in {% data variables.product.prodname_marketplace %}, you can edit the information and images in your listing, but you will not be able to change existing published pricing plans. See "[Setting a {% data variables.product.prodname_marketplace %} listing's pricing plan](/marketplace/listing-on-github-marketplace/setting-a-github-marketplace-listing-s-pricing-plan/)."
## アプリケーションのサブミット
## Submitting your app
{% data variables.product.prodname_marketplace %}リストが完成したら、**Overview概要**ページからレビューのためにリストをサブミットできます。 「[{% data variables.product.prodname_marketplace %}の開発者契約](/free-pro-team@latest/github/site-policy/github-marketplace-developer-agreement/)」を読んで同意しなければなりません。続いて**Submit for reviewレビューのためにサブミット**をクリックできます。 レビューのためにアプリケーションをサブミットした後、のオンボーディングの専門家から、オンボーディングのプロセスに関する追加情報と併せて連絡が来ます。
Once you've completed your {% data variables.product.prodname_marketplace %} listing, you can submit your listing for review from the **Overview** page. You'll need to read and accept the "[{% data variables.product.prodname_marketplace %} Developer Agreement](/free-pro-team@latest/github/site-policy/github-marketplace-developer-agreement/)," and then you can click **Submit for review**. After you submit your app for review, an onboarding expert will contact you with additional information about the onboarding process.
## {% data variables.product.prodname_marketplace %}リストの削除
## Removing a {% data variables.product.prodname_marketplace %} listing
アプリケーションを{% data variables.product.prodname_marketplace %}のリストに載せたくなくなったなら、リストを削除するために{% data variables.contact.contact_support %}に連絡してください。
If you no longer want to list your app in {% data variables.product.prodname_marketplace %}, contact {% data variables.contact.contact_support %} to remove your listing.

View File

@@ -1,14 +1,14 @@
---
title: GitHub Marketplace上でのアプリケーションのリスト
intro: 'アプリケーションを{% data variables.product.prodname_marketplace %}上でリストする際の要件とベストプラクティスについて学んでください。'
title: Listing an app on GitHub Marketplace
intro: 'Learn about requirements and best practices for listing your app on {% data variables.product.prodname_marketplace %}.'
redirect_from:
- /apps/adding-integrations/listing-apps-on-github-marketplace/
- /apps/marketplace/listing-apps-on-github-marketplace/
- /apps/marketplace/getting-started-with-github-marketplace-listings/
- /apps/marketplace/creating-and-submitting-your-app-for-approval/
- /apps/adding-integrations/managing-listings-on-github-marketplace/
- /apps/marketplace/managing-github-marketplace-listings/
- /apps/marketplace/listing-on-github-marketplace/
- /apps/adding-integrations/listing-apps-on-github-marketplace
- /apps/marketplace/listing-apps-on-github-marketplace
- /apps/marketplace/getting-started-with-github-marketplace-listings
- /apps/marketplace/creating-and-submitting-your-app-for-approval
- /apps/adding-integrations/managing-listings-on-github-marketplace
- /apps/marketplace/managing-github-marketplace-listings
- /apps/marketplace/listing-on-github-marketplace
- /marketplace/listing-on-github-marketplace
versions:
fpt: '*'
@@ -21,6 +21,6 @@ children:
- /setting-pricing-plans-for-your-listing
- /configuring-a-webhook-to-notify-you-of-plan-changes
- /submitting-your-listing-for-publication
shortTitle: Marketplaceへのアプリケーションの掲載
shortTitle: List an app on the Marketplace
---

View File

@@ -1,17 +1,17 @@
---
title: リストに対する価格プランの設定
intro: 'アプリケーションを{% data variables.product.prodname_marketplace %}上でリストする際に、アプリケーションを無料のサービスとして提供するか、アプリケーションを販売するかを選択できます。 アプリケーションを販売することを計画するなら、様々な機能レベルに対して異なる価格プランを作成できます。'
title: Setting pricing plans for your listing
intro: 'When you list your app on {% data variables.product.prodname_marketplace %}, you can choose to provide your app as a free service or sell your app. If you plan to sell your app, you can create different pricing plans for different feature tiers.'
redirect_from:
- /apps/adding-integrations/managing-pricing-and-payments-for-a-github-marketplace-listing/setting-a-github-marketplace-listing-s-pricing-plan/
- /apps/marketplace/managing-pricing-and-payments-for-a-github-marketplace-listing/setting-a-github-marketplace-listing-s-pricing-plan/
- /apps/marketplace/pricing-payments-and-free-trials/setting-a-github-marketplace-listing-s-pricing-plan/
- /apps/adding-integrations/managing-pricing-and-payments-for-a-github-marketplace-listing/about-github-marketplace-pricing-plans/
- /apps/marketplace/managing-pricing-and-payments-for-a-github-marketplace-listing/about-github-marketplace-pricing-plans/
- /apps/marketplace/pricing-payments-and-free-trials/about-github-marketplace-pricing-plans/
- /apps/adding-integrations/managing-pricing-and-payments-for-a-github-marketplace-listing/changing-a-github-marketplace-listing-s-pricing-plan/
- /apps/marketplace/managing-pricing-and-payments-for-a-github-marketplace-listing/changing-a-github-marketplace-listing-s-pricing-plan/
- /apps/marketplace/managing-github-marketplace-listings/changing-a-github-marketplace-listing-s-pricing-plan/
- /apps/marketplace/listing-on-github-marketplace/setting-a-github-marketplace-listing-s-pricing-plan/
- /apps/adding-integrations/managing-pricing-and-payments-for-a-github-marketplace-listing/setting-a-github-marketplace-listing-s-pricing-plan
- /apps/marketplace/managing-pricing-and-payments-for-a-github-marketplace-listing/setting-a-github-marketplace-listing-s-pricing-plan
- /apps/marketplace/pricing-payments-and-free-trials/setting-a-github-marketplace-listing-s-pricing-plan
- /apps/adding-integrations/managing-pricing-and-payments-for-a-github-marketplace-listing/about-github-marketplace-pricing-plans
- /apps/marketplace/managing-pricing-and-payments-for-a-github-marketplace-listing/about-github-marketplace-pricing-plans
- /apps/marketplace/pricing-payments-and-free-trials/about-github-marketplace-pricing-plans
- /apps/adding-integrations/managing-pricing-and-payments-for-a-github-marketplace-listing/changing-a-github-marketplace-listing-s-pricing-plan
- /apps/marketplace/managing-pricing-and-payments-for-a-github-marketplace-listing/changing-a-github-marketplace-listing-s-pricing-plan
- /apps/marketplace/managing-github-marketplace-listings/changing-a-github-marketplace-listing-s-pricing-plan
- /apps/marketplace/listing-on-github-marketplace/setting-a-github-marketplace-listing-s-pricing-plan
- /marketplace/listing-on-github-marketplace/setting-a-github-marketplace-listing-s-pricing-plan
- /developers/github-marketplace/setting-pricing-plans-for-your-listing
versions:
@@ -19,70 +19,69 @@ versions:
ghec: '*'
topics:
- Marketplace
shortTitle: 掲載する価格プランの設定
shortTitle: Set listing pricing plans
---
## About setting pricing plans
## 価格プランの設定について
{% data variables.product.prodname_marketplace %} offers several different types of pricing plans. For detailed information, see "[Pricing plans for {% data variables.product.prodname_marketplace %}](/developers/github-marketplace/pricing-plans-for-github-marketplace-apps)."
{% data variables.product.prodname_marketplace %}では、いくつかの種類の価格プランを提供しています。 詳細にな情報については「[{% data variables.product.prodname_marketplace %}の価格プラン](/developers/github-marketplace/pricing-plans-for-github-marketplace-apps)」を参照してください。
To offer a paid plan for your app, your app must be owned by an organization that has completed the publisher verification process and met certain criteria. For more information, see "[Applying for publisher verification for your organization](/developers/github-marketplace/applying-for-publisher-verification-for-your-organization)" and "[Requirements for listing an app on {% data variables.product.prodname_marketplace %}](/marketplace/getting-started/requirements-for-listing-an-app-on-github-marketplace/)."
アプリケーションで有料プランを提供するには、アプリケーションがパブリッシャー検証プロセスを済ませたOrganizationの所有であり、かつ特定の条件を満たす必要があります。 詳しい情報については、「[Organizationのパブリッシャー検証プロセスを申請する](/developers/github-marketplace/applying-for-publisher-verification-for-your-organization)」および「[{% data variables.product.prodname_marketplace %}アプリケーションを載せるための要件](/marketplace/getting-started/requirements-for-listing-an-app-on-github-marketplace/)」を参照してください。
If your app is already published with a paid plan and you're a verified publisher, then you can publish a new paid plan from the "Edit a pricing plan" page in your Marketplace app listing settings.
アプリケーションが有料プラン付きで既に公開されており、あなたが検証済みパブリッシャーである場合は、Marketplaceアプリケーション掲載設定の [Edit a pricing plan] ページから新しい有料プランを公開できます。
![Publish this plan button](/assets/images/marketplace/publish-this-plan-button.png)
![[Publish this plan] ボタン](/assets/images/marketplace/publish-this-plan-button.png)
If your app is already published with a paid plan and but you are not a verified publisher, then you can cannot publish a new paid plan until you are a verified publisher. For more information about becoming a verified publisher, see "[Applying for publisher verification for your organization](/developers/github-marketplace/applying-for-publisher-verification-for-your-organization)."
アプリケーションが有料プラン付きで既に公開されており、あなたが検証済みパブリッシャーでない場合は、検証済みパブリッシャーになるまで新しい有料プランを公開できません。 検証済みパブリッシャーになる方法の詳細については、「[Organizationのパブリッシャー検証プロセスを申請する](/developers/github-marketplace/applying-for-publisher-verification-for-your-organization)」を参照してください。
## About saving pricing plans
## 価格プランの保存について
You can save pricing plans in a draft or published state. If you haven't submitted your {% data variables.product.prodname_marketplace %} listing for approval, a published plan will function in the same way as a draft plan until your listing is approved and shown on {% data variables.product.prodname_marketplace %}. Draft plans allow you to create and save new pricing plans without making them available on your {% data variables.product.prodname_marketplace %} listing page. Once you publish a pricing plan on a published listing, it's available for customers to purchase immediately. You can publish up to 10 pricing plans.
価格プランは、ドラフトもしくは公開状態で保存できます。 {% data variables.product.prodname_marketplace %}リストを承認のためにサブミットしていないなら、リストが承認されるまでは公開されたプランはドラフトのプランと同じように機能し、{% data variables.product.prodname_marketplace %}上に表示されます。 ドラフトプランを利用すると、新しい価格プランを{% data variables.product.prodname_marketplace %}リストページ上で利用できるようにすることなく作成し、保存できます。 公開リスト上で価格プランを公開すると、顧客はすぐにそれを利用して購入できるようになります。 最大で10の価格プランを公開できます。
For guidelines on billing customers, see "[Billing customers](/developers/github-marketplace/billing-customers)."
顧客への課金のガイドラインについては、「[顧客への課金](/developers/github-marketplace/billing-customers)」を参照してください。
## Creating pricing plans
## 価格プランの作成
To create a pricing plan for your {% data variables.product.prodname_marketplace %} listing, click **Plans and pricing** in the left sidebar of your [{% data variables.product.prodname_marketplace %} listing page](https://github.com/marketplace/manage). For more information, see "[Creating a draft {% data variables.product.prodname_marketplace %} listing](/marketplace/listing-on-github-marketplace/creating-a-draft-github-marketplace-listing/)."
{% data variables.product.prodname_marketplace %}リストの価格プランを作成するには、[{% data variables.product.prodname_marketplace %}リストページ](https://github.com/marketplace/manage)の左のサイドバーで**Plans and pricingプラント価格**をクリックしてください。 詳しい情報については「[ドラフトの{% data variables.product.prodname_marketplace %}リストの作成](/marketplace/listing-on-github-marketplace/creating-a-draft-github-marketplace-listing/)」を参照してください。
When you click **New draft plan**, you'll see a form that allows you to customize your pricing plan. You'll need to configure the following fields to create a pricing plan:
**New draft plan新規ドラフトプラン**をクリックすると、価格プランをカスタマイズできるフォームが表示されます。 価格プランを作成するには、以下のフィールドを設定しなければなりません。
- **Plan name** - Your pricing plan's name will appear on your {% data variables.product.prodname_marketplace %} app's landing page. You can customize the name of your pricing plan to align with the plan's resources, the size of the company that will use the plan, or anything you'd like.
- **Plan nameプラン名** - プラン名は、{% data variables.product.prodname_marketplace %}アプリケーションのランディングページに表示されます。 価格名はカスタマイズして、プランのリソース、そのプランを利用する企業の規模、あるいはその他好きなことにあわせることができます。
- **Pricing models** - There are three types of pricing plan: free, flat-rate, and per-unit. All plans require you to process new purchase and cancellation events from the marketplace API. In addition, for paid plans:
- **Pricing models価格モデル** - 価格モデルには、無料、定額、ユニット単位の3種類があります。 すべてのプランで、Marketplace APIからの新規の購入とキャンセルの処理が必要になります。 加えて、有料プランでは以下が必要です。
- 月単位及び年単位でのサブスクリプションの価格を米ドルで設定しなければなりません。
- アプリケーションはプランの変更イベントを処理しなければなりません。
- 有料プランを持つリストを公開するには、検証をリクエストしなければなりません。
- You must set a price for both monthly and yearly subscriptions in US dollars.
- Your app must process plan change events.
- You must request verification to publish a listing with a paid plan.
- {% data reusables.marketplace.marketplace-pricing-free-trials %}
詳細な情報については、「[{% data variables.product.prodname_marketplace %}アプリケーションの価格プラン](/developers/github-marketplace/pricing-plans-for-github-marketplace-apps)」及び「[アプリケーションでの{% data variables.product.prodname_marketplace %} APIの利用](/developers/github-marketplace/using-the-github-marketplace-api-in-your-app)」を参照してください。
For detailed information, see "[Pricing plans for {% data variables.product.prodname_marketplace %} apps](/developers/github-marketplace/pricing-plans-for-github-marketplace-apps)" and "[Using the {% data variables.product.prodname_marketplace %} API in your app](/developers/github-marketplace/using-the-github-marketplace-api-in-your-app)."
- **Available for(利用対象)** - {% data variables.product.prodname_marketplace %}の価格プランは、**個人及びOrganizationアカウント**、**個人アカウントのみ**、**Organizationアカウントのみ**のいずれかにできます。 たとえば、価格プランがユニット単位であり、複数のシートを提供するなら、個人アカウントからOrganization内の人にシートを割り当てる方法はないので、**Organization accounts onlyOrganizationアカウントのみ**が選択できるでしょう。
- **Available for** - {% data variables.product.prodname_marketplace %} pricing plans can apply to **Personal and organization accounts**, **Personal accounts only**, or **Organization accounts only**. For example, if your pricing plan is per-unit and provides multiple seats, you would select **Organization accounts only** because there is no way to assign seats to people in an organization from a personal account.
- **Short description(簡単な説明)** - 価格プランの詳細の簡単な要約を書いてください。 この説明には、そのプランが意図している顧客の種類や、プランに含まれるリソースなどが含まれることがあります。
- **Short description** - Write a brief summary of the details of the pricing plan. The description might include the type of customer the plan is intended for or the resources the plan includes.
- **Bullets(箇条書き)** - 価格プランに関する詳細を含む箇条書きを、最大で4項目書くことができます。 この箇条書きでは、アプリケーションのユースケースを含めたり、プランに含まれるリソースや機能に関するさらなる詳細をリストしたりすることができます。
- **Bullets** - You can write up to four bullets that include more details about your pricing plan. The bullets might include the use cases of your app or list more detailed information about the resources or features included in the plan.
{% data reusables.marketplace.free-plan-note %}
## {% data variables.product.prodname_marketplace %}リストの価格プランの変更
## Changing a {% data variables.product.prodname_marketplace %} listing's pricing plan
{% data variables.product.prodname_marketplace %}のリストのための価格プランが必要なくなったり、プランの詳細を調整する必要が生じた場合、そのプランを削除できます。
If a pricing plan for your {% data variables.product.prodname_marketplace %} listing is no longer needed, or if you need to adjust pricing details, you can remove it.
![価格プランを削除するボタン](/assets/images/marketplace/marketplace_remove_this_plan.png)
![Button to remove your pricing plan](/assets/images/marketplace/marketplace_remove_this_plan.png)
{% data variables.product.prodname_marketplace %}にリスト済みのアプリケーションの価格プランを公開すると、そのプランは変更できなくなります。 その代わりに、その価格プランを削除して、新しいプランを作成しなければなりません。 削除された価格プランを購入済みの顧客は、オプトアウトして新しい価格プランに移行するまでは、そのプランを使い続けます。 価格プランの詳細については、「[{% data variables.product.prodname_marketplace %}の価格プラン](/marketplace/selling-your-app/github-marketplace-pricing-plans/)」を参照してください。
Once you publish a pricing plan for an app that is already listed in {% data variables.product.prodname_marketplace %}, you can't make changes to the plan. Instead, you'll need to remove the pricing plan and create a new plan. Customers who already purchased the removed pricing plan will continue to use it until they opt out and move onto a new pricing plan. For more on pricing plans, see "[{% data variables.product.prodname_marketplace %} pricing plans](/marketplace/selling-your-app/github-marketplace-pricing-plans/)."
価格プランを削除すると、ユーザはそのプランを使ってアプリケーションを購入することはできなくなります。 削除されたプランの既存ユーザは、プランのサブスクリプションをキャンセルするまではそのプランに留まり続けます。
Once you remove a pricing plan, users won't be able to purchase your app using that plan. Existing users on the removed pricing plan will continue to stay on the plan until they cancel their plan subscription.
{% note %}
**ノート:** {% data variables.product.product_name %}は、削除された価格プランからユーザを削除することはできません。 削除された価格プランから新しい価格プランへ、アップグレードもしくはダウングレードするようユーザに促すキャンペーンを実行できます。
**Note:** {% data variables.product.product_name %} can't remove users from a removed pricing plan. You can run a campaign to encourage users to upgrade or downgrade from the removed pricing plan onto a new pricing plan.
{% endnote %}
価格プランを取り下げることなくGitHub Marketplaceの無料トライアルを無効化することはできますが、そうすると将来的にそのプランの無料トライアルを開始できなくなります。 価格プランに対する無料トライアルを無効にすることにした場合、サインアップ済みのユーザは無料トライアルを最後まで利用できます。
You can disable GitHub Marketplace free trials without retiring the pricing plan, but this prevents you from initiating future free trials for that plan. If you choose to disable free trials for a pricing plan, users already signed up can complete their free trial.
価格プランを終了した後には、削除した価格プランと同じ名前で新しい価格プランを作成できます。 たとえば、「Pro」価格プランがあるものの、定額料金を変更する必要がある場合、その「Pro」価格プランを削除し、更新された価格で新しい「Pro」価格プランを作成できます。 ユーザは、すぐに新しい価格プランで購入できるようになります。
After retiring a pricing plan, you can create a new pricing plan with the same name as the removed pricing plan. For instance, if you have a "Pro" pricing plan but need to change the flat rate price, you can remove the "Pro" pricing plan and create a new "Pro" pricing plan with an updated price. Users will be able to purchase the new pricing plan immediately.
あなたが検証済みパブリッシャーでない場合は、アプリケーションの価格プランを変更できません。 検証済みパブリッシャーになる方法の詳細については、「[Organizationのパブリッシャー検証プロセスを申請する](/developers/github-marketplace/applying-for-publisher-verification-for-your-organization)」を参照してください。
If you are not a verified publisher, then you cannot change a pricing plan for your app. For more information about becoming a verified publisher, see "[Applying for publisher verification for your organization](/developers/github-marketplace/applying-for-publisher-verification-for-your-organization)."

View File

@@ -1,14 +1,14 @@
---
title: アプリケーションのリストの説明を書く
intro: '{% data variables.product.prodname_marketplace %}で[アプリケーションをリスト](/marketplace/listing-on-github-marketplace/) するには、GitHubのガイドラインに従ってアプリケーションの説明を書き、画像を指定する必要があります。'
title: Writing a listing description for your app
intro: 'To [list your app](/marketplace/listing-on-github-marketplace/) in the {% data variables.product.prodname_marketplace %}, you''ll need to write descriptions of your app and provide images that follow GitHub''s guidelines.'
redirect_from:
- /apps/marketplace/getting-started-with-github-marketplace-listings/guidelines-for-writing-github-app-descriptions/
- /apps/marketplace/creating-and-submitting-your-app-for-approval/writing-github-app-descriptions/
- /apps/adding-integrations/listing-apps-on-github-marketplace/guidelines-for-creating-a-github-marketplace-listing/
- /apps/marketplace/listing-apps-on-github/guidelines-for-creating-a-github-marketplace-listing/
- /apps/marketplace/getting-started-with-github-marketplace-listings/guidelines-for-creating-github-marketplace-listing-images/
- /apps/marketplace/creating-and-submitting-your-app-for-approval/creating-github-marketplace-listing-images/
- /apps/marketplace/listing-on-github-marketplace/writing-github-marketplace-listing-descriptions/
- /apps/marketplace/getting-started-with-github-marketplace-listings/guidelines-for-writing-github-app-descriptions
- /apps/marketplace/creating-and-submitting-your-app-for-approval/writing-github-app-descriptions
- /apps/adding-integrations/listing-apps-on-github-marketplace/guidelines-for-creating-a-github-marketplace-listing
- /apps/marketplace/listing-apps-on-github/guidelines-for-creating-a-github-marketplace-listing
- /apps/marketplace/getting-started-with-github-marketplace-listings/guidelines-for-creating-github-marketplace-listing-images
- /apps/marketplace/creating-and-submitting-your-app-for-approval/creating-github-marketplace-listing-images
- /apps/marketplace/listing-on-github-marketplace/writing-github-marketplace-listing-descriptions
- /marketplace/listing-on-github-marketplace/writing-github-marketplace-listing-descriptions
- /developers/github-marketplace/writing-a-listing-description-for-your-app
versions:
@@ -16,183 +16,181 @@ versions:
ghec: '*'
topics:
- Marketplace
shortTitle: リストの説明を書く
shortTitle: Write listing descriptions
---
Here are guidelines about the fields you'll need to fill out in the **Listing description** section of your draft listing.
ドラフトリストの [**リストの説明**] セクションに入力する必要があるフィールドについてのガイドラインは以下のとおりです。
## Naming and links
## 名前のリンク
### Listing name
### リスト名
Your listing's name will appear on the [{% data variables.product.prodname_marketplace %} homepage](https://github.com/marketplace). The name is limited to 255 characters and can be different from your app's name. Your listing cannot have the same name as an existing account on {% data variables.product.product_location %}, unless the name is your own user or organization name.
リストの名前は、 [{% data variables.product.prodname_marketplace %}ホームページ](https://github.com/marketplace)に表示されます。 名前は255文字を上限とし、アプリケーションの名前と異なっていても構いません。 リストの名前は、{% data variables.product.product_location %}上の既存アカウントと同じ名前にできません。ただし、その名前があなた自身のユーザ名やOrganization名である場合は例外です。
### Very short description
### ごく簡単な説明
The community will see the "very short" description under your app's name on the [{% data variables.product.prodname_marketplace %} homepage](https://github.com/marketplace).
コミュニティには、[{% data variables.product.prodname_marketplace %}ホームページ](https://github.com/marketplace)のアプリケーション名の下に「ごく短い」説明が表示されます。
![{% data variables.product.prodname_marketplace %} app short description](/assets/images/marketplace/marketplace_short_description.png)
![{% data variables.product.prodname_marketplace %}アプリケーションの短い説明](/assets/images/marketplace/marketplace_short_description.png)
#### Length
#### 長さ
We recommend keeping short descriptions to 40-80 characters. Although you are allowed to use more characters, concise descriptions are easier for customers to read and understand quickly.
簡単な説明は、4080文字にとどめることをお勧めします。 それ以上の文字数を使うこともできますが、説明は簡潔なほうが顧客に読みやすく、わかりやすくなります。
#### Content
#### 内容
- Describe the apps functionality. Don't use this space for a call to action. For example:
- アプリケーションの機能を説明します。 このスペースを操作の指示には使用しないでください。 例:
**DO:** Lightweight project management for GitHub issues
**良い例:** GitHub Issueの軽量なプロジェクト管理
**DON'T:** Manage your projects and issues on GitHub
**悪い例:** GitHubでプロジェクトとIssueを管理してください
**Tip:** Add an "s" to the end of the verb in a call to action to turn it into an acceptable description: _Manages your projects and issues on GitHub_
**ヒント:** 「~してください」ではなく「~します」と書けば、一応、説明として許容されます。例: _GitHubでプロジェクトとIssueを管理します_
- Dont repeat the apps name in the description.
- 説明でアプリケーション名は繰り返さないようにします。
**DO:** A container-native continuous integration tool
**良い例:** コンテナ対応の継続的インテグレーションツール
**DON'T:** Skycap is a container-native continuous integration tool
**悪い例:** Skycapは、コンテナ対応の継続的インテグレーションツールです
#### Formatting
#### フォーマット
- Always use sentence-case capitalization. Only capitalize the first letter and proper nouns.
- 英文字表記は固有名詞に使用し、大文字小文字は常に正しく使ってください。 大文字で始めて英文字表記するのは固有名詞だけです。
- Don't use punctuation at the end of your short description. Short descriptions should not include complete sentences, and definitely should not include more than one sentence.
- 短い説明の終わりには句読点を付けません。 完全文では書かないようにし、複数文は絶対に避けてください。
- Only capitalize proper nouns. For example:
- 大文字で始めて英文字表記するのは固有名詞だけです。 例:
**DO:** One-click delivery automation for web developers
**良い例:** Web開発者向けのワンクリック配信の自動化
**DON'T:** One-click delivery automation for Web Developers
**悪い例:** Web Developer用のワンクリック配信の自動化
- Always use a [serial comma](https://en.wikipedia.org/wiki/Serial_comma) in lists.
- 3つ以上の項目を並べるとき、[最後の「および」の前には読点](https://en.wikipedia.org/wiki/Serial_comma)を打ちます。
- Avoid referring to the GitHub community as "users."
- GitHubコミュニティを「ユーザー」と称するのは避けてください。
**DO:** Create issues automatically for people in your organization
**良い例:** Organizationの人に自動的にIssueを作成する
**DON'T:** Create issues automatically for an organization's users
**悪い例:** 組織のユーザーについて自動的にIssueを作成する
- Avoid acronyms unless theyre well established (such as API). For example:
- 略語は一般的な場合 (APIなど) を除いて使用しないでください。 例:
**DO:** Agile task boards, estimates, and reports without leaving GitHub
**良い例:** GitHubから移動しないアジャイルタスクボード、推定、およびレポート
**DON'T:** Agile task boards, estimates, and reports without leaving GitHubs UI
**悪い例'T:** GitHub UIから移動しないアジャイルタスクボード、推定、およびレポート
### Categories
### カテゴリ
Apps in {% data variables.product.prodname_marketplace %} can be displayed by category. Select the category that best describes the main functionality of your app in the **Primary category** dropdown, and optionally select a **Secondary category** that fits your app.
{% data variables.product.prodname_marketplace %}のアプリケーションはカテゴリ別に表示できます。 アプリケーションの主な機能を端的に表すカテゴリを [**Primary category**] ドロップダウンで選択し、オプションでstrong x-id="1">アプリケーションに適した [**Secondary category**] を選択します。
### Supported languages
### サポートされている言語
If your app only works with specific languages, select up to 10 programming languages that your app supports. These languages are displayed on your app's {% data variables.product.prodname_marketplace %} listing page. This field is optional.
アプリケーションが特定の言語でのみ動作する場合は、アプリケーションがサポートしている言語を最大10まで選択します。 選択した言語はアプリケーションの{% data variables.product.prodname_marketplace %}リストページに表示されます。 このフィールドはオプションです。
### Listing URLs
### URLのリスト
**Required URLs**
* **Customer support URL:** The URL of a web page that your customers will go to when they have technical support, product, or account inquiries.
* **Privacy policy URL:** The web page that displays your app's privacy policy.
* **Installation URL:** This field is shown for OAuth Apps only. (GitHub Apps don't use this URL because they use the optional Setup URL from the GitHub App's settings page instead.) When a customer purchases your OAuth App, GitHub will redirect customers to the installation URL after they install the app. You will need to redirect customers to `https://github.com/login/oauth/authorize` to begin the OAuth authorization flow. See "[New purchases for OAuth Apps](/marketplace/integrating-with-the-github-marketplace-api/handling-new-purchases-and-free-trials/)" for more details. Skip this field if you're listing a GitHub App.
**必須のURL**
* **カスタマーサポートのURL:** 顧客がテクニカルサポート、製品、またはアカウントについて問い合わせるためにアクセスするWebページのURL。
* **プライバシーポリシーのURL:** アプリケーションのプライバシーポリシーが表示されるWebページ。
* **インストールURL:** このフィールドが表示されるのはOAuthアプリケーションの場合のみです。 (GitHub AppはこのURLを使用しません。かわりに、GitHub Appの設定ページからオプションの設定URLを使用するからです。) 顧客がOAuth Appを購入する際、アプリケーションのインストール後にGitHubは顧客をインストールURLにリダイレクトします。 OAuth認証フローを始めるには、顧客を`https://github.com/login/oauth/authorize`にリダイレクトする必要があります。 詳細については、「[OAuthアプリケーションの新規購入](/marketplace/integrating-with-the-github-marketplace-api/handling-new-purchases-and-free-trials/)」を参照してください。 GitHub Appをリストする場合、このフィールドはスキップしてください。
**Optional URLs**
* **Company URL:** A link to your company's website.
* **Status URL:** A link to a web page that displays the status of your app. Status pages can include current and historical incident reports, web application uptime status, and scheduled maintenance.
* **Documentation URL:** A link to documentation that teaches customers how to use your app.
**オプションのURL**
* **企業URL:** 会社のWebサイトへのリンク。
* **ステータスURL:** アプリケーションのステータスを表示するWebページへのリンク。 ステータスページには、現在および履歴のインシデントレポート、Webアプリケーションの稼働時間ステータス、およびメンテナンスのスケジュールが記載されます。
* **ドキュメントのURL:** 顧客にアプリケーションの使用方法を説明するドキュメントへのリンク。
## Logo and feature card
## ロゴと機能カード
{% data variables.product.prodname_marketplace %} displays all listings with a square logo image inside a circular badge to visually distinguish apps.
{% data variables.product.prodname_marketplace %}には、アプリケーションを視覚的に区別するために、円形のバッジの中に四角いロゴ画像の付いたリストが表示されます。
![GitHub Marketplace logo and badge images](/assets/images/marketplace/marketplace-logo-and-badge.png)
![GitHub Marketplaceのロゴおよびバッジ画像](/assets/images/marketplace/marketplace-logo-and-badge.png)
A feature card consists of your app's logo, name, and a custom background image that captures your brand personality. {% data variables.product.prodname_marketplace %} displays this card if your app is one of the four randomly featured apps at the top of the [homepage](https://github.com/marketplace). Each app's very short description is displayed below its feature card.
機能カードは、アプリケーションのロゴ、名前、およびブランドの個性を捉えた顧客の背景画像で構成されます。 アプリケーションが、ランダムに選択されて[ホームページ](https://github.com/marketplace)の上部に表示されているアプリケーションの1つである場合、{% data variables.product.prodname_marketplace %}には、このカードが表示されます。 各アプリケーションのごく短い説明が、機能カードの下に表示されます。
![Feature card](/assets/images/marketplace/marketplace_feature_card.png)
![機能カード](/assets/images/marketplace/marketplace_feature_card.png)
As you upload images and select colors, your {% data variables.product.prodname_marketplace %} draft listing will display a preview of your logo and feature card.
画像をアップロードして色を選択すると、{% data variables.product.prodname_marketplace %}のドラフトリストに、ロゴと機能カードのプレビューが表示されます。
#### Guidelines for logos
#### ロゴのガイドライン
You must upload a custom image for the logo. For the badge, choose a background color.
ロゴ用として、カスタム画像をアップロードする必要があります。 バッジには、背景色を選択します。
- Upload a logo image that is at least 200 pixels x 200 pixels so your logo won't have to be upscaled when your listing is published.
- Logos will be cropped to a square. We recommend uploading a square image file with your logo in the center.
- For best results, upload a logo image with a transparent background.
- To give the appearance of a seamless badge, choose a badge background color that matches the background color (or transparency) of your logo image.
- Avoid using logo images with words or text in them. Logos with text do not scale well on small screens.
- リストを公開するときにアップスケールしなくて済むように、アップロードするロゴ画像は200×200ピクセル以上にしてください。
- ロゴは正方形にトリミングされます。 ロゴが中央にある正方形の画像ファイルをアップロードすることをお勧めします。
- 最適な結果を得るには、透明な背景のロゴ画像をアップロードしてください。
- 継ぎ目がないようにバッジを表示するには、ロゴ画像の背景色 (または透明) と一致する色をバッジの背景として選択します。
- 単語や文章が含まれるロゴ画像の使用は避けてください。 文字が含まれる画像は、小さい画面で適切に縮小されません。
#### Guidelines for feature cards
#### 機能カードのガイドライン
You must upload a custom background image for the feature card. For the app's name, choose a text color.
機能カード用として、カスタム背景画像をアップロードする必要があります。 アプリケーションの名前には、文字色を選択します。
- Use a pattern or texture in your background image to give your card a visual identity and help it stand out against the dark background of the {% data variables.product.prodname_marketplace %} homepage. Feature cards should capture your app's brand personality.
- Background image measures 965 pixels x 482 pixels (width x height).
- Choose a text color for your app's name that shows up clearly over the background image.
- カードを視覚的に区別しやすいように、また{% data variables.product.prodname_marketplace %}ホームページの暗い背景に対して目立つように、背景画像にはパターンまたはテクスチャを使用します。 機能カードには、アプリケーションのブランドの個性を取得する必要があります。
- 背景画像の大きさは、幅965ピクセル x 高さ482ピクセルです。
- アプリケーション名の文字色には、背景画像に対してはっきり見える色を選択してください。
## Listing details
## リストの詳細
To get to your app's landing page, click your app's name from the {% data variables.product.prodname_marketplace %} homepage or category page. The landing page displays a longer description of the app, which includes two parts: an "Introductory description" and a "Detailed description."
アプリケーションのランディングページにアクセスするには、{% data variables.product.prodname_marketplace %}ホームページまたはカテゴリページからアプリケーションの名前をクリックします。 ランディングページページには、アプリケーションの長い説明が表示されます。説明は「概要説明」と「詳細説明」の2部で構成されています。
Your "Introductory description" is displayed at the top of your app's {% data variables.product.prodname_marketplace %} landing page.
「概要説明」は、アプリケーションの{% data variables.product.prodname_marketplace %}ランディングページの上部に表示されます。
![{% data variables.product.prodname_marketplace %} introductory description](/assets/images/marketplace/marketplace_intro_description.png)
![{% data variables.product.prodname_marketplace %}の概要説明](/assets/images/marketplace/marketplace_intro_description.png)
Clicking **Read more...**, displays the "Detailed description."
[**Read more...**] をクリックすると、「詳細説明」が表示されます。
![{% data variables.product.prodname_marketplace %} detailed description](/assets/images/marketplace/marketplace_detailed_description.png)
![{% data variables.product.prodname_marketplace %}の詳細説明](/assets/images/marketplace/marketplace_detailed_description.png)
Follow these guidelines for writing these descriptions.
説明の記述は、以下のガイドラインに従ってください。
### Length
### 長さ
We recommend writing a 1-2 sentence high-level summary between 150-250 characters in the required "Introductory description" field when [listing your app](/marketplace/listing-on-github-marketplace/). Although you are allowed to use more characters, concise summaries are easier for customers to read and understand quickly.
[アプリケーションをリストする](/marketplace/listing-on-github-marketplace/)ときの必須の「概要説明」フィールドに、150250文字の長さで1、2文くらいの概要を記述してください。 それ以上の文字数を使うこともできますが、概要は簡潔なほうが顧客に読みやすく、わかりやすくなります。
You can add more information in the optional "Detailed description" field. You see this description when you click **Read more...** below the introductory description on your app's landing page. A detailed description consists of 3-5 [value propositions](https://en.wikipedia.org/wiki/Value_proposition), with 1-2 sentences describing each one. You can use up to 1,000 characters for this description.
オプションの「詳細説明」フィールドに情報を追加することもできます。 アプリケーションのランディングページで概要説明の下にある [**Read more...**] をクリックすると、この説明が表示されます。 詳細説明は35個の[バリュープロポジション](https://en.wikipedia.org/wiki/Value_proposition)で構成され、それぞれが1、2文の説明です。 この説明には、最大1,000文字まで使用できます。
### Content
### 内容
- Always begin introductory descriptions with your app's name.
- 概要説明は、必ずアプリケーション名から始めます。
- Always write descriptions and value propositions using the active voice.
- 説明とバリュープロポジションは、必ず能動態で書きます。
### Formatting
### フォーマット
- Always use sentence-case capitalization in value proposition titles. Only capitalize the first letter and proper nouns.
- バリュープロポジションでは、英文字表記は固有名詞に使用し、大文字小文字は常に正しく使ってください。 大文字で始めて英文字表記するのは固有名詞だけです。
- Use periods in your descriptions. Avoid exclamation marks.
- 説明では句点を使用します。 感嘆符は避けてください。
- Don't use punctuation at the end of your value proposition titles. Value proposition titles should not include complete sentences, and should not include more than one sentence.
- バリュープロポジションのタイトルの終わりには句読点を付けません。 バリュープロポジションのタイトルを完全文では書かないようにし、複数文は避けてください。
- For each value proposition, include a title followed by a paragraph of description. Format the title as a [level-three header](/articles/basic-writing-and-formatting-syntax/#headings) using Markdown. For example:
- 各バリュープロポジションには、タイトルとそれに続く説明があります。 タイトルは、Markdownを使用して[レベル3ヘッダ](/articles/basic-writing-and-formatting-syntax/#headings)としてフォーマットします。 例:
### Learn the skills you need
GitHub Learning Lab can help you learn how to use GitHub, communicate more effectively with Markdown, handle merge conflicts, and more.
### 必要なスキルを学ぶ
- Only capitalize proper nouns.
GitHub Learning Labでは、GitHubの使い方を学習、Markdownによる効果的な連絡、マージコンフリクトの処理などが可能です。
- Always use the [serial comma](https://en.wikipedia.org/wiki/Serial_comma) in lists.
- 大文字で始めて英文字表記するのは固有名詞だけです。
- Avoid referring to the GitHub community as "users."
- 3つ以上の項目を並べるとき、[最後の「および」の前には読点](https://en.wikipedia.org/wiki/Serial_comma)を打ちます。
**DO:** Create issues automatically for people in your organization
- GitHubコミュニティを「ユーザー」と称するのは避けてください。
**DON'T:** Create issues automatically for an organization's users
**良い例:** Organizationの人に自動的にIssueを作成する
- Avoid acronyms unless theyre well established (such as API).
**悪い例:** 組織のユーザーについて自動的にIssueを作成する
## Product screenshots
- 略語は一般的な場合 (APIなど) を除いて使用しないでください。
You can upload up to five screenshot images of your app to display on your app's landing page. Add an optional caption to each screenshot to provide context. After you upload your screenshots, you can drag them into the order you want them to be displayed on the landing page.
## 製品のスクリーンショット
### Guidelines for screenshots
アプリケーションのランディングページで表示されるように、アプリケーションのスクリーンショット画像を5つまでアップロードできます。 スクリーンショットごとに状況がわかるキャプションをオプションとして追加します。 スクリーンショットをアップロードすると、ランディングページに表示したい順序でドラッグできます。
- Images must be of high resolution (at least 1200px wide).
- All images must be the same height and width (aspect ratio) to avoid page jumps when people click from one image to the next.
- Show as much of the user interface as possible so people can see what your app does.
- When taking screenshots of your app in a browser, only include the content in the display window. Avoid including the address bar, title bar, or toolbar icons, which do not scale well to smaller screen sizes.
- GitHub displays the screenshots you upload in a box on your app's landing page, so you don't need to add boxes or borders around your screenshots.
- Captions are most effective when they are short and snappy.
### スクリーンショットのガイドライン
- 画像は高解像度 (幅1200px以上) でなければなりません。
- 画像を次から次へのクリックしたときにページが移動するのを避けるために、すべての画像は高さと幅 (アスペクト比) を等しくする必要があります。
- アプリケーションの動作が見えるように、ユーザーインターフェースはできるだけ多く表示してください。
- ブラウザーでアプリケーションのスクリーンショットを取得するときには、ディスプレイウィンドウの内容のみを含めるようにします。 アドレスバー、タイトルバー、ツールバーのアイコンは含めないでください。小さい画面で適切に縮小されません。
- アップロードしたスクリーンショットは、アプリケーションのランディングページにあるボックスに表示されるので、スクリーンショットの周囲にボックスや枠線は必要ありません。
- キャプションは、短く簡潔なほうが効果があります。
![GitHub Marketplaceのスクリーンショット画像](/assets/images/marketplace/marketplace-screenshots.png)
![GitHub Marketplace screenshot image](/assets/images/marketplace/marketplace-screenshots.png)

View File

@@ -1,9 +1,9 @@
---
title: 顧客への課金
intro: '{% data variables.product.prodname_marketplace %}上のアプリケーションは、GitHubの課金ガイドラインと、推奨サービスのサポートを遵守しなければなりません。 弊社のガイドラインに従うことで、顧客は予想外のことなく支払いプロセスを進んで行きやすくなります。'
title: Billing customers
intro: 'Apps on {% data variables.product.prodname_marketplace %} should adhere to GitHub''s billing guidelines and support recommended services. Following our guidelines helps customers navigate the billing process without any surprises.'
redirect_from:
- /apps/marketplace/administering-listing-plans-and-user-accounts/billing-customers-in-github-marketplace/
- /apps/marketplace/selling-your-app/billing-customers-in-github-marketplace/
- /apps/marketplace/administering-listing-plans-and-user-accounts/billing-customers-in-github-marketplace
- /apps/marketplace/selling-your-app/billing-customers-in-github-marketplace
- /marketplace/selling-your-app/billing-customers-in-github-marketplace
- /developers/github-marketplace/billing-customers
versions:
@@ -12,39 +12,38 @@ versions:
topics:
- Marketplace
---
## Understanding the billing cycle
## 支払いを理解する
Customers can choose a monthly or yearly billing cycle when they purchase your app. All changes customers make to the billing cycle and plan selection will trigger a `marketplace_purchase` event. You can refer to the `marketplace_purchase` webhook payload to see which billing cycle a customer selects and when the next billing date begins (`effective_date`). For more information about webhook payloads, see "[Webhook events for the {% data variables.product.prodname_marketplace %} API](/developers/github-marketplace/webhook-events-for-the-github-marketplace-api)."
顧客は、アプリケーションの購入時に月次あるいは年次の支払いサイクルを選択できます。 顧客が行う支払いサイクルとプランの選択に対するすべての変更は、`marketplace_purchase`イベントを発生させます。 `marketplace_purchase` webhookのペイロードを参照すれば、顧客がどの支払いサイクルを選択したのか、そして次の支払日がいつ始まるのか`effective_date`)を知ることができます。 webhookのペイロードに関する情報については、「[{% data variables.product.prodname_marketplace %} APIのwebhookイベント](/developers/github-marketplace/webhook-events-for-the-github-marketplace-api)」を参照してください。
## Providing billing services in your app's UI
## アプリケーションのUIにおける支払いサービスの提供
アプリケーションのWebサイトからは、顧客が以下のアクションを行えなければなりません。
- 顧客は、個人とOrganizationのアカウントで別々に{% data variables.product.prodname_marketplace %}のプランを変更したり、キャンセルしたりできなければなりません。
Customers should be able to perform the following actions from your app's website:
- Customers should be able to modify or cancel their {% data variables.product.prodname_marketplace %} plans for personal and organizational accounts separately.
{% data reusables.marketplace.marketplace-billing-ui-requirements %}
## アップグレード、ダウングレード、キャンセルのための支払いサービス
## Billing services for upgrades, downgrades, and cancellations
明確で一貫性のある支払いプロセスを保つために、アップグレード、ダウングレード、キャンセルについて以下のガイドラインに従ってください。 {% data variables.product.prodname_marketplace %}の購入イベントに関する詳細な指示については、「[アプリケーションでの{% data variables.product.prodname_marketplace %} APIの利用](/developers/github-marketplace/using-the-github-marketplace-api-in-your-app)」を参照してください。
Follow these guidelines for upgrades, downgrades, and cancellations to maintain a clear and consistent billing process. For more detailed instructions about the {% data variables.product.prodname_marketplace %} purchase events, see "[Using the {% data variables.product.prodname_marketplace %} API in your app](/developers/github-marketplace/using-the-github-marketplace-api-in-your-app)."
`marketplace_purchase` webhook`effective_date`キーを使えば、プランの変更がいつ生じるのかを確認し、定期的に[プランのアカウントのリスト](/rest/reference/apps#list-accounts-for-a-plan)を同期できます。
You can use the `marketplace_purchase` webhook's `effective_date` key to determine when a plan change will occur and periodically synchronize the [List accounts for a plan](/rest/reference/apps#list-accounts-for-a-plan).
### アップグレード
### Upgrades
顧客が価格プランをアップグレードしたり、月次から年次へ支払いサイクルを変更したりした場合、その変更をすぐに有効にしなければなりません。 新しいプランに対して日割引を適用し、支払いサイクルを変更しなければなりません。
When a customer upgrades their pricing plan or changes their billing cycle from monthly to yearly, you should make the change effective for them immediately. You need to apply a pro-rated discount to the new plan and change the billing cycle.
{% data reusables.marketplace.marketplace-failed-purchase-event %}
アプリケーションでのアップグレード及びダウングレードワークフローの構築に関する情報については、「[プラン変更の処理](/developers/github-marketplace/handling-plan-changes)」を参照してください。
For information about building upgrade and downgrade workflows into your app, see "[Handling plan changes](/developers/github-marketplace/handling-plan-changes)."
### ダウングレードとキャンセル
### Downgrades and cancellations
ダウングレードは、顧客がFreeプランから有料プランに移行し、現在のプランよりも低コストなプランを選択するか、支払いサイクルを年次から月次に変更した場合に生じます。 ダウングレードもしくはキャンセルが生じた場合、返金は必要ありません。 その代わりに、現在のプランは現在の支払いサイクルの最終日まで有効です。 顧客の次の支払いサイクルの開始時点で、新しいプランが有効になると、`marketplace_purchase`イベントが送信されます。
顧客がプランをキャンセルした場合、以下を行わなければなりません。
- Freeプランがある場合には、自動的にFreeプランにダウングレードします。
Downgrades occur when a customer moves to a free plan from a paid plan, selects a plan with a lower cost than their current plan, or changes their billing cycle from yearly to monthly. When downgrades or cancellations occur, you don't need to provide a refund. Instead, the current plan will remain active until the last day of the current billing cycle. The `marketplace_purchase` event will be sent when the new plan takes effect at the beginning of the customer's next billing cycle.
When a customer cancels a plan, you must:
- Automatically downgrade them to the free plan, if it exists.
{% data reusables.marketplace.cancellation-clarification %}
- 顧客が後でプランを継続したくなった場合には、GitHubを通じてプランをアップグレードできるようにします。
- Enable them to upgrade the plan through GitHub if they would like to continue the plan at a later time.
アプリケーションでのキャンセルのワークフローの構築に関する情報については、「[プランのキャンセルの処理](/developers/github-marketplace/handling-plan-cancellations)」を参照してください。
For information about building cancellation workflows into your app, see "[Handling plan cancellations](/developers/github-marketplace/handling-plan-cancellations)."

View File

@@ -1,12 +1,12 @@
---
title: GitHub Marketplaceでのアプリケーションの販売
intro: 'アプリケーションを{% data variables.product.prodname_marketplace %}販売するための要件とベストプラクティスについて学んでください。'
title: Selling your app on GitHub Marketplace
intro: 'Learn about requirements and best practices for selling your app on {% data variables.product.prodname_marketplace %}.'
redirect_from:
- /apps/marketplace/administering-listing-plans-and-user-accounts/
- /apps/adding-integrations/managing-pricing-and-payments-for-a-github-marketplace-listing/
- /apps/marketplace/managing-pricing-and-payments-for-a-github-marketplace-listing/
- /apps/marketplace/pricing-payments-and-free-trials/
- /apps/marketplace/selling-your-app/
- /apps/marketplace/administering-listing-plans-and-user-accounts
- /apps/adding-integrations/managing-pricing-and-payments-for-a-github-marketplace-listing
- /apps/marketplace/managing-pricing-and-payments-for-a-github-marketplace-listing
- /apps/marketplace/pricing-payments-and-free-trials
- /apps/marketplace/selling-your-app
- /marketplace/selling-your-app
versions:
fpt: '*'
@@ -17,6 +17,6 @@ children:
- /pricing-plans-for-github-marketplace-apps
- /billing-customers
- /receiving-payment-for-app-purchases
shortTitle: Marketplaceでアプリケーションを販売
shortTitle: Sell apps on the Marketplace
---

View File

@@ -2,7 +2,7 @@
title: Pricing plans for GitHub Marketplace apps
intro: 'Pricing plans allow you to provide your app with different levels of service or resources. You can offer up to 10 pricing plans in your {% data variables.product.prodname_marketplace %} listing.'
redirect_from:
- /apps/marketplace/selling-your-app/github-marketplace-pricing-plans/
- /apps/marketplace/selling-your-app/github-marketplace-pricing-plans
- /marketplace/selling-your-app/github-marketplace-pricing-plans
- /developers/github-marketplace/pricing-plans-for-github-marketplace-apps
versions:

View File

@@ -2,9 +2,9 @@
title: Handling new purchases and free trials
intro: 'When a customer purchases a paid plan, free trial, or the free version of your {% data variables.product.prodname_marketplace %} app, you''ll receive the [`marketplace_purchase` event](/marketplace/integrating-with-the-github-marketplace-api/github-marketplace-webhook-events) webhook with the `purchased` action, which kicks off the purchasing flow.'
redirect_from:
- /apps/marketplace/administering-listing-plans-and-user-accounts/supporting-purchase-plans-for-github-apps/
- /apps/marketplace/administering-listing-plans-and-user-accounts/supporting-purchase-plans-for-oauth-apps/
- /apps/marketplace/integrating-with-the-github-marketplace-api/handling-new-purchases-and-free-trials/
- /apps/marketplace/administering-listing-plans-and-user-accounts/supporting-purchase-plans-for-github-apps
- /apps/marketplace/administering-listing-plans-and-user-accounts/supporting-purchase-plans-for-oauth-apps
- /apps/marketplace/integrating-with-the-github-marketplace-api/handling-new-purchases-and-free-trials
- /marketplace/integrating-with-the-github-marketplace-api/handling-new-purchases-and-free-trials
- /developers/github-marketplace/handling-new-purchases-and-free-trials
versions:

View File

@@ -1,9 +1,9 @@
---
title: プランのキャンセルの処理
intro: '{% data variables.product.prodname_marketplace %}アプリケーションをキャンセルすると、[`marketplace_purchase`イベント](/marketplace/integrating-with-the-github-marketplace-api/github-marketplace-webhook-events) webhook`cancelled`アクション付きでトリガされます。これによって、キャンセルのフローが開始されます。'
title: Handling plan cancellations
intro: 'Cancelling a {% data variables.product.prodname_marketplace %} app triggers the [`marketplace_purchase` event](/marketplace/integrating-with-the-github-marketplace-api/github-marketplace-webhook-events) webhook with the `cancelled` action, which kicks off the cancellation flow.'
redirect_from:
- /apps/marketplace/administering-listing-plans-and-user-accounts/cancelling-plans/
- /apps/marketplace/integrating-with-the-github-marketplace-api/cancelling-plans/
- /apps/marketplace/administering-listing-plans-and-user-accounts/cancelling-plans
- /apps/marketplace/integrating-with-the-github-marketplace-api/cancelling-plans
- /marketplace/integrating-with-the-github-marketplace-api/cancelling-plans
- /developers/github-marketplace/handling-plan-cancellations
versions:
@@ -11,26 +11,25 @@ versions:
ghec: '*'
topics:
- Marketplace
shortTitle: プランのキャンセル
shortTitle: Plan cancellations
---
For more information about cancelling as it relates to billing, see "[Billing customers in {% data variables.product.prodname_marketplace %}](/apps//marketplace/administering-listing-plans-and-user-accounts/billing-customers-in-github-marketplace)."
支払いに関連するキャンセルについての詳しい情報は、「[{% data variables.product.prodname_marketplace %}での顧客の支払い](/apps//marketplace/administering-listing-plans-and-user-accounts/billing-customers-in-github-marketplace)」を参照してください。
## Step 1. Cancellation event
## ステップ 1. キャンセルイベント
If a customer chooses to cancel a {% data variables.product.prodname_marketplace %} order, GitHub sends a [`marketplace_purchase`](/marketplace/integrating-with-the-github-marketplace-api/github-marketplace-webhook-events/) webhook with the action `cancelled` to your app when the cancellation takes effect. If the customer cancels during a free trial, your app will receive the event immediately. When a customer cancels a paid plan, the cancellation will occur at the end of the customer's billing cycle.
顧客が{% data variables.product.prodname_marketplace %}の注文をキャンセルすることにした場合、GitHubは[`marketplace_purchase`](/marketplace/integrating-with-the-github-marketplace-api/github-marketplace-webhook-events/) webhookを`cancelled`というアクション付きで、キャンセルが有効になった時点でアプリケーションに送信します。 顧客が無料トライアル中にキャンセルした場合、アプリケーションはすぐにこのイベントを受け取ります。 顧客が有料プランをキャンセルした場合、キャンセルは顧客の支払いサイクルの終了時に行われます。
## Step 2. Deactivating customer accounts
## ステップ 2. 顧客のアカウントのアクティベーション解除
When a customer cancels a free or paid plan, your app must perform these steps to complete cancellation:
顧客が無料もしくは有料のプランをキャンセルした場合、アプリケーションはキャンセルを完了するために以下のステップを実行しなければなりません。
1. プランをキャンセルした顧客のアカウントのアクティベーションを解除する。
1. 顧客用にアプリケーションが受け取ったOAuthトークンを取り消す。
1. アプリケーションがOAuthアプリケーションの場合、リポジトリ用にアプリケーションが作成したすべてのwebhookを削除する。
1. `cancelled`イベントを受け取ってから30日以内に顧客のすべてのデータを削除する。
1. Deactivate the account of the customer who cancelled their plan.
1. Revoke the OAuth token your app received for the customer.
1. If your app is an OAuth App, remove all webhooks your app created for repositories.
1. Remove all customer data within 30 days of receiving the `cancelled` event.
{% note %}
**ノート:** プランの変更がいつ生じるのかを知るために[`marketplace_purchase`](/marketplace/integrating-with-the-github-marketplace-api/github-marketplace-webhook-events/) webhook`effective_date`を利用し、定期的に[プランのリストアカウント](/rest/reference/apps#list-accounts-for-a-plan)を同期することをおすすめします。 webhookに関する詳しい情報については「[{% data variables.product.prodname_marketplace %}webhookイベント](/marketplace/integrating-with-the-github-marketplace-api/github-marketplace-webhook-events/)」を参照してください。
**Note:** We recommend using the [`marketplace_purchase`](/marketplace/integrating-with-the-github-marketplace-api/github-marketplace-webhook-events/) webhook's `effective_date` to determine when a plan change will occur and periodically synchronizing the [List accounts for a plan](/rest/reference/apps#list-accounts-for-a-plan). For more information on webhooks, see "[{% data variables.product.prodname_marketplace %} webhook events](/marketplace/integrating-with-the-github-marketplace-api/github-marketplace-webhook-events/)."
{% endnote %}

View File

@@ -1,9 +1,9 @@
---
title: プラン変更の処理
intro: '{% data variables.product.prodname_marketplace %} アプリケーションのアップグレードあるいはダウングレードによって、[`marketplace_purchase` イベント](/marketplace/integrating-with-the-github-marketplace-api/github-marketplace-webhook-events/) webhook`changed`アクション付きでトリガされ、それによってアップグレードあるいはダウングレードのフローが開始されます。'
title: Handling plan changes
intro: 'Upgrading or downgrading a {% data variables.product.prodname_marketplace %} app triggers the [`marketplace_purchase` event](/marketplace/integrating-with-the-github-marketplace-api/github-marketplace-webhook-events/) webhook with the `changed` action, which kicks off the upgrade or downgrade flow.'
redirect_from:
- /apps/marketplace/administering-listing-plans-and-user-accounts/upgrading-or-downgrading-plans/
- /apps/marketplace/integrating-with-the-github-marketplace-api/upgrading-and-downgrading-plans/
- /apps/marketplace/administering-listing-plans-and-user-accounts/upgrading-or-downgrading-plans
- /apps/marketplace/integrating-with-the-github-marketplace-api/upgrading-and-downgrading-plans
- /marketplace/integrating-with-the-github-marketplace-api/upgrading-and-downgrading-plans
- /developers/github-marketplace/handling-plan-changes
versions:
@@ -12,55 +12,54 @@ versions:
topics:
- Marketplace
---
For more information about upgrading and downgrading as it relates to billing, see "[Integrating with the {% data variables.product.prodname_marketplace %} API](/marketplace/integrating-with-the-github-marketplace-api/)."
支払いに関連するアップグレード及びダウングレードに関する詳しい説明については「[{% data variables.product.prodname_marketplace %} APIとのインテグレーション](/marketplace/integrating-with-the-github-marketplace-api/)」を参照してください。
## Step 1. Pricing plan change event
## ステップ 1. 料金プランの変更イベント
GitHub send the `marketplace_purchase` webhook with the `changed` action to your app, when a customer makes any of these changes to their {% data variables.product.prodname_marketplace %} order:
* Upgrades to a more expensive pricing plan or downgrades to a lower priced plan.
* Adds or removes seats to their existing plan.
* Changes the billing cycle.
顧客が{% data variables.product.prodname_marketplace %}の注文に対して以下のいずれかの変更を行うと、GitHubは`marketplace_purchase` webhookを`changed`アクション付きでアプリケーションに送信します。
* より高価な価格プランへのアップグレードあるいは低価格なプランへのダウングレード
* 既存のプランへのシートの追加あるいはシートの削除
* 支払いサイクルの変更
GitHub will send the webhook when the change takes effect. For example, when a customer downgrades a plan, GitHub sends the webhook at the end of the customer's billing cycle. GitHub sends a webhook to your app immediately when a customer upgrades their plan to allow them access to the new service right away. If a customer switches from a monthly to a yearly billing cycle, it's considered an upgrade. See "[Billing customers in {% data variables.product.prodname_marketplace %}](/marketplace/selling-your-app/billing-customers-in-github-marketplace/)" to learn more about what actions are considered an upgrade or downgrade.
GitHubは、変更が有効になるとwebhookを送信します。 たとえば、顧客がプランをダウングレードすると、その顧客の支払いサイクルの終了時点でwebhookを送信します。 顧客がプランをアップグレードした場合には、新しいサービスをすぐに利用できるようにするため、GitHubは即座にアプリケーションにwebhookを送信します。 顧客が支払いサイクルを月次から年次に切り替えた場合は、アップグレードと見なされます。 どういったアクションがアップグレードやダウングレードと見なされるかを詳しく学ぶには、「[{% data variables.product.prodname_marketplace %}での顧客への課金](/marketplace/selling-your-app/billing-customers-in-github-marketplace/)」を参照してください。
Read the `effective_date`, `marketplace_purchase`, and `previous_marketplace_purchase` from the `marketplace_purchase` webhook to update the plan's start date and make changes to the customer's billing cycle and pricing plan. See "[{% data variables.product.prodname_marketplace %} webhook events](/marketplace/integrating-with-the-github-marketplace-api/github-marketplace-webhook-events/)" for an example of the `marketplace_purchase` event payload.
プランの開始日を更新し、顧客の支払いサイクルと価格プランを変更するために、`marketplace_purchase`から`effective_date``marketplace_purchase``previous_marketplace_purchase`を読み取ってください。 `marketplace_purchase`イベントペイロードの例については「[{% data variables.product.prodname_marketplace %} webhookイベント](/marketplace/integrating-with-the-github-marketplace-api/github-marketplace-webhook-events/)」を参照してください。
If your app offers free trials, you'll receive the `marketplace_purchase` webhook with the `changed` action when the free trial expires. If the customer's free trial expires, upgrade the customer to the paid version of the free-trial plan.
アプリケーションが無料トライアルを提供しているなら、無料トライアルの有効期限が切れると`marketplace_purchase` webhookを`changed`アクション付きで受け取ります。 顧客の無料トライアル期間が終了したら、その顧客を無料トライアルプランの有料バージョンにアップグレードしてください。
## Step 2. Updating customer accounts
## ステップ 2. 顧客アカウントの更新
You'll need to update the customer's account information to reflect the billing cycle and pricing plan changes the customer made to their {% data variables.product.prodname_marketplace %} order. Display upgrades to the pricing plan, `seat_count` (for per-unit pricing plans), and billing cycle on your Marketplace app's website or your app's UI when you receive the `changed` action webhook.
顧客が{% data variables.product.prodname_marketplace %}の注文に対して行った支払いサイクルや価格プランの変更を反映させるために、顧客のアカウント情報を更新しなければなりません。 `changed`アクションwebhookを受信した際に、MarketplaceアプリケーションのWebサイトか、アプリケーションのUIに、価格プラン、`seat_count`(ユニット単位の価格プランの場合)、支払いサイクルのアップグレードを表示してください。
When a customer downgrades a plan, it's recommended to review whether a customer has exceeded their plan limits and engage with them directly in your UI or by reaching out to them by phone or email.
顧客がプランをダウングレードした場合には、顧客がプランの制限を超えているかをレビューし、UIで直接関わるか、電話やメールで連絡することをおすすめします。
アップグレードを促すために、アップグレードのURLをアプリケーションのUIに表示できます。 詳細については「[アップグレードURLについて](#about-upgrade-urls)」を参照してください。
To encourage people to upgrade you can display an upgrade URL in your app's UI. See "[About upgrade URLs](#about-upgrade-urls)" for more details.
{% note %}
**ノート:** `GET /marketplace_listing/plans/:id/accounts`を使って定期的に同期を行い、それぞれのアカウントに対してアプリケーションが正しいプラン、支払いサイクルの情報、ユニット数(ユニット単位の料金の場合)を保持していることを確認するようおすすめします。
**Note:** We recommend performing a periodic synchronization using `GET /marketplace_listing/plans/:id/accounts` to ensure your app has the correct plan, billing cycle information, and unit count (for per-unit pricing) for each account.
{% endnote %}
## アップグレードの支払いの失敗
## Failed upgrade payments
{% data reusables.marketplace.marketplace-failed-purchase-event %}
## アップグレードURLについて
## About upgrade URLs
アップグレードURLを使い、ユーザをアプリケーションのUIからGitHub上でのアップグレードへリダイレクトできます。
You can redirect users from your app's UI to upgrade on GitHub using an upgrade URL:
```
https://www.github.com/marketplace/<LISTING_NAME>/upgrade/<LISTING_PLAN_NUMBER>/<CUSTOMER_ACCOUNT_ID>
```
たとえば、顧客が5人のプランを使っていて、10人のプランに移行する必要があることに気づいた場合、アプリケーションのUIに「アップグレードの方法はこちら」というボタンを表示したり、アップグレードURLへのリンクを持つバナーを表示したりできます。 アップグレードURLは顧客をリストされたプランのアップグレードの確認ページへ移動させます。
For example, if you notice that a customer is on a 5 person plan and needs to move to a 10 person plan, you could display a button in your app's UI that says "Here's how to upgrade" or show a banner with a link to the upgrade URL. The upgrade URL takes the customer to your listing plan's upgrade confirmation page.
顧客が購入したいであろうプランの`LISTING_PLAN_NUMBER`を使ってください。 新しい価格プランを作成すると、それらにはリスト内で各プランに対してユニークな`LISTING_PLAN_NUMBER`と、{% data variables.product.prodname_marketplace %}内で各プランに対してユニークな`LISTING_PLAN_ID`が与えられます。 [プランをリスト](/rest/reference/apps#list-plans)する際にはこれらの番号があり、リストの価格プランを特定できます。 `LISTING_PLAN_ID`と「[プランに対するアカウントのリスト](/rest/reference/apps#list-accounts-for-a-plan)」エンドポイントを使って、`CUSTOMER_ACCOUNT_ID`を取得してください。
Use the `LISTING_PLAN_NUMBER` for the plan the customer would like to purchase. When you create new pricing plans they receive a `LISTING_PLAN_NUMBER`, which is unique to each plan across your listing, and a `LISTING_PLAN_ID`, which is unique to each plan in the {% data variables.product.prodname_marketplace %}. You can find these numbers when you [List plans](/rest/reference/apps#list-plans), which identifies your listing's pricing plans. Use the `LISTING_PLAN_ID` and the "[List accounts for a plan](/rest/reference/apps#list-accounts-for-a-plan)" endpoint to get the `CUSTOMER_ACCOUNT_ID`.
{% note %}
**ノート:** 顧客が追加ユニット(シートなど)のアップグレードをした場合でも、顧客に購入に対する適切なプランを送信することはできますが、その時点で弊社は`unit_count`パラメータをサポートできません。
**Note:** If your customer upgrades to additional units (such as seats), you can still send them to the appropriate plan for their purchase, but we are unable to support `unit_count` parameters at this time.
{% endnote %}

View File

@@ -1,9 +1,9 @@
---
title: アプリケーション内でのGitHub marketplace APIの使用
intro: '{% data variables.product.prodname_marketplace %}用に、アプリケーションに{% data variables.product.prodname_marketplace %} APIとwebhookイベントを統合する方法を学んでください。'
title: Using the GitHub Marketplace API in your app
intro: 'Learn how to integrate the {% data variables.product.prodname_marketplace %} API and webhook events into your app for the {% data variables.product.prodname_marketplace %} .'
redirect_from:
- /apps/marketplace/setting-up-github-marketplace-webhooks/
- /apps/marketplace/integrating-with-the-github-marketplace-api/
- /apps/marketplace/setting-up-github-marketplace-webhooks
- /apps/marketplace/integrating-with-the-github-marketplace-api
- /marketplace/integrating-with-the-github-marketplace-api
versions:
fpt: '*'
@@ -17,6 +17,6 @@ children:
- /handling-new-purchases-and-free-trials
- /handling-plan-changes
- /handling-plan-cancellations
shortTitle: Marketplace APIの使い方
shortTitle: Marketplace API usage
---

View File

@@ -1,9 +1,9 @@
---
title: GItHub Marketplace API用のRESTエンドポイント
intro: '{% data variables.product.prodname_marketplace %}上でのアプリケーションの管理を支援するために、以下の{% data variables.product.prodname_marketplace %} APIエンドポイントを使ってください。'
title: REST endpoints for the GitHub Marketplace API
intro: 'To help manage your app on {% data variables.product.prodname_marketplace %}, use these {% data variables.product.prodname_marketplace %} API endpoints.'
redirect_from:
- /apps/marketplace/github-marketplace-api-endpoints/
- /apps/marketplace/integrating-with-the-github-marketplace-api/github-marketplace-rest-api-endpoints/
- /apps/marketplace/github-marketplace-api-endpoints
- /apps/marketplace/integrating-with-the-github-marketplace-api/github-marketplace-rest-api-endpoints
- /marketplace/integrating-with-the-github-marketplace-api/github-marketplace-rest-api-endpoints
- /developers/github-marketplace/rest-endpoints-for-the-github-marketplace-api
versions:
@@ -13,21 +13,20 @@ topics:
- Marketplace
shortTitle: REST API
---
Here are some useful endpoints available for Marketplace listings:
以下は、Marketplaceのリストで利用できる便利なエンドポイントです。
* [List plans](/rest/reference/apps#list-plans)
* [List accounts for a plan](/rest/reference/apps#list-accounts-for-a-plan)
* [Get a subscription plan for an account](/rest/reference/apps#get-a-subscription-plan-for-an-account)
* [List subscriptions for the authenticated user](/rest/reference/apps#list-subscriptions-for-the-authenticated-user)
* [プランのリスト](/rest/reference/apps#list-plans)
* [プランのアカウントのリスト](/rest/reference/apps#list-accounts-for-a-plan)
* [アカウントのサブスクリプションプランの取得](/rest/reference/apps#get-a-subscription-plan-for-an-account)
* [認証されたユーザのサブスクリプションのリスト](/rest/reference/apps#list-subscriptions-for-the-authenticated-user)
See these pages for details on how to authenticate when using the {% data variables.product.prodname_marketplace %} API:
{% data variables.product.prodname_marketplace %} APIを使用する際の認証の受け方の詳細については、以下のページを参照してください。
* [OAuth Appの認可オプション](/apps/building-oauth-apps/authorizing-oauth-apps/)
* [GitHub Appの認可オプション](/apps/building-github-apps/authenticating-with-github-apps/)
* [Authorization options for OAuth Apps](/apps/building-oauth-apps/authorizing-oauth-apps/)
* [Authentication options for GitHub Apps](/apps/building-github-apps/authenticating-with-github-apps/)
{% note %}
**ノート:** [REST APIのためのレート制限](/rest#rate-limiting)は、{% data variables.product.prodname_marketplace %} APIのすべてのエンドポイントに適用されます。
**Note:** [Rate limits for the REST API](/rest#rate-limiting) apply to all {% data variables.product.prodname_marketplace %} API endpoints.
{% endnote %}

View File

@@ -1,9 +1,9 @@
---
title: アプリをテストする
intro: 'リストを{% data variables.product.prodname_marketplace %}にサブミットする前に、APIとwebhookを使ってアプリケーションをテストし、顧客に理想的な体験を提供できるようにすることをGitHubはおすすめします。 オンボーディングの専門家の検証前に、アプリケーションは支払いフローを適切に処理しなければなりません。'
title: Testing your app
intro: 'GitHub recommends testing your app with APIs and webhooks before submitting your listing to {% data variables.product.prodname_marketplace %} so you can provide an ideal experience for customers. Before an onboarding expert approves your app, it must adequately handle the billing flows.'
redirect_from:
- /apps/marketplace/testing-apps-apis-and-webhooks/
- /apps/marketplace/integrating-with-the-github-marketplace-api/testing-github-marketplace-apps/
- /apps/marketplace/testing-apps-apis-and-webhooks
- /apps/marketplace/integrating-with-the-github-marketplace-api/testing-github-marketplace-apps
- /marketplace/integrating-with-the-github-marketplace-api/testing-github-marketplace-apps
- /developers/github-marketplace/testing-your-app
versions:
@@ -12,35 +12,34 @@ versions:
topics:
- Marketplace
---
## Testing apps
## アプリケーションのテスト
You can use a draft {% data variables.product.prodname_marketplace %} listing to simulate each of the billing flows. A listing in the draft state means that it has not been submitted for approval. Any purchases you make using a draft {% data variables.product.prodname_marketplace %} listing will _not_ create real transactions, and GitHub will not charge your credit card. Note that you can only simulate purchases for plans published in the draft listing and not for draft plans. For more information, see "[Drafting a listing for your app](/developers/github-marketplace/drafting-a-listing-for-your-app)" and "[Using the {% data variables.product.prodname_marketplace %} API in your app](/developers/github-marketplace/using-the-github-marketplace-api-in-your-app)."
ドラフトの{% data variables.product.prodname_marketplace %}リストを使って、それぞれの支払いフローをシミュレートできます。 リストがドラフト状態にあるということは、まだそれが承認のためにサブミットされていないということです。 ドラフトの{% data variables.product.prodname_marketplace %}リストを使って行った購入は、実際の取引には_ならず_、GitHubはクレジットカードへの課金をしません。 シミュレートできるのはドラフトのリストに掲載されているプランの購入のみであり、ドラフトのプラン購入はシミュレートできません。 詳細な情報については、「[アプリケーションのリストのドラフト](/developers/github-marketplace/drafting-a-listing-for-your-app)」及び「[アプリケーションでの{% data variables.product.prodname_marketplace %} APIの利用](/developers/github-marketplace/using-the-github-marketplace-api-in-your-app)」を参照してください。
### Using a development app with a draft listing to test changes
### 変更のテストのために開発アプリケーションをドラフトリストと使用する
A {% data variables.product.prodname_marketplace %} listing can only be associated with a single app registration, and each app can only access its own {% data variables.product.prodname_marketplace %} listing. For these reasons, we recommend configuring a separate development app, with the same configuration as your production app, and creating a _draft_ {% data variables.product.prodname_marketplace %} listing that you can use for testing. The draft {% data variables.product.prodname_marketplace %} listing allows you to test changes without affecting the active users of your production app. You will never have to submit your development {% data variables.product.prodname_marketplace %} listing, since you will only use it for testing.
{% data variables.product.prodname_marketplace %}リストは、1つのアプリケーションの登録とのみ関連づけることができ、それぞれのアプリケーションは自身の{% data variables.product.prodname_marketplace %}リストにのみアクセスできます。 そのため、プロダクションのアプリケーションと同じ設定で別個の開発アプリケーションを設定し、テストに使用できる_ドラフト_の{% data variables.product.prodname_marketplace %}リストを作成することをおすすめします。 ドラフトの{% data variables.product.prodname_marketplace %}リストを使えば、プロダクションのアプリケーションのアクティブなユーザに影響することなく変更をテストできます。 開発の{% data variables.product.prodname_marketplace %}リストはテストにのみ使われるので、サブミットする必要はありません。
Because you can only create draft {% data variables.product.prodname_marketplace %} listings for public apps, you must make your development app public. Public apps are not discoverable outside of published {% data variables.product.prodname_marketplace %} listings as long as you don't share the app's URL. A Marketplace listing in the draft state is only visible to the app's owner.
ドラフトの{% data variables.product.prodname_marketplace %}リストは公開アプリケーションに対してのみ作成できるので、開発アプリケーションは公開しなければなりません。 公開アプリケーションは、アプリケーションのURLを共有しないかぎり、公開された{% data variables.product.prodname_marketplace %}リスト外で見つかることはありません。 ドラフト状態のMarketplaceリストは、アプリケーションの所有者にしか見えません。
ドラフトリストと共に開発アプリケーションができたら、{% data variables.product.prodname_marketplace %} APIやwebhookと統合しながらそれを使ってアプリケーションの変更をテストできます。
Once you have a development app with a draft listing, you can use it to test changes you make to your app while integrating with the {% data variables.product.prodname_marketplace %} API and webhooks.
{% warning %}
{% data variables.product.prodname_marketplace %}で公開されているアプリケーションでは、購入のテストを行わないでください。
Do not make test purchases with an app that is live in {% data variables.product.prodname_marketplace %}.
{% endwarning %}
### Marketplaceの購入イベントのシミュレーション
### Simulating Marketplace purchase events
テストのシナリオでは、無料トライアルを提供するリストプランをセットアップし、無料と有料のサブスクリプション間の切り替えが必要になるかもしれません。 ダウングレードやキャンセルは、次回の支払いサイクルまでは有効にならないので、GitHubは開発者のみの機能として、`changed`及び`cancelled`のプランアクションを強制的にすぐに有効にする「保留中の変更の適用」機能を提供しています。 _ドラフト_Marketplaceリストのアプリケーションのための**保留中の変更の適用**には、https://github.com/settings/billing#pending-cycleでアクセスできます。
Your testing scenarios may require setting up listing plans that offer free trials and switching between free and paid subscriptions. Because downgrades and cancellations don't take effect until the next billing cycle, GitHub provides a developer-only feature to "Apply Pending Change" to force `changed` and `cancelled` plan actions to take effect immediately. You can access **Apply Pending Change** for apps with _draft_ Marketplace listings in https://github.com/settings/billing#pending-cycle:
![保留中の変更の適用](/assets/images/github-apps/github-apps-apply-pending-changes.png)
![Apply pending change](/assets/images/github-apps/github-apps-apply-pending-changes.png)
## APIのテスト
## Testing APIs
ほとんどの{% data variables.product.prodname_marketplace %} APIエンドポイントに対しては、テストに利用できるハードコーディングされた偽のデータを返すスタブのAPIエンドポイントも提供されています。 スタブのデータを受信するには、ルートに`/stubbed`を含むスタブURLたとえば`/user/marketplace_purchases/stubbed`)を指定してください。 スタブデータのアプローチをサポートしているエンドポイントのリストは、[{% data variables.product.prodname_marketplace %}エンドポイント](/rest/reference/apps#github-marketplace)を参照してください。
For most {% data variables.product.prodname_marketplace %} API endpoints, we also provide stubbed API endpoints that return hard-coded, fake data you can use for testing. To receive stubbed data, you must specify stubbed URLs, which include `/stubbed` in the route (for example, `/user/marketplace_purchases/stubbed`). For a list of endpoints that support this stubbed-data approach, see [{% data variables.product.prodname_marketplace %} endpoints](/rest/reference/apps#github-marketplace).
## webhookのテスト
## Testing webhooks
GitHubは、デプロイされたペイロードをテストするためのツールを提供しています。 詳しい情報については「[webhookのテスト](/webhooks/testing/)」を参照してください。
GitHub provides tools for testing your deployed payloads. For more information, see "[Testing webhooks](/webhooks/testing/)."

View File

@@ -1,9 +1,9 @@
---
title: GitHub Marketplace APIのためのwebhookイベント
intro: '{% data variables.product.prodname_marketplace %}アプリケーションは、ユーザのプランに対する変更に関する情報を、Marketplaceの購入イベントwebhookから受け取ります。 Marketplaceの購入イベントは、ユーザが支払いプランの購入、キャンセル、変更をした場合にトリガーされます。'
title: Webhook events for the GitHub Marketplace API
intro: 'A {% data variables.product.prodname_marketplace %} app receives information about changes to a user''s plan from the Marketplace purchase event webhook. A Marketplace purchase event is triggered when a user purchases, cancels, or changes their payment plan.'
redirect_from:
- /apps/marketplace/setting-up-github-marketplace-webhooks/about-webhook-payloads-for-a-github-marketplace-listing/
- /apps/marketplace/integrating-with-the-github-marketplace-api/github-marketplace-webhook-events/
- /apps/marketplace/setting-up-github-marketplace-webhooks/about-webhook-payloads-for-a-github-marketplace-listing
- /apps/marketplace/integrating-with-the-github-marketplace-api/github-marketplace-webhook-events
- /marketplace/integrating-with-the-github-marketplace-api/github-marketplace-webhook-events
- /developers/github-marketplace/webhook-events-for-the-github-marketplace-api
versions:
@@ -11,66 +11,65 @@ versions:
ghec: '*'
topics:
- Marketplace
shortTitle: webhook イベント
shortTitle: Webhook events
---
## {% data variables.product.prodname_marketplace %} purchase webhook payload
## {% data variables.product.prodname_marketplace %}購入webhookのペイロード
Webhooks `POST` requests have special headers. See "[Webhook delivery headers](/webhooks/event-payloads/#delivery-headers)" for more details. GitHub doesn't resend failed delivery attempts. Ensure your app can receive all webhook payloads sent by GitHub.
webhookの`POST`リクエストには、特別なヘッダがあります。 詳細については「[webhookの配信ヘッダ](/webhooks/event-payloads/#delivery-headers)」を参照してください。 GitHubは、失敗した配信の試行を再送信しません。 GitHubが送信したすべてのwebhookのペイロードを、アプリケーションが確実に受信できるようにしてください。
キャンセル及びダウングレードは、次の支払いサイクルの初日に有効になります。 ダウングレードとキャンセルのイベントは、次の支払いサイクルの開始時に新しいプランが有効になったときに送信されます。 新規の購入とアップグレードのイベントは、すぐに開始されます。 変更がいつ始まるかを判断するには、webhookのペイロード中の`effective_date`を使ってください。
Cancellations and downgrades take effect on the first day of the next billing cycle. Events for downgrades and cancellations are sent when the new plan takes effect at the beginning of the next billing cycle. Events for new purchases and upgrades begin immediately. Use the `effective_date` in the webhook payload to determine when a change will begin.
{% data reusables.marketplace.marketplace-malicious-behavior %}
それぞれの`marketplace_purchase` webhookのペイロードは、以下の情報を持ちます。
Each `marketplace_purchase` webhook payload will have the following information:
| キー | 種類 | 説明 |
| ---------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `action` | `string` | webhookを生成するために行われたアクション。 `purchased``cancelled``pending_change``pending_change_cancelled``changed`のいずれかになります。 詳しい情報については、以下のwebhookペイロードの例を参照してください。 **ノート:** `pending_change`及び`pending_change_cancelled`ペイロードには、[`changed`ペイロードの例](#example-webhook-payload-for-a-changed-event)に示されているものと同じキーが含まれます。 |
| `effective_date` | `string` | `action`が有効になる日付。 |
| `sender` | `オブジェクト` | webhookをトリガーした`action`を行った人。 |
| `marketplace_purchase` | `オブジェクト` | {% data variables.product.prodname_marketplace %}の購入情報。 |
Key | Type | Description
----|------|-------------
`action` | `string` | The action performed to generate the webhook. Can be `purchased`, `cancelled`, `pending_change`, `pending_change_cancelled`, or `changed`. For more information, see the example webhook payloads below. **Note:** The `pending_change` and `pending_change_cancelled` payloads contain the same keys as shown in the [`changed` payload example](#example-webhook-payload-for-a-changed-event).
`effective_date` | `string` | The date the `action` becomes effective.
`sender` | `object` | The person who took the `action` that triggered the webhook.
`marketplace_purchase` | `object` | The {% data variables.product.prodname_marketplace %} purchase information.
`marketplace_purchase`オブジェクトは、以下のキーを持ちます。
The `marketplace_purchase` object has the following keys:
| キー | 種類 | 説明 |
| -------------------- | --------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `アカウント` | `オブジェクト` | サブスクリプションに関連づけられた`organization`もしくあは`user`アカウント。 Organizationアカウントは、そのOrganizationの管理者のメールアドレスである`organization_billing_email`を含みます。 個人アカウントのメールアドレスを知るには、[認証されたユーザの取得](/rest/reference/users#get-the-authenticated-user)エンドポイントが利用できます。 |
| `billing_cycle` | `string` | `yearly`もしくは`monthly`のいずれかになります。 `account`の所有者が無料のGitHubのプランを使っており、無料の{% data variables.product.prodname_marketplace %}プランを購入した場合、`billing_cycle``nil`になります。 |
| `unit_count` | `integer` | 購入したユーザ数。 |
| `on_free_trial` | `boolean` | `account`が無料トライアル中の場合`true`になります。 |
| `free_trial_ends_on` | `string` | 無料トライアルが期限切れになる日付。 |
| `next_billing_date` | `string` | 次の支払いサイクルが始まる日付。 `account`の所有者が無料のGitHub.comのプランを使っており、無料の{% data variables.product.prodname_marketplace %}プランを購入した場合、`next_billing_date``nil`になります。 |
| `plan` | `オブジェクト` | `user`または`organization`が購入したプラン。 |
Key | Type | Description
----|------|-------------
`account` | `object` | The `organization` or `user` account associated with the subscription. Organization accounts will include `organization_billing_email`, which is the organization's administrative email address. To find email addresses for personal accounts, you can use the [Get the authenticated user](/rest/reference/users#get-the-authenticated-user) endpoint.
`billing_cycle` | `string` | Can be `yearly` or `monthly`. When the `account` owner has a free GitHub plan and has purchased a free {% data variables.product.prodname_marketplace %} plan, `billing_cycle` will be `nil`.
`unit_count` | `integer` | Number of units purchased.
`on_free_trial` | `boolean` | `true` when the `account` is on a free trial.
`free_trial_ends_on` | `string` | The date the free trial will expire.
`next_billing_date` | `string` | The date that the next billing cycle will start. When the `account` owner has a free GitHub.com plan and has purchased a free {% data variables.product.prodname_marketplace %} plan, `next_billing_date` will be `nil`.
`plan` | `object` | The plan purchased by the `user` or `organization`.
`plan`オブジェクトには以下のキーがあります。
The `plan` object has the following keys:
| キー | 種類 | 説明 |
| ------------------------ | ------------------ | ------------------------------------------------------ |
| `id` | `integer` | このプランの一意の識別子。 |
| `name` | `string` | プラン名。 |
| `説明` | `string` | プランの説明。 |
| `monthly_price_in_cents` | `integer` | このプランのセント (米国の通貨) 単位の月額。 たとえば、月額10米ドルのリストは1000セントです。 |
| `yearly_price_in_cents` | `integer` | このプランのセント (米国の通貨) 単位の年額。 たとえば、月額100米ドルのリストは10000セントです。 |
| `price_model` | `string` | このリストの価格モデル。 `flat-rate``per-unit``free`のいずれかです。 |
| `has_free_trial` | `boolean` | このリストが無料トライアルを提供する場合は`true`になります。 |
| `unit_name` | `string` | ユニットの名前。 価格モデルが`per-unit`でない場合、これは`nil`になります。 |
| `bullet` | `array of strings` | 価格プランに設定されている箇条書きの名前。 |
Key | Type | Description
----|------|-------------
`id` | `integer` | The unique identifier for this plan.
`name` | `string` | The plan's name.
`description` | `string` | This plan's description.
`monthly_price_in_cents` | `integer` | The monthly price of this plan in cents (US currency). For example, a listing that costs 10 US dollars per month will be 1000 cents.
`yearly_price_in_cents` | `integer` | The yearly price of this plan in cents (US currency). For example, a listing that costs 100 US dollars per month will be 10000 cents.
`price_model` | `string` | The pricing model for this listing. Can be one of `flat-rate`, `per-unit`, or `free`.
`has_free_trial` | `boolean` | `true` when this listing offers a free trial.
`unit_name` | `string` | The name of the unit. If the pricing model is not `per-unit` this will be `nil`.
`bullet` | `array of strings` | The names of the bullets set in the pricing plan.
<br/>
### `purchased`イベントのサンプルwebhookペイロード
次の例は、`purchased`イベントのペイロードを示しています。
### Example webhook payload for a `purchased` event
This example provides the `purchased` event payload.
{{ webhookPayloadsForCurrentVersion.marketplace_purchase.purchased }}
### `changed`イベントのサンプルwebhookペイロード
### Example webhook payload for a `changed` event
プランの変更には、アップグレードとダウンロードがあります。 この例は、`changed``pending_change`、および`pending_change_cancelled`イベントのペイロードを表しています。 このアクションは、これら3つのイベントのうちどれが発生したかを示します。
Changes in a plan include upgrades and downgrades. This example represents the `changed`,`pending_change`, and `pending_change_cancelled` event payloads. The action identifies which of these three events has occurred.
{{ webhookPayloadsForCurrentVersion.marketplace_purchase.changed }}
### `cancelled`イベントのサンプルwebhookペイロード
### Example webhook payload for a `cancelled` event
{{ webhookPayloadsForCurrentVersion.marketplace_purchase.cancelled }}

View File

@@ -2,7 +2,7 @@
title: Managing deploy keys
intro: Learn different ways to manage SSH keys on your servers when you automate deployment scripts and which way is best for you.
redirect_from:
- /guides/managing-deploy-keys/
- /guides/managing-deploy-keys
- /v3/guides/managing-deploy-keys
versions:
fpt: '*'

View File

@@ -1,9 +1,9 @@
---
title: GitHub Servicesの置き換え
intro: '非推奨となった{% data variables.product.prodname_dotcom %} Servicesにまだ依存しているなら、サービスフックをwebhookに移行する方法を学んでください。'
title: Replacing GitHub Services
intro: 'If you''re still relying on the deprecated {% data variables.product.prodname_dotcom %} Services, learn how to migrate your service hooks to webhooks.'
redirect_from:
- /guides/replacing-github-services/
- /v3/guides/automating-deployments-to-integrators/
- /guides/replacing-github-services
- /v3/guides/automating-deployments-to-integrators
- /v3/guides/replacing-github-services
versions:
fpt: '*'
@@ -14,61 +14,61 @@ topics:
---
GitHub Servicesは、webhookとの統合を進めるために非推奨となりました。 このガイドは、GitHub Servicesからwebhookへの移行を支援します。 このアナウンスに関する詳細については、[ブログポスト](https://developer.github.com/changes/2018-10-01-denying-new-github-services)を参照してください。
We have deprecated GitHub Services in favor of integrating with webhooks. This guide helps you transition to webhooks from GitHub Services. For more information on this announcement, see the [blog post](https://developer.github.com/changes/2018-10-01-denying-new-github-services).
{% note %}
メールサービスに代わるものとして、リポジトリへのプッシュに対するメール通知を利用しはじめられるようになりました。 コミットメール通知の設定方法については、「[リポジトリへのプッシュに対するメール通知について](/github/receiving-notifications-about-activity-on-github/about-email-notifications-for-pushes-to-your-repository/)」を参照してください。
As an alternative to the email service, you can now start using email notifications for pushes to your repository. See "[About email notifications for pushes to your repository](/github/receiving-notifications-about-activity-on-github/about-email-notifications-for-pushes-to-your-repository/)" to learn how to configure commit email notifications.
{% endnote %}
## 非推奨のタイムライン
## Deprecation timeline
- **2018年10月1日**: GitHubはユーザがサービスをインストールするのを禁止しました。 GitHub.comのユーザインターフェースから、GitHub Servicesを削除しました。
- **2019年1月29日**: メールサービスの代替として、リポジトリへのプッシュに対するメール通知を使い始められるようになりました。 コミットメール通知の設定方法については、「[リポジトリへのプッシュに対するメール通知について](/github/receiving-notifications-about-activity-on-github/about-email-notifications-for-pushes-to-your-repository/)」を参照してください。
- **2019年1月31日**: GitHubはGitHub.com上でのインストールされたサービスのイベント配信を停止しました。
- **October 1, 2018**: GitHub discontinued allowing users to install services. We removed GitHub Services from the GitHub.com user interface.
- **January 29, 2019**: As an alternative to the email service, you can now start using email notifications for pushes to your repository. See "[About email notifications for pushes to your repository](/github/receiving-notifications-about-activity-on-github/about-email-notifications-for-pushes-to-your-repository/)" to learn how to configure commit email notifications.
- **January 31, 2019**: GitHub will stop delivering installed services' events on GitHub.com.
## GitHub Servicesの背景
## GitHub Services background
GitHub ServicesService Hooksと呼ばれることもありますは、インテグレーションの旧来の方法であり、GitHubがインテグレーターのサービスの一部を[`github-services`リポジトリ](https://github.com/github/github-services)を通じてホストします。 GitHub上で行われたアクションがこれらのサービスをトリガーし、これらのサービスを使ってGitHubの外部のアクションをトリガーできます。
GitHub Services (sometimes referred to as Service Hooks) is the legacy method of integrating where GitHub hosted a portion of our integrators services via [the `github-services` repository](https://github.com/github/github-services). Actions performed on GitHub trigger these services, and you can use these services to trigger actions outside of GitHub.
{% ifversion ghes or ghae %}
## GitHub Servicesを使っているリポジトリを探す
アプライアンス上でどのリポジトリがGitHub Servicesを使っているかを特定するためのコマンドラインスクリプトが提供されています。 詳しい情報については[ghe-legacy-github-services-report](/enterprise/{{currentVersion}}/admin/articles/command-line-utilities/#ghe-legacy-github-services-report)を参照してください。{% endif %}
## Finding repositories that use GitHub Services
We provide a command-line script that helps you identify which repositories on your appliance use GitHub Services. For more information, see [ghe-legacy-github-services-report](/enterprise/{{currentVersion}}/admin/articles/command-line-utilities/#ghe-legacy-github-services-report).{% endif %}
## GitHub Serviceswebhook
## GitHub Services vs. webhooks
GitHub Serviceswebhookとの主な違いは以下のとおりです。
- **設定**: GitHub Servicesにはサービス固有の設定オプションがありますが、webhookはURLとイベント群を指定するだけで単純に設定できます。
- **カスタムロジック**: GitHub Servicesは1つのイベントの処理の一部として、複数のアクションで反応するカスタムロジックを持つことができますが、webhookにはカスタムロジックはありません。
- **リクエストの種類**: GitHub ServicesはHTTP及び非HTTPリクエストを発行できますが、webhookが発行できるのはHTTPリクエストのみです。
The key differences between GitHub Services and webhooks:
- **Configuration**: GitHub Services have service-specific configuration options, while webhooks are simply configured by specifying a URL and a set of events.
- **Custom logic**: GitHub Services can have custom logic to respond with multiple actions as part of processing a single event, while webhooks have no custom logic.
- **Types of requests**: GitHub Services can make HTTP and non-HTTP requests, while webhooks can make HTTP requests only.
## webhookでのServicesの置き換え
## Replacing Services with webhooks
GitHub Servicesをwebhookで置き換えるには、以下のようにします。
To replace GitHub Services with Webhooks:
1. [このリスト](/webhooks/#events)から、サブスクライブする必要がある関連webhookイベントを特定してください。
1. Identify the relevant webhook events youll need to subscribe to from [this list](/webhooks/#events).
2. GitHub Servicesを現在使っている方法に応じて、設定を変更してください。
2. Change your configuration depending on how you currently use GitHub Services:
- **GitHub Apps**: アプリケーションの権限とサブスクライブしているイベントを更新し、関連するwebhookイベントを受信するようにアプリケーションを設定してください。
- **OAuth Apps**: `repo_hook``org_hook`スコープをリクエストして、ユーザの代わりに関連するイベントを管理してください。
- **GitHub Serviceプロバイダー**: ユーザが手動で、送信された関連するイベントとあわせてwebhookを設定するように要求するか、この機会にこの機能を管理するアプリケーションを構築してください。 詳しい情報については「[アプリケーションについて](/apps/about-apps/)」を参照してください。
- **GitHub Apps**: Update your app's permissions and subscribed events to configure your app to receive the relevant webhook events.
- **OAuth Apps**: Request either the `repo_hook` and/or `org_hook` scope(s) to manage the relevant events on behalf of users.
- **GitHub Service providers**: Request that users manually configure a webhook with the relevant events sent to you, or take this opportunity to build an app to manage this functionality. For more information, see "[About apps](/apps/about-apps/)."
3. GitHubの外部から、追加の設定を移動してください。 GitHub Servicesの中には、GitHub内の設定ページで追加のカスタム設定が必要になるものがあります。 使っているサービスがそうなら、この機能をアプリケーションに移すか、可能な場合はGitHub AppもしくはOAuth Appに依存する必要があります。
3. Move additional configuration from outside of GitHub. Some GitHub Services require additional, custom configuration on the configuration page within GitHub. If your service does this, you will need to move this functionality into your application or rely on GitHub or OAuth Apps where applicable.
## {% data variables.product.prodname_ghe_server %}のサポート
## Supporting {% data variables.product.prodname_ghe_server %}
- **{% data variables.product.prodname_ghe_server %} 2.17**: {% data variables.product.prodname_ghe_server %} リリース2.17以降では、管理者がサービスをインストールできなくなります。 {% data variables.product.prodname_ghe_server %}リリース2.17から2.19では、管理者は引き続き既存のサービスフックを変更し、サービスフックを受信できます。 {% data variables.product.prodname_ghe_server %} 2.17以降では、メールサービスの代替としてリポジトリへのプッシュに対するメール通知が使えます。 詳細については[このブログポスト](https://developer.github.com/changes/2019-01-29-life-after-github-services)を参照してください。
- **{% data variables.product.prodname_ghe_server %} 2.20**: {% data variables.product.prodname_ghe_server %}リリース2.20以降では、インストールされたすべてのサービスイベントの配信が停止されます。
- **{% data variables.product.prodname_ghe_server %} 2.17**: {% data variables.product.prodname_ghe_server %} release 2.17 and higher will discontinue allowing admins to install services. Admins will continue to be able to modify existing service hooks and receive service hooks in {% data variables.product.prodname_ghe_server %} release 2.17 through 2.19. As an alternative to the email service, you will be able to use email notifications for pushes to your repository in {% data variables.product.prodname_ghe_server %} 2.17 and higher. See [this blog post](https://developer.github.com/changes/2019-01-29-life-after-github-services) to learn more.
- **{% data variables.product.prodname_ghe_server %} 2.20**: {% data variables.product.prodname_ghe_server %} release 2.20 and higher will stop delivering all installed services' events.
{% data variables.product.prodname_ghe_server %} 2.17リリースは、管理者がGitHub Servicesをインストールできない最初のリリースになります。 既存のGitHub Servicesは、{% data variables.product.prodname_ghe_server %} 2.20リリースまでしかサポートされません。 また、2019年10月1日まで{% data variables.product.prodname_ghe_server %}上で動作しているGitHub Serviceに対する重要なパッチを受け付けます。
The {% data variables.product.prodname_ghe_server %} 2.17 release will be the first release that does not allow admins to install GitHub Services. We will only support existing GitHub Services until the {% data variables.product.prodname_ghe_server %} 2.20 release. We will also accept any critical patches for your GitHub Service running on {% data variables.product.prodname_ghe_server %} until October 1, 2019.
## 弊社の支援を受けての移行
## Migrating with our help
質問があれば、[お問い合わせ](https://github.com/contact?form%5Bsubject%5D=GitHub+Services+Deprecation)ください。
Please [contact us](https://github.com/contact?form%5Bsubject%5D=GitHub+Services+Deprecation) with any questions.
高レベルの概要としては、移行のプロセスは通常以下を含みます。
- 製品がどこでどのようにGitHub Servicesを使っているかの特定。
- 通常のwebhookに移行するために設定する必要がある、対応するwebhookイベントの特定。
- [{% data variables.product.prodname_oauth_apps %}](/apps/building-oauth-apps/)または[{% data variables.product.prodname_github_apps %}のいずれかを利用して設計を実装。 {% data variables.product.prodname_github_apps %}](/apps/building-github-apps/)の方が望ましいです。 {% data variables.product.prodname_github_apps %}が望ましい理由の詳細を学ぶには、「[{% data variables.product.prodname_github_apps %}に切り替える理由](/apps/migrating-oauth-apps-to-github-apps/#reasons-for-switching-to-github-apps)」を参照してください。
As a high-level overview, the process of migration typically involves:
- Identifying how and where your product is using GitHub Services.
- Identifying the corresponding webhook events you need to configure in order to move to plain webhooks.
- Implementing the design using either [{% data variables.product.prodname_oauth_apps %}](/apps/building-oauth-apps/) or [{% data variables.product.prodname_github_apps %}. {% data variables.product.prodname_github_apps %}](/apps/building-github-apps/) are preferred. To learn more about why {% data variables.product.prodname_github_apps %} are preferred, see "[Reasons for switching to {% data variables.product.prodname_github_apps %}](/apps/migrating-oauth-apps-to-github-apps/#reasons-for-switching-to-github-apps)."

View File

@@ -3,7 +3,7 @@ title: Secret scanning partner program
intro: 'As a service provider, you can partner with {% data variables.product.prodname_dotcom %} to have your secret token formats secured through secret scanning, which searches for accidental commits of your secret format and can be sent to a service provider''s verify endpoint.'
miniTocMaxHeadingLevel: 3
redirect_from:
- /partnerships/token-scanning/
- /partnerships/token-scanning
- /partnerships/secret-scanning
- /developers/overview/secret-scanning
versions:

View File

@@ -1,8 +1,8 @@
---
title: SSHエージェント転送の利用
intro: サーバーへのデプロイを簡単にするために、SSHエージェント転送をセットアップして、安全にローカルのSSHキーを使うことができます。
title: Using SSH agent forwarding
intro: 'To simplify deploying to a server, you can set up SSH agent forwarding to securely use local SSH keys.'
redirect_from:
- /guides/using-ssh-agent-forwarding/
- /guides/using-ssh-agent-forwarding
- /v3/guides/using-ssh-agent-forwarding
versions:
fpt: '*'
@@ -11,50 +11,50 @@ versions:
ghec: '*'
topics:
- API
shortTitle: SSHエージェントのフォワーディング
shortTitle: SSH agent forwarding
---
SSHエージェント転送を使って、サーバーへのデプロイをシンプルにすることができます。 そうすることで、キーパスフレーズなしのをサーバー上に残さずに、ローカルのSSHキーを使用できます。
SSH agent forwarding can be used to make deploying to a server simple. It allows you to use your local SSH keys instead of leaving keys (without passphrases!) sitting on your server.
{% data variables.product.product_name %}とやりとりするためのSSHキーをセットアップ済みなら、`ssh-agent`には慣れていることでしょう。 これは、バックグラウンドで実行され、キーをメモリにロードした状態にし続けるので、キーを使うたびにパスフレーズを入力する必要がなくなります。 便利なのは、ローカルの`ssh-agent`がサーバー上で動作しているかのように、サーバーからローカルの`ssh-agent`にアクセスさせられることです。 これは、友人のコンピュータをあなたが使えるように、友人のパスワードを友人に入力してもらうように頼むようなものです。
If you've already set up an SSH key to interact with {% data variables.product.product_name %}, you're probably familiar with `ssh-agent`. It's a program that runs in the background and keeps your key loaded into memory, so that you don't need to enter your passphrase every time you need to use the key. The nifty thing is, you can choose to let servers access your local `ssh-agent` as if they were already running on the server. This is sort of like asking a friend to enter their password so that you can use their computer.
SSHエージェント転送に関するさらに詳細な説明については、[Steve Friedl's Tech Tips guide][tech-tips]をご覧ください。
Check out [Steve Friedl's Tech Tips guide][tech-tips] for a more detailed explanation of SSH agent forwarding.
## SSHエージェント転送のセットアップ
## Setting up SSH agent forwarding
SSHキーがセットアップされており、動作していることを確認してください。 まだ確認ができていないなら、[SSHキーの生成ガイド][generating-keys]を利用できます。
Ensure that your own SSH key is set up and working. You can use [our guide on generating SSH keys][generating-keys] if you've not done this yet.
ローカルのキーが動作しているかは、ターミナルで`ssh -T git@{% ifversion ghes or ghae %}hostname{% else %}github.com{% endif %}`と入力すればテストできます。
You can test that your local key works by entering `ssh -T git@{% ifversion ghes or ghae %}hostname{% else %}github.com{% endif %}` in the terminal:
```shell
$ ssh -T git@{% ifversion ghes or ghae %}hostname{% else %}github.com{% endif %}
# SSHでgithubに入る
# Attempt to SSH in to github
> Hi <em>username</em>! You've successfully authenticated, but GitHub does not provide
> shell access.
```
いいスタートを切ることができました。 サーバーへのエージェント転送ができるよう、SSHをセットアップしましょう。
We're off to a great start. Let's set up SSH to allow agent forwarding to your server.
1. 好きなテキストエディタで`~/.ssh/config`にあるファイルを開いてください。 もしこのファイルがなかったなら、ターミナルで`touch ~/.ssh/config`と入力すれば作成できます。
1. Using your favorite text editor, open up the file at `~/.ssh/config`. If this file doesn't exist, you can create it by entering `touch ~/.ssh/config` in the terminal.
2. Enter the following text into the file, replacing `example.com` with your server's domain name or IP:
2. `example.com`のところを使用するサーバーのドメイン名もしくはIPで置き換えて、以下のテキストをこのファイルに入力してください。
Host example.com
ForwardAgent yes
{% warning %}
**警告:** すべてのSSH接続のこの設定を適用するために、`Host *`のようなワイルドカードを使いたくなるかもしれません。 これはローカルのSSHキーをSSHで入る*すべての*サーバーと共有することになるので、実際には良い考えではありません。 キーに直接アクセスされることはないかもしれませんが、接続が確立されている間はそれらのキーが*あなたのかわりに*使われるかもしれません。 **追加するサーバーは、信用でき、エージェント転送で使おうとしているサーバーのみにすべきです。**
**Warning:** You may be tempted to use a wildcard like `Host *` to just apply this setting to all SSH connections. That's not really a good idea, as you'd be sharing your local SSH keys with *every* server you SSH into. They won't have direct access to the keys, but they will be able to use them *as you* while the connection is established. **You should only add servers you trust and that you intend to use with agent forwarding.**
{% endwarning %}
## SSHエージェント転送のテスト
## Testing SSH agent forwarding
エージェント転送がサーバーで動作しているかをテストするには、サーバーにSSHで入ってもう一度`ssh -T git@{% ifversion ghes or ghae %}hostname{% else %}github.com{% endif %}`と実行してみてください。 すべてうまくいっているなら、ローカルでやった場合と同じプロンプトが返ってくるでしょう。
To test that agent forwarding is working with your server, you can SSH into your server and run `ssh -T git@{% ifversion ghes or ghae %}hostname{% else %}github.com{% endif %}` once more. If all is well, you'll get back the same prompt as you did locally.
ローカルのキーが使われているか確信が持てない場合は、サーバー上で`SSH_AUTH_SOCK`変数を調べてみることもできます。
If you're unsure if your local key is being used, you can also inspect the `SSH_AUTH_SOCK` variable on your server:
```shell
$ echo "$SSH_AUTH_SOCK"
@@ -62,24 +62,24 @@ $ echo "$SSH_AUTH_SOCK"
> /tmp/ssh-4hNGMk8AZX/agent.79453
```
この変数が設定されていないなら、エージェント転送は動作していないということです。
If the variable is not set, it means that agent forwarding is not working:
```shell
$ echo "$SSH_AUTH_SOCK"
# SSH_AUTH_SOCK変数の出力
# Print out the SSH_AUTH_SOCK variable
> <em>[No output]</em>
$ ssh -T git@{% ifversion ghes or ghae %}hostname{% else %}github.com{% endif %}
# SSHでgithubに入る
# Try to SSH to github
> Permission denied (publickey).
```
## SSHエージェント転送のトラブルシューティング
## Troubleshooting SSH agent forwarding
以下は、SSHエージェント転送のトラブルシューティングの際に注意すべきことです。
Here are some things to look out for when troubleshooting SSH agent forwarding.
### コードをのチェックアウトにはSSH URLを使わなければならない
### You must be using an SSH URL to check out code
SSH転送はHTTP(s) URLでは動作せず、SSH URLでのみ動作します。 サーバー上の*.git/config*ファイルを調べて、URLが以下のようなSSHスタイルのURLになっていることを確認してください。
SSH forwarding only works with SSH URLs, not HTTP(s) URLs. Check the *.git/config* file on your server and ensure the URL is an SSH-style URL like below:
```shell
[remote "origin"]
@@ -87,18 +87,18 @@ SSH転送はHTTP(s) URLでは動作せず、SSH URLでのみ動作します。
fetch = +refs/heads/*:refs/remotes/origin/*
```
### SSHキーはローカルで動作していなければならない
### Your SSH keys must work locally
エージェント転送を通じてキーを動作させるには、まずキーがローカルで動作していなければなりません。 SSHキーをローカルでセットアップするには、[SSHキーの生成ガイド][generating-keys]が役に立つでしょう。
Before you can make your keys work through agent forwarding, they must work locally first. [Our guide on generating SSH keys][generating-keys] can help you set up your SSH keys locally.
### システムがSSHエージェント転送を許可していなければならない
### Your system must allow SSH agent forwarding
システム設定でSSHエージェント転送が許可されていないことがあります。 システム設定ファイルが使われているかは、ターミナルで以下のコマンドを入力してみればチェックできます。
Sometimes, system configurations disallow SSH agent forwarding. You can check if a system configuration file is being used by entering the following command in the terminal:
```shell
$ ssh -v <em>example.com</em>
# Connect to example.com with verbose debug output
> OpenSSH_5.6p1, OpenSSL 0.9.8r 8 Feb 2011</span>
> OpenSSH_8.1p1, LibreSSL 2.7.3</span>
> debug1: Reading configuration data /Users/<em>you</em>/.ssh/config
> debug1: Applying options for example.com
> debug1: Reading configuration data /etc/ssh_config
@@ -107,7 +107,7 @@ $ exit
# Returns to your local command prompt
```
上の例では、*~/.ssh/config*というファイルがまずロードされ、それから*/etc/ssh_config*が読まれます。 以下のコマンドを実行すれば、そのファイルが設定を上書きしているかを調べることができます。
In the example above, the file *~/.ssh/config* is loaded first, then */etc/ssh_config* is read. We can inspect that file to see if it's overriding our options by running the following commands:
```shell
$ cat /etc/ssh_config
@@ -117,17 +117,17 @@ $ cat /etc/ssh_config
> ForwardAgent no
```
この例では、*/etc/ssh_config*ファイルが`ForwardAgent no`と具体的に指定しており、これはエージェント転送をブロックするやり方です。 この行をファイルから削除すれば、エージェント転送は改めて動作するようになります。
In this example, our */etc/ssh_config* file specifically says `ForwardAgent no`, which is a way to block agent forwarding. Deleting this line from the file should get agent forwarding working once more.
### サーバーはインバウンド接続でSSHエージェント転送を許可していなければならない
### Your server must allow SSH agent forwarding on inbound connections
エージェント転送は、サーバーでブロックされているかもしれません。 エージェント転送が許可されているかは、サーバーにSSHで入り、`sshd_config`を実行してみれば確認できます。 このコマンドからの出力で、`AllowAgentForwarding`が設定されていることが示されていなければなりません。
Agent forwarding may also be blocked on your server. You can check that agent forwarding is permitted by SSHing into the server and running `sshd_config`. The output from this command should indicate that `AllowAgentForwarding` is set.
### ローカルの`ssh-agent`が動作していなければならない
### Your local `ssh-agent` must be running
ほとんどのコンピュータでは、オペレーティングシステムは自動的に`ssh-agent`を起動してくれます。 しかし、Windowsではこれを手動で行わなければなりません。 [Git Bashを開いたときに`ssh-agent`を起動する方法のガイド][autolaunch-ssh-agent]があります。
On most computers, the operating system automatically launches `ssh-agent` for you. On Windows, however, you need to do this manually. We have [a guide on how to start `ssh-agent` whenever you open Git Bash][autolaunch-ssh-agent].
コンピュータで`ssh-agent`が動作しているかを確認するには、ターミナルで以下のコマンドを入力してください。
To verify that `ssh-agent` is running on your computer, type the following command in the terminal:
```shell
$ echo "$SSH_AUTH_SOCK"
@@ -135,15 +135,15 @@ $ echo "$SSH_AUTH_SOCK"
> /tmp/launch-kNSlgU/Listeners
```
### キーが`ssh-agent`から利用可能でなければならない
### Your key must be available to `ssh-agent`
`ssh-agent`からキーが見えるかは、以下のコマンドを実行すれば確認できます。
You can check that your key is visible to `ssh-agent` by running the following command:
```shell
ssh-add -L
```
このコマンドが識別情報が利用できないと言ってきたなら、キーを追加しなければなりません。
If the command says that no identity is available, you'll need to add your key:
```shell
$ ssh-add <em>yourkey</em>
@@ -151,7 +151,7 @@ $ ssh-add <em>yourkey</em>
{% tip %}
macOSでは、再起動時に`ssh-agent`が起動し直されると、キーは「忘れられて」しまいます。 ただし、以下のコマンドでキーチェーンにSSHキーをインポートできます。
On macOS, `ssh-agent` will "forget" this key, once it gets restarted during reboots. But you can import your SSH keys into Keychain using this command:
```shell
$ ssh-add -K <em>yourkey</em>
@@ -161,4 +161,5 @@ $ ssh-add -K <em>yourkey</em>
[tech-tips]: http://www.unixwiz.net/techtips/ssh-agent-forwarding.html
[generating-keys]: /articles/generating-ssh-keys
[ssh-passphrases]: /ssh-key-passphrases/
[autolaunch-ssh-agent]: /github/authenticating-to-github/working-with-ssh-key-passphrases#auto-launching-ssh-agent-on-git-for-windows

View File

@@ -3,8 +3,8 @@ title: Webhook events and payloads
intro: 'For each webhook event, you can review when the event occurs, an example payload, and descriptions about the payload object parameters.'
product: '{% data reusables.gated-features.enterprise_account_webhooks %}'
redirect_from:
- /early-access/integrations/webhooks/
- /v3/activity/events/types/
- /early-access/integrations/webhooks
- /v3/activity/events/types
- /webhooks/event-payloads
- /developers/webhooks-and-events/webhook-events-and-payloads
versions:
@@ -1197,8 +1197,9 @@ Key | Type | Description
{% ifversion fpt or ghes or ghec %}
## security_advisory
Activity related to a security advisory. A security advisory provides information about security-related vulnerabilities in software on GitHub. The security advisory dataset also powers the GitHub security alerts, see "[About alerts for vulnerable dependencies](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies/)."
{% endif %}
Activity related to a security advisory that has been reviewed by {% data variables.product.company_short %}. A {% data variables.product.company_short %}-reviewed security advisory provides information about security-related vulnerabilities in software on {% data variables.product.prodname_dotcom %}.
The security advisory dataset also powers the GitHub {% data variables.product.prodname_dependabot_alerts %}. For more information, see "[About alerts for vulnerable dependencies](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies/)."
### Availability
@@ -1215,6 +1216,8 @@ Key | Type | Description
{{ webhookPayloadsForCurrentVersion.security_advisory.published }}
{% endif %}
{% ifversion fpt or ghec %}
## sponsorship

View File

@@ -37,6 +37,7 @@ featuredLinks:
- /github/getting-started-with-github/signing-up-for-a-new-github-account
- /get-started/quickstart/hello-world
- /github/getting-started-with-github/set-up-git
- /get-started/learning-about-github/about-versions-of-github-docs
- /github/getting-started-with-github/github-glossary
- /github/getting-started-with-github/fork-a-repo
- /github/getting-started-with-github/keyboard-shortcuts

View File

@@ -0,0 +1,56 @@
---
title: About versions of GitHub Docs
intro: "You can read documentation that reflects the {% data variables.product.company_short %} product you're currently using."
versions: '*'
shortTitle: Docs versions
---
## About versions of {% data variables.product.prodname_docs %}
{% data variables.product.company_short %} offers different products for storing and collaborating on code. The product you use determines which features are available to you. For more information, see "[{% data variables.product.company_short %}'s products](/get-started/learning-about-github/githubs-products)."
This website, {% data variables.product.prodname_docs %}, provides documentation for all of {% data variables.product.company_short %}'s products. If the content you're reading applies to more than one product, you can choose the version of the documentation that's relevant to you by selecting the product you're currently using.
At the top of a page on {% data variables.product.prodname_docs %}, select the dropdown menu and click a product. If your browser window is not wide enough to display the full navigation bar, you may need to click {% octicon "three-bars" aria-label="The three bars icon" %} first.
![Screenshot of the dropdown menu for picking a version of {% data variables.product.prodname_docs %} to view](/assets/images/help/docs/version-picker.png)
{% note %}
**Note**: You can try changing the version now. You're viewing {% ifversion ghes %}a{% else %}the{% endif %} {% ifversion fpt %}Free, Pro, & Team{% else %}{% data variables.product.product_name %}{% endif %} version of this article.
{% endnote %}
## Determining which {% data variables.product.company_short %} product you use
You can determine which {% data variables.product.company_short %} product you're currently using by reviewing the URL in the address bar of your browser and the heading for the {% data variables.product.prodname_dotcom %} website you're on.
You may use more than one {% data variables.product.company_short %} product. For example, you might contribute to open source on {% data variables.product.prodname_dotcom_the_website %} and collaborate on code on your employer's {% data variables.product.prodname_ghe_server %} instance. You may need to view different versions of the same article at different times, depending on the problem you're currently trying to solve.
### {% data variables.product.prodname_dotcom_the_website %} plans or {% data variables.product.prodname_ghe_cloud %}
If you access {% data variables.product.prodname_dotcom %} at https://github.com, you're either using the features of a Free, Pro, or Team plan, or you're using {% data variables.product.prodname_ghe_cloud %}.
In a wide browser window, there is no text that immediately follows the {% data variables.product.company_short %} logo on the left side of the header.
![Screenshot of the address bar and the {% data variables.product.prodname_dotcom_the_website %} header in a browser](/assets/images/help/docs/header-dotcom.png)
On {% data variables.product.prodname_dotcom_the_website %}, each account has its own plan. Each personal account has an associated plan that provides access to certain features, and each organization has a different associated plan. If your personal account is a member of an organization on {% data variables.product.prodname_dotcom_the_website %}, you may have access to different features when you use resources owned by that organization than when you use resources owned by your personal account. For more information, see "[Types of {% data variables.product.prodname_dotcom %} accounts](/get-started/learning-about-github/types-of-github-accounts)."
If you don't know whether an organization uses {% data variables.product.prodname_ghe_cloud %}, ask an organization owner. For more information, see "[Viewing people's roles in an organization](/account-and-profile/setting-up-and-managing-your-github-user-account/managing-your-membership-in-organizations/viewing-peoples-roles-in-an-organization)."
### {% data variables.product.prodname_ghe_server %}
If you access {% data variables.product.prodname_dotcom %} at a URL other than https://github.com, `https://*.githubenterprise.com`, `https://*.github.us`, or `https://*.ghe.com`, you're using {% data variables.product.prodname_ghe_server %}. For example, you may access {% data variables.product.prodname_ghe_server %} at `https://github.YOUR-COMPANY-NAME.com`. Your administrators may choose a URL that doesn't include the word "{% data variables.product.company_short %}."
In a wide browser window, the word "Enterprise" immediately follows the {% data variables.product.company_short %} logo on the left side of the header.
![Screenshot of address bar and {% data variables.product.prodname_ghe_server %} header in a browser](/assets/images/help/docs/header-ghes.png)
### {% data variables.product.prodname_ghe_managed %}
If you access {% data variables.product.prodname_dotcom %} at `https://*.githubenterprise.com`, `https://*.github.us`, or `https://*.ghe.com`, you're using {% data variables.product.prodname_ghe_managed %}.
In a wide browser window, the words "{% data variables.product.prodname_ghe_managed %}" immediately follow the {% data variables.product.company_short %} logo in the header.
![Address bar and {% data variables.product.prodname_ghe_managed %} header in a browser](/assets/images/help/docs/header-ghae.png)

View File

@@ -24,6 +24,8 @@ topics:
You can see pricing and a full list of features for each product at <{% data variables.product.pricing_url %}>. {% data reusables.products.product-roadmap %}
When you read {% data variables.product.prodname_docs %}, make sure to select the version that reflects your product. For more information, see "[About versions of {% data variables.product.prodname_docs %}](/get-started/learning-about-github/about-versions-of-github-docs)."
## {% data variables.product.prodname_free_user %} for user accounts
With {% data variables.product.prodname_free_team %} for user accounts, you can work with unlimited collaborators on unlimited public repositories with a full feature set, and on unlimited private repositories with a limited feature set.

View File

@@ -17,10 +17,11 @@ topics:
- Security
children:
- /githubs-products
- /about-versions-of-github-docs
- /github-language-support
- /about-github-advanced-security
- /types-of-github-accounts
- /access-permissions-on-github
- /about-github-advanced-security
- /faq-about-changes-to-githubs-plans
---

View File

@@ -16,13 +16,13 @@ You will first need to purchase {% data variables.product.product_name %}. For m
{% data reusables.github-ae.initialize-enterprise %}
### 2. Initializing {% data variables.product.product_name %}
After {% data variables.product.company_short %} creates the owner account for {% data variables.product.product_location %} on {% data variables.product.product_name %}, you will receive an email to sign in and complete the initialization. During initialization, you, as the enterprise owner, will name {% data variables.product.product_location %}, configure SAML SSO, create policies for all organizations in {% data variables.product.product_location %}, and configure a support contact for your enterprise members. 詳しい情報については、「[{% data variables.product.prodname_ghe_managed %} を初期化する](/admin/configuration/configuring-your-enterprise/initializing-github-ae)」を参照してください。
After {% data variables.product.company_short %} creates the owner account for {% data variables.product.product_location %} on {% data variables.product.product_name %}, you will receive an email to sign in and complete the initialization. During initialization, you, as the enterprise owner, will name {% data variables.product.product_location %}, configure SAML SSO, create policies for all organizations in {% data variables.product.product_location %}, and configure a support contact for your enterprise members. For more information, see "[Initializing {% data variables.product.prodname_ghe_managed %}](/admin/configuration/configuring-your-enterprise/initializing-github-ae)."
### 3. ネットワークトラフィックを制限する
You can configure an allow list for specific IP addresses to restrict access to assets owned by organizations in your enterprise account. 詳しい情報については、「[Enterprise へのネットワークトラフィックを制限する](/admin/configuration/configuring-your-enterprise/restricting-network-traffic-to-your-enterprise)」を参照してください。
### 3. Restricting network traffic
You can configure an allow list for specific IP addresses to restrict access to assets owned by organizations in your enterprise account. For more information, see "[Restricting network traffic to your enterprise](/admin/configuration/configuring-your-enterprise/restricting-network-traffic-to-your-enterprise)."
### 4. Managing identity and access for {% data variables.product.product_location %}
You can centrally manage access to {% data variables.product.product_location %} on {% data variables.product.product_name %} from an identity provider (IdP) using SAML single sign-on (SSO) for user authentication and System for Cross-domain Identity Management (SCIM) for user provisioning. Once you configure provisioning, you can assign or unassign users to the application from the IdP, creating or disabling user accounts in the enterprise. 詳しい情報については、「[Enterprise のアイデンティティとアクセス管理について](/admin/authentication/managing-identity-and-access-for-your-enterprise/about-identity-and-access-management-for-your-enterprise)」を参照してください。
You can centrally manage access to {% data variables.product.product_location %} on {% data variables.product.product_name %} from an identity provider (IdP) using SAML single sign-on (SSO) for user authentication and System for Cross-domain Identity Management (SCIM) for user provisioning. Once you configure provisioning, you can assign or unassign users to the application from the IdP, creating or disabling user accounts in the enterprise. For more information, see "[About identity and access management for your enterprise](/admin/authentication/managing-identity-and-access-for-your-enterprise/about-identity-and-access-management-for-your-enterprise)."
### 5. Managing billing for {% data variables.product.product_location %}
Owners of the subscription for {% data variables.product.product_location %} on {% data variables.product.product_name %} can view billing details for {% data variables.product.product_name %} in the Azure portal. For more information, see "[Managing billing for your enterprise](/admin/overview/managing-billing-for-your-enterprise)."
@@ -33,13 +33,13 @@ As an enterprise owner for {% data variables.product.product_name %}, you can ma
### 1. Managing members of {% data variables.product.product_location %}
{% data reusables.getting-started.managing-enterprise-members %}
### 2. Organizationの作成
### 2. Creating organizations
{% data reusables.getting-started.creating-organizations %}
### 3. Adding members to organizations
{% data reusables.getting-started.adding-members-to-organizations %}
### 4. Teamの作成
### 4. Creating teams
{% data reusables.getting-started.creating-teams %}
### 5. Setting organization and repository permission levels
@@ -68,13 +68,16 @@ You can customize and automate work in organizations in {% data variables.produc
For more information on enabling and configuring {% data variables.product.prodname_actions %} for {% data variables.product.product_name %}, see "[Getting started with {% data variables.product.prodname_actions %} for {% data variables.product.prodname_ghe_managed %}](/admin/github-actions/using-github-actions-in-github-ae/getting-started-with-github-actions-for-github-ae)."
### 3. {% data variables.product.prodname_pages %}を使用する
### 3. Using {% data variables.product.prodname_pages %}
{% data reusables.getting-started.github-pages-enterprise %}
## Part 5: Using {% data variables.product.prodname_dotcom %}'s learning and support resources
Your enterprise members can learn more about Git and {% data variables.product.prodname_dotcom %} with our learning resources, and you can get the support you need with {% data variables.product.prodname_dotcom %} Enterprise Support.
### 1. Learning with {% data variables.product.prodname_learning %}
### 1. Reading about {% data variables.product.product_name %} on {% data variables.product.prodname_docs %}
You can read documentation that reflects the features available with {% data variables.product.prodname_ghe_managed %}. For more information, see "[About versions of {% data variables.product.prodname_docs %}](/get-started/learning-about-github/about-versions-of-github-docs)."
### 2. Learning with {% data variables.product.prodname_learning %}
{% data reusables.getting-started.learning-lab-enterprise %}
### 2. Working with {% data variables.product.prodname_dotcom %} Enterprise Support
### 3. Working with {% data variables.product.prodname_dotcom %} Enterprise Support
{% data reusables.getting-started.contact-support-enterprise %}

View File

@@ -199,14 +199,18 @@ Members of your organization or enterprise can use tools from the {% data variab
## Part 7: Participating in {% data variables.product.prodname_dotcom %}'s community
Members of your organization or enterprise can use GitHub's learning and support resources to get the help they need. You can also support the open source community.
### 1. Learning with {% data variables.product.prodname_learning %}
### 1. Reading about {% data variables.product.prodname_ghe_cloud %} on {% data variables.product.prodname_docs %}
You can read documentation that reflects the features available with {% data variables.product.prodname_ghe_cloud %}. For more information, see "[About versions of {% data variables.product.prodname_docs %}](/get-started/learning-about-github/about-versions-of-github-docs)."
### 2. Learning with {% data variables.product.prodname_learning %}
Members of your organization or enterprise can learn new skills by completing fun, realistic projects in your very own GitHub repository with [{% data variables.product.prodname_learning %}](https://lab.github.com/). Each course is a hands-on lesson created by the GitHub community and taught by the friendly Learning Lab bot.
For more information, see "[Git and {% data variables.product.prodname_dotcom %} learning resources](/github/getting-started-with-github/quickstart/git-and-github-learning-resources)."
### 2. Supporting the open source community
### 3. Supporting the open source community
{% data reusables.getting-started.sponsors %}
### 3. Contacting {% data variables.contact.github_support %}
### 4. Contacting {% data variables.contact.github_support %}
{% data reusables.getting-started.contact-support %}
{% data variables.product.prodname_ghe_cloud %} allows you to submit priority support requests with a target eight-hour response time. For more information, see "[{% data variables.product.prodname_ghe_cloud %} support](/github/working-with-github-support/github-enterprise-cloud-support)."

View File

@@ -1,5 +1,5 @@
---
title: GitHub Enterprise Serverを使い始める
title: Getting started with GitHub Enterprise Server
intro: 'Get started with setting up and managing {% data variables.product.product_location %}.'
versions:
ghes: '*'
@@ -16,31 +16,31 @@ This guide will walk you through setting up, configuring and managing {% data va
For an overview of how {% data variables.product.product_name %} works, see "[System overview](/admin/overview/system-overview)."
## パート 1: {% data variables.product.product_name %} のインストール方法
To get started with {% data variables.product.product_name %}, you will need to create your enterprise account, install the instance, use the Management Console for initial setup, configure your instance, and manage billing.
## Part 1: Installing {% data variables.product.product_name %}
To get started with {% data variables.product.product_name %}, you will need to create your enterprise account, install the instance, use the Management Console for initial setup, configure your instance, and manage billing.
### 1. Creating your enterprise account
Before you install {% data variables.product.product_name %}, you can create an enterprise account on {% data variables.product.prodname_dotcom_the_website %} by contacting [{% data variables.product.prodname_dotcom %}'s Sales team](https://enterprise.github.com/contact). An enterprise account on {% data variables.product.prodname_dotcom_the_website %} is useful for billing and for shared features with {% data variables.product.prodname_dotcom_the_website %} via {% data variables.product.prodname_github_connect %}. 詳細は「[Enterprise アカウントについて](/admin/overview/about-enterprise-accounts)」を参照してください。
### 2. {% data variables.product.product_name %}のインストール
To get started with {% data variables.product.product_name %}, you will need to install the appliance on a virtualization platform of your choice. 詳細は「[{% data variables.product.prodname_ghe_server %}インスタンスをセットアップする](/admin/installation/setting-up-a-github-enterprise-server-instance)」を参照してください。
Before you install {% data variables.product.product_name %}, you can create an enterprise account on {% data variables.product.prodname_dotcom_the_website %} by contacting [{% data variables.product.prodname_dotcom %}'s Sales team](https://enterprise.github.com/contact). An enterprise account on {% data variables.product.prodname_dotcom_the_website %} is useful for billing and for shared features with {% data variables.product.prodname_dotcom_the_website %} via {% data variables.product.prodname_github_connect %}. For more information, see "[About enterprise accounts](/admin/overview/about-enterprise-accounts)."
### 2. Installing {% data variables.product.product_name %}
To get started with {% data variables.product.product_name %}, you will need to install the appliance on a virtualization platform of your choice. For more information, see "[Setting up a {% data variables.product.prodname_ghe_server %} instance](/admin/installation/setting-up-a-github-enterprise-server-instance)."
### 3. Using the Management Console
You will use the Management Console to walk through the initial setup process when first launching {% data variables.product.product_location %}. You can also use the Management Console to manage instance settings such as the license, domain, authentication, and TLS. For more information, see "[Accessing the management console](/admin/configuration/configuring-your-enterprise/accessing-the-management-console)."
### 4. {% data variables.product.product_location %} を設定する
### 4. Configuring {% data variables.product.product_location %}
In addition to the Management Console, you can use the site admin dashboard and the administrative shell (SSH) to manage {% data variables.product.product_location %}. For example, you can configure applications and rate limits, view reports, use command-line utilities. For more information, see "[Configuring your enterprise](/admin/configuration/configuring-your-enterprise)."
You can use the default network settings used by {% data variables.product.product_name %} via the dynamic host configuration protocol (DHCP), or you can also configure the network settings using the virtual machine console. プロキシサーバあるいはファイアウォールルールを設定することもできます。 For more information, see "[Configuring network settings](/admin/configuration/configuring-network-settings)."
You can use the default network settings used by {% data variables.product.product_name %} via the dynamic host configuration protocol (DHCP), or you can also configure the network settings using the virtual machine console. You can also configure a proxy server or firewall rules. For more information, see "[Configuring network settings](/admin/configuration/configuring-network-settings)."
### 5. High Availability の設定
### 5. Configuring high availability
You can configure {% data variables.product.product_location %} for high availability to minimize the impact of hardware failures and network outages. For more information, see "[Configuring high availability](/admin/enterprise-management/configuring-high-availability)."
### 6. ステージングインスタンスのセットアップ
You can set up a staging instance to test modifications, plan for disaster recovery, and try out updates before applying them to {% data variables.product.product_location %}. 詳しい情報については "[ステージングインスタンスのセットアップ](/admin/installation/setting-up-a-github-enterprise-server-instance/setting-up-a-staging-instance)"を参照してください。
### 6. Setting up a staging instance
You can set up a staging instance to test modifications, plan for disaster recovery, and try out updates before applying them to {% data variables.product.product_location %}. For more information, see "[Setting up a staging instance](/admin/installation/setting-up-a-github-enterprise-server-instance/setting-up-a-staging-instance)."
### 7. Designating backups and disaster recovery
To protect your production data, you can configure automated backups of {% data variables.product.product_location %} with {% data variables.product.prodname_enterprise_backup_utilities %}. 詳しくは、"[ アプライアンスでのバックアップの設定](/admin/configuration/configuring-your-enterprise/configuring-backups-on-your-appliance)。"を参照してください。
To protect your production data, you can configure automated backups of {% data variables.product.product_location %} with {% data variables.product.prodname_enterprise_backup_utilities %}. For more information, see "[Configuring backups on your appliance](/admin/configuration/configuring-your-enterprise/configuring-backups-on-your-appliance)."
### 8. Enterprise の支払いを管理する
### 8. Managing billing for your enterprise
Billing for all the organizations and {% data variables.product.product_name %} instances connected to your enterprise account is aggregated into a single bill charge for all of your paid {% data variables.product.prodname_dotcom %}.com services. Enterprise owners and billing managers can access and manage billing settings for enterprise accounts. For more information, see "[Managing billing for your enterprise](/admin/overview/managing-billing-for-your-enterprise)."
## Part 2: Organizing and managing your team
@@ -49,13 +49,13 @@ As an enterprise owner or administrator, you can manage settings on user, reposi
### 1. Managing members of {% data variables.product.product_location %}
{% data reusables.getting-started.managing-enterprise-members %}
### 2. Organizationの作成
### 2. Creating organizations
{% data reusables.getting-started.creating-organizations %}
### 3. Adding members to organizations
{% data reusables.getting-started.adding-members-to-organizations %}
### 4. Teamの作成
### 4. Creating teams
{% data reusables.getting-started.creating-teams %}
### 5. Setting organization and repository permission levels
@@ -88,7 +88,7 @@ You can upgrade your {% data variables.product.product_name %} license to includ
You can customize and automate work in organizations in your enterprise with {% data variables.product.prodname_dotcom %} and {% data variables.product.prodname_oauth_apps %}, {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API, {% data variables.product.prodname_actions %}, {% data variables.product.prodname_registry %} , and {% data variables.product.prodname_pages %}.
### 1. Building {% data variables.product.prodname_github_apps %} and {% data variables.product.prodname_oauth_apps %}
You can build integrations with the {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API, such as {% data variables.product.prodname_github_apps %} or {% data variables.product.prodname_oauth_apps %}, for use in organizations in your enterprise to complement and extend your workflows. 詳しい情報については「[アプリケーションについて](/developers/apps/getting-started-with-apps/about-apps)」を参照してください。
You can build integrations with the {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API, such as {% data variables.product.prodname_github_apps %} or {% data variables.product.prodname_oauth_apps %}, for use in organizations in your enterprise to complement and extend your workflows. For more information, see "[About apps](/developers/apps/getting-started-with-apps/about-apps)."
### 2. Using the {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API
{% data reusables.getting-started.api %}
@@ -98,23 +98,29 @@ You can build integrations with the {% ifversion fpt or ghec %}{% data variables
For more information on enabling and configuring {% data variables.product.prodname_actions %} on {% data variables.product.product_name %}, see "[Getting started with {% data variables.product.prodname_actions %} for {% data variables.product.prodname_ghe_server %}](/admin/github-actions/enabling-github-actions-for-github-enterprise-server/getting-started-with-github-actions-for-github-enterprise-server)."
### 4. Publishing and managing {% data variables.product.prodname_registry %}
### 4. Publishing and managing {% data variables.product.prodname_registry %}
{% data reusables.getting-started.packages %}
For more information on enabling and configuring {% data variables.product.prodname_registry %} for {% data variables.product.product_location %}, see "[Getting started with {% data variables.product.prodname_registry %} for your enterprise](/admin/packages/getting-started-with-github-packages-for-your-enterprise)."
{% endif %}
### 5. {% data variables.product.prodname_pages %}を使用する
### 5. Using {% data variables.product.prodname_pages %}
{% data reusables.getting-started.github-pages-enterprise %}
## Part 5: Connecting with other {% data variables.product.prodname_dotcom %} resources
You can use {% data variables.product.prodname_github_connect %} to share resources.
If you are the owner of both a {% data variables.product.product_name %} instance and a {% data variables.product.prodname_ghe_cloud %} organization or enterprise account, you can enable {% data variables.product.prodname_github_connect %}. {% data variables.product.prodname_github_connect %} allows you to share specific workflows and features between {% data variables.product.product_location %} and {% data variables.product.prodname_ghe_cloud %}, such as unified search and contributions. 詳細は、「[{% data variables.product.prodname_ghe_server %}{% data variables.product.prodname_ghe_cloud %}に接続する](/admin/configuration/managing-connections-between-github-enterprise-server-and-github-enterprise-cloud/connecting-github-enterprise-server-to-github-enterprise-cloud)」を参照してください。
If you are the owner of both a {% data variables.product.product_name %} instance and a {% data variables.product.prodname_ghe_cloud %} organization or enterprise account, you can enable {% data variables.product.prodname_github_connect %}. {% data variables.product.prodname_github_connect %} allows you to share specific workflows and features between {% data variables.product.product_location %} and {% data variables.product.prodname_ghe_cloud %}, such as unified search and contributions. For more information, see "[Connecting {% data variables.product.prodname_ghe_server %} to {% data variables.product.prodname_ghe_cloud %}](/admin/configuration/managing-connections-between-github-enterprise-server-and-github-enterprise-cloud/connecting-github-enterprise-server-to-github-enterprise-cloud)."
## Part 6: Using {% data variables.product.prodname_dotcom %}'s learning and support resources
Your enterprise members can learn more about Git and {% data variables.product.prodname_dotcom %} with our learning resources, and you can get the support you need when setting up and managing {% data variables.product.product_location %} with {% data variables.product.prodname_dotcom %} Enterprise Support.
### 1. Learning with {% data variables.product.prodname_learning %}
### 1. Reading about {% data variables.product.product_name %} on {% data variables.product.prodname_docs %}
You can read documentation that reflects the features available with {% data variables.product.prodname_ghe_server %}. For more information, see "[About versions of {% data variables.product.prodname_docs %}](/get-started/learning-about-github/about-versions-of-github-docs)."
### 2. Learning with {% data variables.product.prodname_learning %}
{% data reusables.getting-started.learning-lab-enterprise %}
### 2. Working with {% data variables.product.prodname_dotcom %} Enterprise Support
### 3. Working with {% data variables.product.prodname_dotcom %} Enterprise Support
{% data reusables.getting-started.contact-support-enterprise %}

View File

@@ -10,16 +10,16 @@ This guide will walk you through setting up, configuring and managing your {% da
## Part 1: Configuring your account on {% data variables.product.product_location %}
As the first steps in starting with {% data variables.product.prodname_team %}, you will need to create a user account or log into your existing account on {% data variables.product.prodname_dotcom %}, create an organization, and set up billing.
### 1. Organizationについて
Organizationは、企業やオープンソースプロジェクトが多くのプロジェクトにわたって一度にコラボレーションできる共有アカウントです。 オーナーと管理者は、Organizationのデータとプロジェクトへのメンバーのアクセスを、洗練されたセキュリティ及び管理機能で管理できます。 For more information on the features of organizations, see "[About organizations](/organizations/collaborating-with-groups-in-organizations/about-organizations#terms-of-service-and-data-protection-for-organizations)."
### 1. About organizations
Organizations are shared accounts where businesses and open-source projects can collaborate across many projects at once. Owners and administrators can manage member access to the organization's data and projects with sophisticated security and administrative features. For more information on the features of organizations, see "[About organizations](/organizations/collaborating-with-groups-in-organizations/about-organizations#terms-of-service-and-data-protection-for-organizations)."
### 2. Creating an organization and signing up for {% data variables.product.prodname_team %}
Before creating an organization, you will need to create a user account or log in to your existing account on {% data variables.product.product_location %}. 詳しい情報については、「[新しい {% data variables.product.prodname_dotcom %} アカウントにサインアップする](/get-started/signing-up-for-github/signing-up-for-a-new-github-account)」を参照してください。
Before creating an organization, you will need to create a user account or log in to your existing account on {% data variables.product.product_location %}. For more information, see "[Signing up for a new {% data variables.product.prodname_dotcom %} account](/get-started/signing-up-for-github/signing-up-for-a-new-github-account)."
Once your user account is set up, you can create an organization and pick a plan. This is where you can choose a {% data variables.product.prodname_team %} subscription for your organization. 詳しい情報については、「[新しい Organization をゼロから作成する](/organizations/collaborating-with-groups-in-organizations/creating-a-new-organization-from-scratch)」を参照してください。
Once your user account is set up, you can create an organization and pick a plan. This is where you can choose a {% data variables.product.prodname_team %} subscription for your organization. For more information, see "[Creating a new organization from scratch](/organizations/collaborating-with-groups-in-organizations/creating-a-new-organization-from-scratch)."
### 3. Managing billing for an organization
You must manage billing settings, payment method, and paid features and products for each of your personal accounts and organizations separately. You can switch between settings for your different accounts using the context switcher in your settings. 詳しい情報については「[様々なアカウントの設定の切り替え](/billing/managing-your-github-billing-settings/about-billing-on-github#switching-between-settings-for-your-different-accounts)」を参照してください。
You must manage billing settings, payment method, and paid features and products for each of your personal accounts and organizations separately. You can switch between settings for your different accounts using the context switcher in your settings. For more information, see "[Switching between settings for your different accounts](/billing/managing-your-github-billing-settings/about-billing-on-github#switching-between-settings-for-your-different-accounts)."
Your organization's billing settings page allows you to manage settings like your payment method, billing cycle and billing email, or view information such as your subscription, billing date and payment history. You can also view and upgrade your storage and GitHub Actions minutes. For more information on managing your billing settings, see "[Managing your {% data variables.product.prodname_dotcom %} billing settings](/billing/managing-your-github-billing-settings)."
@@ -64,7 +64,7 @@ You can help to make your organization more secure by recommending or requiring
## Part 5: Customizing and automating your work on {% data variables.product.product_name %}
{% data reusables.getting-started.customizing-and-automating %}
### 1. {% data variables.product.prodname_marketplace %}を使用する
### 1. Using {% data variables.product.prodname_marketplace %}
{% data reusables.getting-started.marketplace %}
### 2. Using the {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API
{% data reusables.getting-started.api %}
@@ -72,7 +72,7 @@ You can help to make your organization more secure by recommending or requiring
### 3. Building {% data variables.product.prodname_actions %}
{% data reusables.getting-started.actions %}
### 4. Publishing and managing {% data variables.product.prodname_registry %}
### 4. Publishing and managing {% data variables.product.prodname_registry %}
{% data reusables.getting-started.packages %}
## Part 6: Participating in {% data variables.product.prodname_dotcom %}'s community
@@ -83,14 +83,17 @@ You can help to make your organization more secure by recommending or requiring
### 2. Interacting with the {% data variables.product.prodname_gcf %}
{% data reusables.support.ask-and-answer-forum %}
### 3. Learning with {% data variables.product.prodname_learning %}
### 3. Reading about {% data variables.product.prodname_team %} on {% data variables.product.prodname_docs %}
You can read documentation that reflects the features available with {% data variables.product.prodname_team %}. For more information, see "[About versions of {% data variables.product.prodname_docs %}](/get-started/learning-about-github/about-versions-of-github-docs)."
### 4. Learning with {% data variables.product.prodname_learning %}
{% data reusables.getting-started.learning-lab %}
### 4. Supporting the open source community
### 5. Supporting the open source community
{% data reusables.getting-started.sponsors %}
### 5. {% data variables.contact.github_support %} への連絡
### 6. Contacting {% data variables.contact.github_support %}
{% data reusables.getting-started.contact-support %}
## 参考リンク
## Further reading
- "[Getting started with your GitHub account](/get-started/onboarding/getting-started-with-your-github-account)"

View File

@@ -23,18 +23,18 @@ The first steps in starting with {% data variables.product.product_name %} are t
{% ifversion fpt or ghec %}There are several types of accounts on {% data variables.product.prodname_dotcom %}. {% endif %} Every person who uses {% data variables.product.product_name %} has their own user account, which can be part of multiple organizations and teams. Your user account is your identity on {% data variables.product.product_location %} and represents you as an individual.
{% ifversion fpt or ghec %}
### 1. アカウントを作成する
### 1. Creating an account
To sign up for an account on {% data variables.product.product_location %}, navigate to https://github.com/ and follow the prompts.
To keep your {% data variables.product.prodname_dotcom %} account secure you should use a strong and unique password. 詳しい情報については、「[強力なパスワードを作成する](/github/authenticating-to-github/keeping-your-account-and-data-secure/creating-a-strong-password)」を参照してください。
To keep your {% data variables.product.prodname_dotcom %} account secure you should use a strong and unique password. For more information, see "[Creating a strong password](/github/authenticating-to-github/keeping-your-account-and-data-secure/creating-a-strong-password)."
### 2. Choosing your {% data variables.product.prodname_dotcom %} product
You can choose {% data variables.product.prodname_free_user %} or {% data variables.product.prodname_pro %} to get access to different features for your personal account. You can upgrade at any time if you are unsure at first which product you want.
For more information on all of {% data variables.product.prodname_dotcom %}'s plans, see "[{% data variables.product.prodname_dotcom %}'s products](/get-started/learning-about-github/githubs-products)."
### 3. メールアドレスを検証する
To ensure you can use all the features in your {% data variables.product.product_name %} plan, verify your email address after signing up for a new account. 詳細は「[メールアドレスを検証する](/github/getting-started-with-github/signing-up-for-github/verifying-your-email-address)」を参照してください。
### 3. Verifying your email address
To ensure you can use all the features in your {% data variables.product.product_name %} plan, verify your email address after signing up for a new account. For more information, see "[Verifying your email address](/github/getting-started-with-github/signing-up-for-github/verifying-your-email-address)."
{% endif %}
{% ifversion ghes %}
@@ -49,20 +49,20 @@ You will receive an email notification once your enterprise owner for {% data va
{% ifversion fpt or ghes or ghec %}
### {% ifversion fpt or ghec %}4.{% else %}2.{% endif %} Configuring two-factor authentication
2 要素認証、あるいは 2FA は、Web サイトあるいはアプリケーションにログインする際に使われる追加のセキュリティレイヤーです。 We strongly urge you to configure 2FA for the safety of your account. 詳しい情報については「[2 要素認証について](/github/authenticating-to-github/securing-your-account-with-two-factor-authentication-2fa/about-two-factor-authentication)」を参照してください。
Two-factor authentication, or 2FA, is an extra layer of security used when logging into websites or apps. We strongly urge you to configure 2FA for the safety of your account. For more information, see "[About two-factor authentication](/github/authenticating-to-github/securing-your-account-with-two-factor-authentication-2fa/about-two-factor-authentication)."
{% endif %}
### {% ifversion fpt or ghec %}5.{% elsif ghes %}3.{% else %}2.{% endif %} Viewing your {% data variables.product.prodname_dotcom %} profile and contribution graph
Your {% data variables.product.prodname_dotcom %} profile tells people the story of your work through the repositories and gists you've pinned, the organization memberships you've chosen to publicize, the contributions you've made, and the projects you've created. For more information, see "[About your profile](/github/setting-up-and-managing-your-github-profile/customizing-your-profile/about-your-profile)" and "[Viewing contributions on your profile](/github/setting-up-and-managing-your-github-profile/managing-contribution-graphs-on-your-profile/viewing-contributions-on-your-profile)."
## Part 2: Using {% data variables.product.product_name %}'s tools and processes
To best use {% data variables.product.product_name %}, you'll need to set up Git. Git は、{% data variables.product.prodname_dotcom %} に関連してローカルコンピュータで発生するすべての動作の根本を担っています。 To effectively collaborate on {% data variables.product.product_name %}, you'll write in issues and pull requests using {% data variables.product.prodname_dotcom %} Flavored Markdown.
To best use {% data variables.product.product_name %}, you'll need to set up Git. Git is responsible for everything {% data variables.product.prodname_dotcom %}-related that happens locally on your computer. To effectively collaborate on {% data variables.product.product_name %}, you'll write in issues and pull requests using {% data variables.product.prodname_dotcom %} Flavored Markdown.
### 1. Learning Git
{% data variables.product.prodname_dotcom %}'s collaborative approach to development depends on publishing commits from your local repository to {% data variables.product.product_name %} for other people to view, fetch, and update using Git. For more information about Git, see the "[Git Handbook](https://guides.github.com/introduction/git-handbook/)" guide. For more information about how Git is used on {% data variables.product.product_name %}, see "[{% data variables.product.prodname_dotcom %} flow](/get-started/quickstart/github-flow)."
### 2. Git をセットアップする
If you plan to use Git locally on your computer, whether through the command line, an IDE or text editor, you will need to install and set up Git. 詳細は「[Git のセットアップ](/get-started/quickstart/set-up-git)」を参照してください。を参照してください。
### 2. Setting up Git
If you plan to use Git locally on your computer, whether through the command line, an IDE or text editor, you will need to install and set up Git. For more information, see "[Set up Git](/get-started/quickstart/set-up-git)."
If you prefer to use a visual interface, you can download and use {% data variables.product.prodname_desktop %}. {% data variables.product.prodname_desktop %} comes packaged with Git, so there is no need to install Git separately. 詳細は「[{% data variables.product.prodname_desktop %} を使ってみる](/desktop/installing-and-configuring-github-desktop/overview/getting-started-with-github-desktop)」を参照してください。
If you prefer to use a visual interface, you can download and use {% data variables.product.prodname_desktop %}. {% data variables.product.prodname_desktop %} comes packaged with Git, so there is no need to install Git separately. For more information, see "[Getting started with {% data variables.product.prodname_desktop %}](/desktop/installing-and-configuring-github-desktop/overview/getting-started-with-github-desktop)."
Once you install Git, you can connect to {% data variables.product.product_name %} repositories from your local computer, whether your own repository or another user's fork. When you connect to a repository on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %} from Git, you'll need to authenticate with {% data variables.product.product_name %} using either HTTPS or SSH. For more information, see "[About remote repositories](/get-started/getting-started-with-git/about-remote-repositories)."
@@ -71,15 +71,15 @@ Everyone has their own unique workflow for interacting with {% data variables.pr
For more information about how to authenticate to {% data variables.product.product_name %} with each of these methods, see "[About authentication to {% data variables.product.prodname_dotcom %}](/github/authenticating-to-github/keeping-your-account-and-data-secure/about-authentication-to-github)."
| **方法** | **説明** | **Use cases** |
| ------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Browse to {% data variables.product.prodname_dotcom_the_website %} | If you don't need to work with files locally, {% data variables.product.product_name %} lets you complete most Git-related actions directly in the browser, from creating and forking repositories to editing files and opening pull requests. | This method is useful if you want a visual interface and need to do quick, simple changes that don't require working locally. |
| {% data variables.product.prodname_desktop %} | {% data variables.product.prodname_desktop %} は、コマンドライン上でテキストコマンドを使うのではなく、ビジュアルインターフェースを使って、あなたの {% data variables.product.prodname_dotcom_the_website %} ワークフローを拡張し簡略化します。 For more information on getting started with {% data variables.product.prodname_desktop %}, see "[Getting started with {% data variables.product.prodname_desktop %}](/desktop/installing-and-configuring-github-desktop/overview/getting-started-with-github-desktop)." | This method is best if you need or want to work with files locally, but prefer using a visual interface to use Git and interact with {% data variables.product.product_name %}. |
| IDE or text editor | You can set a default text editor, like [Atom](https://atom.io/) or [Visual Studio Code](https://code.visualstudio.com/) to open and edit your files with Git, use extensions, and view the project structure. For more information, see "[Associating text editors with Git](/github/using-git/associating-text-editors-with-git)." | This is convenient if you are working with more complex files and projects and want everything in one place, since text editors or IDEs often allow you to directly access the command line in the editor. |
| Command line, with or without {% data variables.product.prodname_cli %} | For the most granular control and customization of how you use Git and interact with {% data variables.product.product_name %}, you can use the command line. For more information on using Git commands, see "[Git cheatsheet](/github/getting-started-with-github/quickstart/git-cheatsheet)."<br/><br/> {% data variables.product.prodname_cli %} is a separate command-line tool you can install that brings pull requests, issues, {% data variables.product.prodname_actions %}, and other {% data variables.product.prodname_dotcom %} features to your terminal, so you can do all your work in one place. For more information, see "[{% data variables.product.prodname_cli %}](/github/getting-started-with-github/using-github/github-cli)." | This is most convenient if you are already working from the command line, allowing you to avoid switching context, or if you are more comfortable using the command line. |
| {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API | {% data variables.product.prodname_dotcom %} has a REST API and GraphQL API that you can use to interact with {% data variables.product.product_name %}. For more information, see "[Getting started with the API](/github/extending-github/getting-started-with-the-api)." | The {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API would be most helpful if you wanted to automate common tasks, back up your data, or create integrations that extend {% data variables.product.prodname_dotcom %}. |
| **Method** | **Description** | **Use cases** |
| ------------- | ------------- | ------------- |
| Browse to {% data variables.product.prodname_dotcom_the_website %} | If you don't need to work with files locally, {% data variables.product.product_name %} lets you complete most Git-related actions directly in the browser, from creating and forking repositories to editing files and opening pull requests.| This method is useful if you want a visual interface and need to do quick, simple changes that don't require working locally. |
| {% data variables.product.prodname_desktop %} | {% data variables.product.prodname_desktop %} extends and simplifies your {% data variables.product.prodname_dotcom_the_website %} workflow, using a visual interface instead of text commands on the command line. For more information on getting started with {% data variables.product.prodname_desktop %}, see "[Getting started with {% data variables.product.prodname_desktop %}](/desktop/installing-and-configuring-github-desktop/overview/getting-started-with-github-desktop)." | This method is best if you need or want to work with files locally, but prefer using a visual interface to use Git and interact with {% data variables.product.product_name %}. |
| IDE or text editor | You can set a default text editor, like [Atom](https://atom.io/) or [Visual Studio Code](https://code.visualstudio.com/) to open and edit your files with Git, use extensions, and view the project structure. For more information, see "[Associating text editors with Git](/github/using-git/associating-text-editors-with-git)." | This is convenient if you are working with more complex files and projects and want everything in one place, since text editors or IDEs often allow you to directly access the command line in the editor. |
| Command line, with or without {% data variables.product.prodname_cli %} | For the most granular control and customization of how you use Git and interact with {% data variables.product.product_name %}, you can use the command line. For more information on using Git commands, see "[Git cheatsheet](/github/getting-started-with-github/quickstart/git-cheatsheet)."<br/><br/> {% data variables.product.prodname_cli %} is a separate command-line tool you can install that brings pull requests, issues, {% data variables.product.prodname_actions %}, and other {% data variables.product.prodname_dotcom %} features to your terminal, so you can do all your work in one place. For more information, see "[{% data variables.product.prodname_cli %}](/github/getting-started-with-github/using-github/github-cli)." | This is most convenient if you are already working from the command line, allowing you to avoid switching context, or if you are more comfortable using the command line. |
| {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API | {% data variables.product.prodname_dotcom %} has a REST API and GraphQL API that you can use to interact with {% data variables.product.product_name %}. For more information, see "[Getting started with the API](/github/extending-github/getting-started-with-the-api)." | The {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API would be most helpful if you wanted to automate common tasks, back up your data, or create integrations that extend {% data variables.product.prodname_dotcom %}. |
### 4. Writing on {% data variables.product.product_name %}
To make your communication clear and organized in issues and pull requests, you can use {% data variables.product.prodname_dotcom %} Flavored Markdown for formatting, which combines an easy-to-read, easy-to-write syntax with some custom functionality. 詳しい情報については、「[{% data variables.product.prodname_dotcom %}での執筆とフォーマットについて](/github/writing-on-github/about-writing-and-formatting-on-github)」を参照してください。
To make your communication clear and organized in issues and pull requests, you can use {% data variables.product.prodname_dotcom %} Flavored Markdown for formatting, which combines an easy-to-read, easy-to-write syntax with some custom functionality. For more information, see "[About writing and formatting on {% data variables.product.prodname_dotcom %}](/github/writing-on-github/about-writing-and-formatting-on-github)."
You can learn {% data variables.product.prodname_dotcom %} Flavored Markdown with the "[Communicating using Markdown](https://lab.github.com/githubtraining/communicating-using-markdown)" course on {% data variables.product.prodname_learning %}.
@@ -96,56 +96,56 @@ Any number of people can work together in repositories across {% data variables.
### 1. Working with repositories
#### リポジトリを作成する
リポジトリは、プロジェクトのフォルダーのようなものです。 You can have any number of public and private repositories in your user account. Repositories can contain folders and files, images, videos, spreadsheets, and data sets, as well as the revision history for all files in the repository. For more information, see "[About repositories](/github/creating-cloning-and-archiving-repositories/about-repositories)."
#### Creating a repository
A repository is like a folder for your project. You can have any number of public and private repositories in your user account. Repositories can contain folders and files, images, videos, spreadsheets, and data sets, as well as the revision history for all files in the repository. For more information, see "[About repositories](/github/creating-cloning-and-archiving-repositories/about-repositories)."
When you create a new repository, you should initialize the repository with a README file to let people know about your project. 詳しい情報については「[新しいリポジトリの作成](/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/creating-a-new-repository)」を参照してください。
When you create a new repository, you should initialize the repository with a README file to let people know about your project. For more information, see "[Creating a new repository](/github/creating-cloning-and-archiving-repositories/creating-a-repository-on-github/creating-a-new-repository)."
#### リポジトリをクローンする
You can clone an existing repository from {% data variables.product.product_name %} to your local computer, making it easier to add or remove files, fix merge conflicts, or make complex commits. リポジトリをクローンすると、その時点で {% data variables.product.prodname_dotcom %} にあるすべてのリポジトリデータの完全なコピーがプルダウンされます。これには、プロジェクトのすべてのファイルとフォルダのすべてのバージョンも含まれます。 詳しい情報については[リポジトリのクローン](/github/creating-cloning-and-archiving-repositories/cloning-a-repository-from-github/cloning-a-repository)を参照してください。
#### Cloning a repository
You can clone an existing repository from {% data variables.product.product_name %} to your local computer, making it easier to add or remove files, fix merge conflicts, or make complex commits. Cloning a repository pulls down a full copy of all the repository data that {% data variables.product.prodname_dotcom %} has at that point in time, including all versions of every file and folder for the project. For more information, see "[Cloning a repository](/github/creating-cloning-and-archiving-repositories/cloning-a-repository-from-github/cloning-a-repository)."
#### リポジトリをフォークする
A fork is a copy of a repository that you manage, where any changes you make will not affect the original repository unless you submit a pull request to the project owner. 一般的にフォークは、他のユーザのプロジェクトへの変更を提案するため、あるいは他のユーザのプロジェクトを自分のアイディアの出発点として活用するために使用します。 For more information, see "[Working with forks](/github/collaborating-with-pull-requests/working-with-forks)."
### 2. プロジェクトのインポート
#### Forking a repository
A fork is a copy of a repository that you manage, where any changes you make will not affect the original repository unless you submit a pull request to the project owner. Most commonly, forks are used to either propose changes to someone else's project or to use someone else's project as a starting point for your own idea. For more information, see "[Working with forks](/github/collaborating-with-pull-requests/working-with-forks)."
### 2. Importing your projects
If you have existing projects you'd like to move over to {% data variables.product.product_name %} you can import projects using the {% data variables.product.prodname_dotcom %} Importer, the command line, or external migration tools. For more information, see "[Importing source code to {% data variables.product.prodname_dotcom %}](/github/importing-your-projects-to-github/importing-source-code-to-github)."
### 3. Managing collaborators and permissions
リポジトリの Issue、プルリクエスト、プロジェクトボードを使ってプロジェクトで他者とコラボレーションできます。 You can invite other people to your repository as collaborators from the **Collaborators** tab in the repository settings. 詳しい情報については、「[コラボレータを個人リポジトリに招待する](/github/setting-up-and-managing-your-github-user-account/managing-access-to-your-personal-repositories/inviting-collaborators-to-a-personal-repository)」を参照してください。
You can collaborate on your project with others using your repository's issues, pull requests, and project boards. You can invite other people to your repository as collaborators from the **Collaborators** tab in the repository settings. For more information, see "[Inviting collaborators to a personal repository](/github/setting-up-and-managing-your-github-user-account/managing-access-to-your-personal-repositories/inviting-collaborators-to-a-personal-repository)."
You are the owner of any repository you create in your user account and have full control of the repository. Collaborators have write access to your repository, limiting what they have permission to do. 詳しい情報については[ユーザアカウントのリポジトリ権限レベル](/github/setting-up-and-managing-your-github-user-account/managing-user-account-settings/permission-levels-for-a-user-account-repository)を参照してください。
You are the owner of any repository you create in your user account and have full control of the repository. Collaborators have write access to your repository, limiting what they have permission to do. For more information, see "[Permission levels for a user account repository](/github/setting-up-and-managing-your-github-user-account/managing-user-account-settings/permission-levels-for-a-user-account-repository)."
### 4. リポジトリ設定を管理する
As the owner of a repository you can configure several settings, including the repository's visibility, topics, and social media preview. 詳しい情報については、「[リポジトリ設定を管理する](/github/administering-a-repository/managing-repository-settings)」を参照してください。
### 4. Managing repository settings
As the owner of a repository you can configure several settings, including the repository's visibility, topics, and social media preview. For more information, see "[Managing repository settings](/github/administering-a-repository/managing-repository-settings)."
### 5. 健全なコントリビューションを促すプロジェクトをセットアップする
### 5. Setting up your project for healthy contributions
{% ifversion fpt or ghec %}
To encourage collaborators in your repository, you need a community that encourages people to use, contribute to, and evangelize your project. For more information, see "[Building Welcoming Communities](https://opensource.guide/building-community/)" in the Open Source Guides.
By adding files like contributing guidelines, a code of conduct, and a license to your repository you can create an environment where it's easier for collaborators to make meaningful, useful contributions. 詳しい情報については、「[健全なコントリビューションを促すプロジェクトをセットアップする](/communities/setting-up-your-project-for-healthy-contributions)」を参照してください。
By adding files like contributing guidelines, a code of conduct, and a license to your repository you can create an environment where it's easier for collaborators to make meaningful, useful contributions. For more information, see "[Setting up your project for healthy contributions](/communities/setting-up-your-project-for-healthy-contributions)."
{% endif %}
{% ifversion ghes or ghae %}
By adding files like contributing guidelines, a code of conduct, and support resources to your repository you can create an environment where it's easier for collaborators to make meaningful, useful contributions. 詳しい情報については、「[健全なコントリビューションを促すプロジェクトをセットアップする](/communities/setting-up-your-project-for-healthy-contributions)」を参照してください。
By adding files like contributing guidelines, a code of conduct, and support resources to your repository you can create an environment where it's easier for collaborators to make meaningful, useful contributions. For more information, see "[Setting up your project for healthy contributions](/communities/setting-up-your-project-for-healthy-contributions)."
{% endif %}
### 6. Using GitHub Issues and project boards
You can use GitHub Issues to organize your work with issues and pull requests and manage your workflow with project boards. For more information, see "[About issues](/issues/tracking-your-work-with-issues/about-issues)" and "[About project boards](/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)."
### 7. Managing notifications
Notifications provide updates about the activity on {% data variables.product.prodname_dotcom %} you've subscribed to or participated in. 会話に関心がなくなった場合は、今後受信する通知の種類を、サブスクライブ解除、Watch 解除、またはカスタマイズできます。 詳しい情報については、「[通知について](/github/managing-subscriptions-and-notifications-on-github/setting-up-notifications/about-notifications)」を参照してください。
Notifications provide updates about the activity on {% data variables.product.prodname_dotcom %} you've subscribed to or participated in. If you're no longer interested in a conversation, you can unsubscribe, unwatch, or customize the types of notifications you'll receive in the future. For more information, see "[About notifications](/github/managing-subscriptions-and-notifications-on-github/setting-up-notifications/about-notifications)."
### 8. {% data variables.product.prodname_pages %} の活用
### 8. Working with {% data variables.product.prodname_pages %}
You can use {% data variables.product.prodname_pages %} to create and host a website directly from a repository on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %}. For more information, see "[About {% data variables.product.prodname_pages %}](/pages/getting-started-with-github-pages/about-github-pages)."
{% ifversion fpt or ghec %}
### 9. {% data variables.product.prodname_discussions %}を使用する
You can enable {% data variables.product.prodname_discussions %} for your repository to help build a community around your project. Maintainers, contributors and visitors can use discussions to share announcements, ask and answer questions, and participate in conversations around goals. 詳しい情報については「[ディスカッションについて](/discussions/collaborating-with-your-community-using-discussions/about-discussions)」を参照してください。
### 9. Using {% data variables.product.prodname_discussions %}
You can enable {% data variables.product.prodname_discussions %} for your repository to help build a community around your project. Maintainers, contributors and visitors can use discussions to share announcements, ask and answer questions, and participate in conversations around goals. For more information, see "[About discussions](/discussions/collaborating-with-your-community-using-discussions/about-discussions)."
{% endif %}
## Part 4: Customizing and automating your work on {% data variables.product.product_name %}
{% data reusables.getting-started.customizing-and-automating %}
{% ifversion fpt or ghec %}
### 1. {% data variables.product.prodname_marketplace %}を使用する
### 1. Using {% data variables.product.prodname_marketplace %}
{% data reusables.getting-started.marketplace %}
{% endif %}
### {% ifversion fpt or ghec %}2.{% else %}1.{% endif %} Using the {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API
@@ -154,20 +154,20 @@ You can enable {% data variables.product.prodname_discussions %} for your reposi
### {% ifversion fpt or ghec %}3.{% else %}2.{% endif %} Building {% data variables.product.prodname_actions %}
{% data reusables.getting-started.actions %}
### {% ifversion fpt or ghec %}4.{% else %}3.{% endif %} Publishing and managing {% data variables.product.prodname_registry %}
### {% ifversion fpt or ghec %}4.{% else %}3.{% endif %} Publishing and managing {% data variables.product.prodname_registry %}
{% data reusables.getting-started.packages %}
## Part 5: Building securely on {% data variables.product.product_name %}
{% data variables.product.product_name %} has a variety of security features that help keep code and secrets secure in repositories. Some features are available for all repositories, while others are only available for public repositories and repositories with a {% data variables.product.prodname_GH_advanced_security %} license. For an overview of {% data variables.product.product_name %} security features, see "[{% data variables.product.prodname_dotcom %} security features](/code-security/getting-started/github-security-features)."
### 1. リポジトリを保護する
As a repository administrator, you can secure your repositories by configuring repository security settings. These include managing access to your repository, setting a security policy, and managing dependencies. For public repositories, and for private repositories owned by organizations where {% data variables.product.prodname_GH_advanced_security %} is enabled, you can also configure code and secret scanning to automatically identify vulnerabilities and ensure tokens and keys are not exposed.
### 1. Securing your repository
As a repository administrator, you can secure your repositories by configuring repository security settings. These include managing access to your repository, setting a security policy, and managing dependencies. For public repositories, and for private repositories owned by organizations where {% data variables.product.prodname_GH_advanced_security %} is enabled, you can also configure code and secret scanning to automatically identify vulnerabilities and ensure tokens and keys are not exposed.
For more information on steps you can take to secure your repositories, see "[Securing your repository](/code-security/getting-started/securing-your-repository)."
{% ifversion fpt or ghec %}
### 2. Managing your dependencies
A large part of building securely is maintaining your project's dependencies to ensure that all packages and applications you depend on are updated and secure. You can manage your repository's dependencies on {% data variables.product.product_name %} by exploring the dependency graph for your repository, using Dependabot to automatically raise pull requests to keep your dependencies up-to-date, and receiving Dependabot alerts and security updates for vulnerable dependencies.
A large part of building securely is maintaining your project's dependencies to ensure that all packages and applications you depend on are updated and secure. You can manage your repository's dependencies on {% data variables.product.product_name %} by exploring the dependency graph for your repository, using Dependabot to automatically raise pull requests to keep your dependencies up-to-date, and receiving Dependabot alerts and security updates for vulnerable dependencies.
For more information, see "[Securing your software supply chain](/code-security/supply-chain-security)."
{% endif %}
@@ -182,18 +182,22 @@ For more information, see "[Securing your software supply chain](/code-security/
### 2. Interacting with {% data variables.product.prodname_gcf %}
{% data reusables.support.ask-and-answer-forum %}
### 3. Learning with {% data variables.product.prodname_learning %}
### 3. Reading about {% data variables.product.product_name %} on {% data variables.product.prodname_docs %}
{% data reusables.docs.you-can-read-docs-for-your-product %}
### 4. Learning with {% data variables.product.prodname_learning %}
{% data reusables.getting-started.learning-lab %}
{% ifversion fpt or ghec %}
### 4. Supporting the open source community
### 5. Supporting the open source community
{% data reusables.getting-started.sponsors %}
### 5. {% data variables.contact.github_support %} への連絡
### 6. Contacting {% data variables.contact.github_support %}
{% data reusables.getting-started.contact-support %}
{% ifversion fpt %}
## 参考リンク
- [{% data variables.product.prodname_team %} を使ってみる](/get-started/onboarding/getting-started-with-github-team)
## Further reading
- "[Getting started with {% data variables.product.prodname_team %}](/get-started/onboarding/getting-started-with-github-team)"
{% endif %}
{% endif %}

View File

@@ -56,6 +56,8 @@ Before you can try {% data variables.product.prodname_ghe_cloud %}, you must be
After setting up your trial, you can explore {% data variables.product.prodname_ghe_cloud %} by following the [Enterprise Onboarding Guide](https://resources.github.com/enterprise-onboarding/).
{% data reusables.docs.you-can-read-docs-for-your-product %}
{% data reusables.products.product-roadmap %}
## Finishing your trial

Some files were not shown because too many files have changed in this diff Show More