ノート: サイト管理者はそれぞれのサポートされているパッケージの種類を有効化あるいは無効化できるので、このパッケージの種類はインスタンスで利用できないかもしれません。 詳しい情� �については、「Enterprise 向けのパッケージサポートを設定する」を参照してく� さい。
Authenticating to GitHub Packages
You need an access token to publish, install, and delete packages.
You can use a personal access token (PAT) to authenticate to GitHub Packages or the GitHub Enterprise Server API. When you create a personal access token, you can assign the token different scopes depending on your needs. For more information about packages-related scopes for a PAT, see "About permissions for GitHub Packages."
To authenticate to a GitHub Packages registry within a GitHub Actions workflow, you can use:
GITHUB_TOKEN
to publish packages associated with the workflow repository.- a PAT to install packages associated with other private repositories (which
GITHUB_TOKEN
can't access).
GitHub Actionsワークフローで使われるGITHUB_TOKEN
に関する詳しい情� �については「ワークフローでの認証」を参照してく� さい。
Authenticating with a personal access token
GitHub Packages内でパッケージを公開及びインストールするためには、適切なスコープで個人アクセストークンを使わなければなりません。 詳しい情� �については「GitHub Packagesについて」を参照してく� さい。
You can authenticate to GitHub Packages with Apache Maven by editing your ~/.m2/settings.xml file to include your personal access token. Create a new ~/.m2/settings.xml file if one doesn't exist.
In the servers
tag, add a child server
tag with an id
, replacing USERNAME with your GitHub username, and TOKEN with your personal access token.
In the repositories
tag, configure a repository by mapping the id
of the repository to the id
you added in the server
tag containing your credentials. Replace HOSTNAME with the host name of GitHub Enterprise Serverインスタンス, and OWNER with the name of the user or organization account that owns the repository. Because uppercase letters aren't supported, you must use lowercase letters for the repository owner even if the GitHub user or organization name contains uppercase letters.
If you want to interact with multiple repositories, you can add each repository to separate repository
children in the repositories
tag, mapping the id
of each to the credentials in the servers
tag.
GitHub PackagesはApache MavenのSNAPSHOT
バージョンをサポートしています。 SNAPSHOT
成果物をダウンロードするためにGitHub Packagesリポジトリを使うには、使用するプロジェクトのPOM中もしくは~/.m2/settings.xmlファイルでSNAPSHOTSを有効にしてく� さい。
If your instance has subdomain isolation enabled:
<settings xmlns="http://maven.apache.org/SETTINGS/1.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.0.0
http://maven.apache.org/xsd/settings-1.0.0.xsd">
<activeProfiles>
<activeProfile>github</activeProfile>
</activeProfiles>
<profiles>
<profile>
<id>github</id>
<repositories>
<repository>
<id>central</id>
<url>https://repo1.maven.org/maven2</url>
</repository>
<repository>
<id>github</id>
<url>https://maven.HOSTNAME/OWNER/REPOSITORY</url>
<snapshots>
<enabled>true</enabled>
</snapshots>
</repository>
</repositories>
</profile>
</profiles>
<servers>
<server>
<id>github</id>
<username>USERNAME</username>
<password>TOKEN</password>
</server>
</servers>
</settings>
If your instance has subdomain isolation disabled:
<settings xmlns="http://maven.apache.org/SETTINGS/1.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.0.0
http://maven.apache.org/xsd/settings-1.0.0.xsd">
<activeProfiles>
<activeProfile>github</activeProfile>
</activeProfiles>
<profiles>
<profile>
<id>github</id>
<repositories>
<repository>
<id>central</id>
<url>https://repo1.maven.org/maven2</url>
</repository>
<repository>
<id>github</id>
<url>HOSTNAME/_registry/maven/OWNER/REPOSITORY</url>
<snapshots>
<enabled>true</enabled>
</snapshots>
</repository>
</repositories>
</profile>
</profiles>
<servers>
<server>
<id>github</id>
<username>USERNAME</username>
<password>TOKEN</password>
</server>
</servers>
</settings>
Publishing a package
デフォルトでは、GitHubはパッケージはそのままの名前で既存のリポジトリに公開されます。 For example, GitHub will publish a package named com.example:test
in a repository called OWNER/test
.
If you would like to publish multiple packages to the same repository, you can include the URL of the repository in the <distributionManagement>
element of the pom.xml file. GitHub will match the repository based on that field. Since the repository name is also part of the distributionManagement
element, there are no additional steps to publish multiple packages to the same repository.
For more information on creating a package, see the maven.apache.org documentation.
-
Edit the
distributionManagement
element of the pom.xml file located in your package directory, replacing HOSTNAME with the host name of GitHub Enterprise Serverインスタンス,OWNER
with the name of the user or organization account that owns the repository andREPOSITORY
with the name of the repository containing your project.If your instance has subdomain isolation enabled:
<distributionManagement> <repository> <id>github</id> <name>GitHub OWNER Apache Maven Packages</name> <url>https://maven.HOSTNAME/OWNER/REPOSITORY</url> </repository> </distributionManagement>
If your instance has subdomain isolation disabled:
<distributionManagement> <repository> <id>github</id> <name>GitHub OWNER Apache Maven Packages</name> <url>https://HOSTNAME/_registry/maven/OWNER/REPOSITORY</url> </repository> </distributionManagement>
-
Publish the package.
$ mvn deploy
パッケージを公開した後は、GitHub上でそのパッケージを見ることができます。 詳しい情� �については「パッケージの表示」を参照してく� さい。
Installing a package
To install an Apache Maven package from GitHub Packages, edit the pom.xml file to include the package as a dependency. If you want to install packages from more than one repository, add a repository
tag for each. For more information on using a pom.xml file in your project, see "Introduction to the POM" in the Apache Maven documentation.
-
GitHub Packagesに認証を受けてく� さい。 詳しい情� �については「GitHub Packagesへの認証を行う」を参照してく� さい。
-
Add the package dependencies to the
dependencies
element of your project pom.xml file, replacingcom.example:test
with your package.<dependencies> <dependency> <groupId>com.example</groupId> <artifactId>test</artifactId> <version>1.0.0-SNAPSHOT</version> </dependency> </dependencies>
-
Install the package.
$ mvn install