Sample workflows for Logtalk repos

To use a workflow in your own repo, copy its file to the .github/workflows directory on your repo and edit the workflow to match your application requirements, notably to choose and configure the Prolog compiler backend that you want to use. Don't forget to enable, if necessary, GitHub Actions for your repo. See the demo and spider repos for usage examples of some of these workflows.

compliance.yml

This workflow runs the Prolog standards compliance test suite bundled with Logtalk. After copying it, edit the backend Prolog system and the Logtalk version to use plus the required logtalk_tester script options.

compliance_plus_allure_report.yml

Same as the compliance.yml workflow but also creates an Allure report with the test results for easy browsing. The report is uploaded to the gh-pages branch for automatic publishing using GitHub Pages.

testing.yml

This workflow runs tests on push events and makes available a TAP report and a code coverage report as build artifacts. To generate instead a xUnit report, change the logtalk_tester option -f tap to -f xunit and tap-report to xunit-report in the upload action.

testing_pull_requests.yml

This workflow run tests on pull request events without generating any reports. It also uses a minimal Logtalk setup without installing third-party dependencies, which are not required in this case. Merging the pull request requires this workflow to succeed.

testing_multiple_backends.yml

This workflow runs tests on multiple backends and uploads xUnit and code coverage reports per backend as build artifacts.

coverage.yml

This workflow runs on push events and is a variant of the testing.yml workflow that also publishes the code coverage report to GitHub Pages. It uses a third-party action that requires creating a personal access token. You will also need to create the gh-pages branch before running the workflows. See https://github.com/maxheld83/ghpages for details.

diagrams.yml

This workflow runs on push events and generates and uploads as a build artifact the application diagrams in SVG format.

documenting.yml

This workflow runs on push events and generates HTML documentation using Sphinx making it available as a build artifact.

doclet.yml

This workflow runs on push events and calls the logtalk_doclet script to generate documentation assuming that the project defines a doclet.

embedding.yml

This workflow runs on push events and illustrates how to embed a Logtalk application and generate an executable. For more on embedding support see https://github.com/LogtalkDotOrg/logtalk3/tree/master/scripts/embedding.

Contributing

Contributions are most welcome. Contributors are expected to uphold the code of conduct.

License

This project is released under the Apache License 2.0.

Current Status

These workflows are in active development.