personalaccesstoken.md

Personal access token for the GitHub registry

Content

• Personal access token for the GitHub registry
  • Content
  • Purpose for personal access token
  • Create an personal access token on GitHub
  • Login into Simatic-Ax registry
    • Login via CLI
    • Login via AX Code UI /Web or local IDE)
  • Workspace settings to access the GitHub registry

Purpose for personal access token

To be able to consume some packages from the simatic-ax group, you need to login into the registry.

Create an personal access token on GitHub

To create an personal access on GitHub token follow this link)

It's very important that you check the checkbox write:packages

For security reasons, your token should be expire after wa while (by default it's 30 days) Remember this token. You'll need it for the login in the next step

Login into Simatic-Ax registry

Login via CLI

To login via CLI you've to enter the following command. You've to replace <your personal access token> by your on Github created access token.

apax login --registry https://npm.pkg.github.com/ --password <your personal access token>

Login via AX Code UI /Web or local IDE)

To login into the GitHub registry for Simatic AX within your IDE (Web or local AX Code) follow this steps:

1. select the file apax.yml, click the right mouse button and select Login to registry

   

2. Enter the GitHub URL

   

   https://npm.pkg.github.com/

3. Leave the user name field empty and press Enter

   

4. Enter your personal access token from GitHub with Strg+V

   

Now you're able to install all dependencies to develop on your library.

Workspace settings to access the GitHub registry

To access the GitHub registry from your workspace, you've to announce it in the apax.yml.

Please enter the following code into your apax.yml:

registries:
  '@simatic-ax': 'https://npm.pkg.github.com/'