niployments-deploy-action

Action used by NIAEFEUP projects to publish images built from them to an internal Image Registry

Table of Contents

• niployments-deploy-action
  • Table of Contents
  • Inputs
    • project_name:
    • repository_name:
    • docker_context:
    • docker_dockerfile:
    • docker_target:
    • NIPLOYMENTS_REGISTRY_URL:
    • NIPLOYMENTS_REGISTRY_USERNAME:
    • NIPLOYMENTS_REGISTRY_PASSWORD:
  • Example
  • License

Inputs

The inputs to this action as described in the action manifest are:

project_name:

• Description: The name of the Harbor project under which to store this artifact. For further information see the relevant documentation.
• Required: false
• Default: niaefeup

repository_name:

• Description: The name of the Harbor repository under which to store this artifact. For further information see the relevant documentation.
• Required: false

docker_context:

• Description: The context Docker uses to build this image.
• Required: false

docker_dockerfile:

• Description: The name of the Dockerfile used to build this image.
• Required: false
• Default: Dockerfile-prod

docker_target:

• Description: Sets the target stage to build
• Required: false

Warning

Due to limitations in Composite Action runners, some contexts (namely vars and secrets) are not available to use inside the action, as seen here. Those values need to be provided as inputs while this is not fixed. See this link for further details.

NIPLOYMENTS_REGISTRY_URL:

• Description: The URL of the Image Registry deployed in the NIployments cluster.
• Required: true

NIPLOYMENTS_REGISTRY_USERNAME:

• Description: The username to use when authentication against the Image Registry deployed in the NIployments cluster.
• Required: true

NIPLOYMENTS_REGISTRY_PASSWORD:

• Description: The password to use when authentication against the Image Registry deployed in the NIployments cluster.
• Required: true

Example

Sample usage of this action:

name: Deploy

on:
  push:
    branches:
      - main

jobs:
  build:
    runs-on: ubuntu-latest

    steps:
    - name: Upload to NIployments register
      uses: NIAEFEUP/push-to-niployments@v2.1
      with:
        project_name: my-project
        repository_name: my-repository
        NIPLOYMENTS_REGISTRY_URL: ...
        NIPLOYMENTS_REGISTRY_USERNAME: ...
        NIPLOYMENTS_REGISTRY_PASSWORD: ...

License

The code in this repository is licensed under the MIT license. See the LICENSE file for details