Creating a release from a PR

  1. Create a new branch locally.
  2. Make changes, and make sure all tests pass locally.
  3. When done, push the branch to the repo and create a PR. Make sure all tests pass on CI.
  4. Your PR will be reviewed by the team.
  5. After the review, but before merging, make sure to bump the version in Project.toml. Follow this convention.
  6. Merge the PR (and possibly delete the branch where you did your work).
  7. Navigate to the merge commit (hint: this should be on the main branch!) and make the comment @JuliaRegistrator register. See here for an example.
  8. If all goes well, the bots will take it from here. After the Julia registry merges our release PR, TagBot will create a tag for the release automatically.

Creating a release without a PR

Do step 7 above with the latest commit on main (example).

Running tests

See test/README.md.

Generating documentation

See docs/README.md.

Adding a submission system (beyond SLURM, PBS, etc, or variant thereof)

Add an entry in the "rosetta stone" of submission systems (see SubmissionSyntax):

using Pigeons

Pigeons._rosetta
Dict{Symbol, Pigeons.SubmissionSyntax} with 3 entries:
  :pbs   => SubmissionSyntax(`qsub`, `qdel`, "#PBS", "-N ", "-o ", "-e ", "\$PB…
  :lsf   => SubmissionSyntax(`bsub`, `bkill`, "#BSUB", "-J ", "-o ", "-e ", "\$…
  :slurm => SubmissionSyntax(`sbatch`, `scancel`, "#SBATCH", "--job-name=", "-o…

Then, specify how resource strings are constructed by creating a new dispatch of resource_string().

Once you have tested it, please submit a Pull Request!