/publiccode-parser-orb

CircleCI Orb for publiccode.yml validation

Primary LanguageShellMIT LicenseMIT

CircleCI Orb for publiccode.yml validation

CircleCI CircleCI Orb Version GitHub License

Usage

This orb validates publiccode.yml files using publiccode-parser-go

You can use it in your workflow to check if publiccode.yml in your repo is valid.

Example:

orbs:
    publiccode-parser: italia/publiccode-parser@0.0.3

workflows:
  test_my_app:
    jobs:
      - publiccode-parser/validate

see the orb registry listing for the full documentation and examples.

How to release (for developers of this orb)

  1. Create a feature branch and work on changes

  2. Check for errors with circleci config validate

  3. Put [semver:patch] in your commit subject to automatically bump the orb version (or [semver:minor] or [semver:major])

  4. Push the feature branch to italia/publiccode-parser-orb, not your own fork.

  5. Open a PR, the build scripts will start

  6. If the build errors out with "Cannot find italia/publiccode-parser@dev:alpha in the orb registry".

    1. circleci orb pack src > file.yml
      circleci orb validate file.yml
      circleci orb publish file.yml italia/publiccode-parser@dev:alpha
    2. Rerun the build

  7. Approve the hold-for-dev-publish job in CircleCI

  8. The publish-dev job will publish a new development orb (italia/publiccode-parser@dev:alpha)

  9. If the integration-dev workflow passes, get review and merge to master

  10. Approve hold-for-dev-publish again when the pipeline on master runs

  11. Check the new version is published and create a new PR bumping the version in the README as well