search

CircleCI-Public / orb-tools-orb

Various tools for authoring and publishing CircleCI orbs
https://circleci.com/orbs/registry/orb/circleci/orb-tools
MIT License
51 stars 74 forks source link

After running migration script, `command-tests` job in test-deploy.yml is confusing #164

Closed brivu closed 1 year ago

brivu commented 1 year ago

Describe Request:

After running the migration script, I've gotten confused with the command-tests job that's automatically included in the test-deploy workflow. It think its' intent is to let the users know:

  1. where to add their jobs
  2. that they need to add filters: *filters to every test job.
  3. that the job also needs to be added to the requires parameter in the orb-tools/publish job.

I think it needs to be be more explicitly clear with something like -FIRST-TEST-JOB

Examples:

workflows:
  test-deploy:
    jobs:
      # Make sure to include "filters: *filters" in every test job you want to run as part of your deployment.
--> - command-tests:
          filters: *filters
      - orb-tools/pack:
          filters: *filters
      - orb-tools/publish:
          orb-name: circleci/aws-s3-orb
          vcs-type: << pipeline.project.type >>
          pub-type: production
          requires:
            - orb-tools/pack
-----> - command-tests