Pipeline Settings

Packaging & deploying with GitHub Actions

The following steps are usd to package the application with GitHub Actions:

Note: not all steps are needed everytime.

Only the first time (or a new repository)

---

This is done for cpmpy...

1. Create the .github/workflows/ directory in your repository to store your workflow files.
2. Create the files describing the pipeline e.g. pypi-release.yml in the .github/workflows/ directory.
3. Admin only: Go to the Settings tab of the repository and then click on Secrets in the left sidebar.
4. Add a new secret with a name such as PYPI_USERNAME and PYPI_API_TOKEN
5. These user and token you should get from the project in PyPi (Tias & Ahmed only has access)

---

How to write a workflow?

This is different for each workflow you want run. Eventually Github-actions are kind of script-files that has specific syntax (like bash and more closely like Docker files). You need to briefly understand the syntax tree of the file, some basic COMMANDS and then just dig in the documentations to write complex workflows. The steps above will make sure that the Pip workflow will work even if the repository moves. For testing I put a reference in the references section form the official documentation of Github which explains well the whole idea.

References

• Offical Python documentation for Publishing package distribution releases using GitHub Actions CI/CD workflows CI/CD Publish to pip.

• A good ref for packaging and deploying with Github actions: git actions - Pypi.

• Github action documentation: CI/CD Testing python code example.