Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
44 lines (28 loc) · 1.35 KB

CONTRIBUTING.md

File metadata and controls

44 lines (28 loc) · 1.35 KB

Contributing

Warning

This guide is a work in progress and may not be complete.

This is a basic contributing guide and is a work in progress.

Workflow

  1. Fork the repository.
  2. Create a branch in your fork!
  3. Make your changes.
  4. Test your changes.
  5. Commit and push your changes.
  6. Create a PR to this repository.
  7. Verify the tests pass, otherwise resolve.
  8. Make sure to keep your branch up-to-date.

Testing

GitHub is easier to set up, but you have to push your commits to test.
Running locally is harder to set up, but it is much easier to test; and by far recommended!

GitHub

You will need to add your CLOUDFLARE_API_TOKEN to the GitHub Action Secrets.

You also need to add your zone to the ZONES GitHub Action Variables.

When you push your branch to your repository, the test.yaml should run...

Locally

To run actions locally you need to install act: https://nektosact.com/installation/index.html

  1. Create a .secrets file with: CLOUDFLARE_API_TOKEN="xxx"
  2. Run: act -j test --env ZONES=example.com (with your ZONES)

The test updates the action.yaml to use the Dockerfile. This ensures the test will always use your local changes.

To test the docker image, run: build.sh --env ZONES=example.com

To see all available jobs run: act -l