Artifactz.io Logo
ARTIFACTZ
Registration
As it stands, the platform operates in the beta mode, which means that there are a limited number of tenants. We are constantly adding capacity and allowing more tenants to get to the platform. If you're interested in participating in the beta program (free of charge) please register by entering your email in the box below and clicking the "Register" button.
Once you confirm your email it gets added to the queue for the new tenant account. As soon as there is enough capacity for the new tenant you will receive another email with the unique link to the registration page. Link is active for 24 hours and if unused, your email will be taken off the queue.
Upon clicking the registration page link you end up in the following form. All mandatory fields are denoted with the asterisks* character.
Email is the primary contact for the artifactz.io tenant and could be used only once in the system.
Your password should be at least 8 characters long, should have upper and lower characters and either numbers or special characters.
Personal details such as title first and last name are completely optional and used only to address communication in the polite personal manner.
Tenant Name is mandatory. However, if your tenant is not owned by a business, it could be anything. For the business tenants it must be a legal business name.
Address is mandatory as well but similar to the Tenant Name irrelevant for personal use. Business address must also be the legal company address.
Tax (VAT) Number is required for the EU companies for the purpose of invoicing.
Once registration is completed and email address is confirmed you will be able to login to the user dashboard.
Create Token
n order to configure the CI/CD plugin for your platform of choice you need to create an API token. To do this, select "Tokens" in the left-hand panel and click the "Add" button.
API tokens
Select the required token scopes and click the "Add" button. There are two scopes currently supported:
  • urn:artifactor:write (Register and update artifacts) - allows to create, modify artifact record or push it through the flow
  • urn:artifactor:read (Read registered artifacts) - allows to read artifact version information
Create token
Once a token is created it will be displayed once on the screen. You must copy it to the safe location or use it immediately to configure the corresponding plugin. As soon as you leave the tokens screen you will not be able to recover the token.
Copy token
For convenience, there is a copy icon next to the newly generated API token, marked with the red circle on the image above. Clicking it will copy the toke to the clipboard.
Configure Plugin
There are currently four plugins available for number of build systems and CI/CD tools:
Jenkins
In order to configure the Jenkins instance first create a new Secret Text credentials item with the API token:
Add Jenkins Credentials Item
Then, install the Artifactz.io plugin and select the credentials, created in the previous step, from the "Credentials" drop-down list.
Configure Jenkins plugin
Optionally, configure proxy if direct connection to the artifactz.io is not allowed.
Now, you can use available steps in your pipeline.
Github Actions
In order to configure the GitHub Actions add the "ARTIFACTZ_TOKEN" secret with the API token that has required scope.
Then, you can use one of the three available actions to manipulate the artifact details or retrieve them from the pipeline.
For example to publish a new artifact you can use the following action:
- name: Publish the version of the database image to the Artifactz.io Development stage
  uses: iktech/publish-artifact-javascript-action@v1.0.0
  with:
    apiToken: ${{ secrets.ARTIFACTZ_TOKEN }}
    stage: Development
    name: test
    type: DockerImage
    flow: Simple
    version: 1.0.0
                  
Note that API token is taken from the secret.
To push the artifact through the flow use the following example:
- name: Push Artifact Info
  id: push
  uses: iktech/push-artifact-javascript-action@v1.0.0
  with:
    apiToken: ${{ secrets.ARTIFACTZ_TOKEN }}
    stage: Development
    name: test
                  
Note that push action is only available when an artifact is associated with the flow.
Azure DevOps
In order to use Artifactz Service in you Azure DevOps Pipeline, first you need to install Artifactz.io Azure DevOps Extension.
To do this, go to your Organization Settings in the Azure DevOps console and click General->Extensions in the left hand panel. There, click browse the marketplace, find the extension and click "Get it free".
Once extension is installed, define a variable in the project's Variable Group with the API Token. Let's say that the Variable Group has name "default" and a variable in it named "artifactz.api_token".
Then, you can use it when configuring one of the Artifactz.io tasks.
First, link your pipeline with the Variable Group by adding the following to the pipeline YAML file:
variables:
- group: default
                  
This will link variables from the Variable Group "default" with the pipeline.
For example, to publish the artifact from the pipeline, you can use the following task:
- task: publish-artifact@1
  inputs:
    apiToken: $(artifactz.api_token)
    stage: 'Development'
    flow: 'Test'
    name: 'test-data'
    type: 'JAR'
    groupId: 'io.iktech.test'
    artifactId: 'test-data'
    version: '1.0.1'
                  
Or to push artifact, you can use the following task:
- task: push-artifact@1
  name: pushArtifact
  inputs:
    apiToken: $(artifactz.api_token)
    stage: 'Development'
    name: 'test-data'
                  
Gradle
In order to use Artifactz Service with Gradle you have to define number of variables as described in the documentation.
As a minimum, two variables are required artifactz.apiToken and artifactz.stage.
It is advisable to set the artifactz.apiToken in the global gradle.properties file. However, the artifactz.stage could be set in global as well as project gradle.properties.
Then, include the plugin by adding the following to the plugins block of the build.gradle file:
plugins {
//  ...
    id 'io.iktech.artifactz' version '1.0.0'
//  ...
}
								
Then, if you want to resolve the version of the dependent library using artifactz.io just leave their versions empty in the build.gradle file:
dependencies {
    implementation 'org.apache.logging.log4j:log4j-core'
    implementation 'org.apache.logging.log4j:log4j-api'
    testImplementation 'org.junit.jupiter:junit-jupiter-api:5.6.0'
    testImplementation 'org.mockito:mockito-junit-jupiter:3.7.7'
    testImplementation 'org.mockito:mockito-core:3.7.7'
    testRuntimeOnly 'org.junit.jupiter:junit-jupiter-engine'
}
								
The plugin also provides two additional tasks publishArtifact and pushArtifact that allow user to manage artifact versions from the Gradle build. Check plugin documentation for more details.
This website uses cookies. By continuing to browse this site, you agree to this use.