CONTRIBUTING.md

Contributing Guidelines

Telestion Core packages

To download and use the telestion-core packages, please create a personal access token with the packages:read scope. Next, copy the gradle.properties.example configuration file and name it gradle.properties. Now fill in your GitHub username and the previously created PAT. No worry, this file will not be committed at any time!

Finally, synchronize gradle to automatically download and set up the telestion-core packages.

Intended Release Cycle

When you want to release a new application, go to the Actions Tab in the GitHub UI and choose the Release Action. Then click Run workflow.

This triggers the Release Action which automatically creates a Conventional Commit Release on GitHub. Afterwards the subsequent build actions are triggered via:

on:
  workflow_run:
    workflows: ["Release"]
    types: [completed]

Additionally, if you want to upload release assets in these build workflows, you can use the cached build environment:

      - name: Download build environment 📥
        uses: dawidd6/[email protected]
        with:
          workflow: ${{ github.event.workflow_run.workflow_id }}
          workflow_conclusion: success
          name: build-env
          path: ${{ github.workspace }}

      - name: Import environment ⛓
        run: cat .build-env >> $GITHUB_ENV

      - name: Upload release asset
        uses: actions/[email protected]
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        with:
          upload_url: ${{ env.upload_url }}
          asset_path: ./dist/artifact1.txt
          asset_name: artifact1.txt
          asset_content_type: text/plain

CLA

All contributers are required to sign a contributor's license agreement to contribute to this repository. For further details, please contact [email protected]. Thank you! 🙂