The following steps are only needed if your project is NOT a Quarkiverse participant (i.e. not a project of the Quarkiverse organization), as Quarkiverse projects are already set up this way:

• Add a secret named ECOSYSTEM_CI_TOKEN in your repository that contains the token of the user that opened the issue mentioned in the first step. This token will be used in order to open and close the issue from the CI action.

• Add the following file to configure the Quarkus CI in GitHub Actions for your repository:

  .github/workflows/quarkus-snapshot.yaml (this file contains the actual GitHub Actions declaration)

  name: "Quarkus ecosystem CI"
  on:
    watch:
      types: [started]
    workflow_dispatch:
  
  # For this CI to work, ECOSYSTEM_CI_TOKEN needs to contain a GitHub with rights to close the Quarkus issue that the user/bot has opened,
   # while 'ECOSYSTEM_CI_REPO_PATH' needs to be set to the corresponding path in the 'quarkusio/quarkus-ecosystem-ci' repository
  
  env:
    ECOSYSTEM_CI_REPO: quarkusio/quarkus-ecosystem-ci
    ECOSYSTEM_CI_REPO_FILE: context.yaml
    JAVA_VERSION: 11
  
    #########################
    # Repo specific setting #
    #########################
  
    ECOSYSTEM_CI_REPO_PATH: FIXME # TODO: this needs to be set to the directory name added in 'quarkusio/quarkus-ecosystem-ci'
  
    ###################################
    # Optional repo specific settings #
    ###################################
  
    # The setup-and-test script assumes the pom.xml file is at the root of your repo
    # Use this env var to add a nested path within your repo where pom.xml is
    QUARKUS_VERSION_POM_PATH: PATH_WHERE_POM_XML_IS
  
    # The setup-and-test script assumes the property within pom.xml that determines the
    # quarkus version is called "quarkus.version".
    # Use this env var to override the property to something else
    # (like "quarkus.platform.version" for example)
    QUARKUS_VERSION_POM_PROPERTY: quarkus.version
  
  jobs:
    build:
      name: "Build against latest Quarkus snapshot"
      runs-on: ubuntu-latest
      if: github.actor == 'quarkusbot' || github.event_name == 'workflow_dispatch'
  
      steps:
        - name: Install yq
          uses: dcarbone/[email protected]
  
        - name: Set up Java
          uses: actions/setup-java@v3
          with:
            java-version: ${{ env.JAVA_VERSION }}
            distribution: 'temurin'
  
        - name: Checkout repo
          uses: actions/checkout@v3
          with:
            path: current-repo
  
        - name: Checkout Ecosystem
          uses: actions/checkout@v3
          with:
            repository: ${{ env.ECOSYSTEM_CI_REPO }}
            path: ecosystem-ci
  
        - name: Setup and Run Tests
          run: ./ecosystem-ci/setup-and-test
          env:
            ECOSYSTEM_CI_TOKEN: ${{ secrets.ECOSYSTEM_CI_TOKEN }}

Finally, if your extension requires a custom test script (by default quarkus-ecosystem-test from this repository is used), add a file named .github/quarkus-ecosystem-test.

Example projects containing the proper GitHub Action YAML file (and which has been tested with the whole process) can be found here and here.

In case you haven’t created a GitHub token before, the process is roughly as follows.

You can generate a token by accessing https://github.com/settings/tokens and clicking on Generate new token. On the page that comes up, provide a name, select repo scope and click on Generate token at the bottom of the page. You will be prompted with the newly generated token, but be sure to copy it wherever it is needed, because you won’t be able to see it again.

Now that you have created the token, you need to create a GitHub Secret with its value, by first accessing /settings/secrets in your repository, then adding a new secret named ECOSYSTEM_CI_TOKEN where you simply paste the contents of the token and save by clicking on Add token.

You can execute a custom script as part of the Ecosystem CI initialization (i.e. before the build of your repository starts) by adding an executable bash script .github/ci-init.sh to your repository.