grafana / k6-circleci-orb

CircleCI k6 Orb

Grafana/k6-circleci-orb

The easiest way to integrate performance tests in your CircleCI pipeline.

Resources

• k6 CircleCI Orb

• Tutorial

• Examples

How to Contribute

We welcome issues to and pull requests against this repository!

Check out the CircleCI Orb Docs for using and creating CircleCI Orbs.

How to Publish

• Create and push a branch with your new features.
• When ready to publish a new production version, create a Pull Request from feature branch to master.
• The title of the pull request must contain a special semver tag: [semver:<segement>] where <segment> is replaced by one of the following values.

Increment	Description
major	Issue a 1.0.0 incremented release
minor	Issue a x.1.0 incremented release
patch	Issue a x.x.1 incremented release
skip	Do not issue a release

Example: [semver:major]

• Squash and merge. Ensure the semver tag is preserved and entered as a part of the commit message.
• On merge, after manual approval, the orb will automatically be published to the Orb Registry.

For further questions/comments about this or other orbs, visit the Orb Category of CircleCI Discuss.

How to publish a dev release

With admin permission on this repo:

• git pull the branch
• circleci orb pack src > config.yml
• circleci orb publish config.yml k6/test@dev:X.Z

k6-circleci-orb's Issues

CircleCI Review

Hello All,

My name is Kyle from the CircleCI Community and Partner Engineering team following up on my email with some review items on the current orb.

1. If the command is not meant to be used by end-users, do not create it.
   a. Instead, simply contain all logic within the job. No commands are needed.
   b. https://github.com/k6io/circleci-orb/blob/main/src/commands/run-test.yml
2. Allow the user to specify a specific docker tag.
   a. https://github.com/k6io/circleci-orb/blob/a1ae46a30dcd2fd80640c3a98f2fb3c95f1771fe/src/jobs/test.yml#L4
   b. Parameterize the tag portion of the docker image.
   c. Specifying a tag is important for CI so users can test against known and good versions.
   e. Example: https://github.com/CircleCI-Public/node-orb/blob/3d313ec2fbc9dd2a5c804d9b142e2419c4176ca4/src/executors/default.yml#L14
3. Private information should be accessed via environment variables, not hard-coded strings in the config.
   a. https://github.com/k6io/circleci-orb/blob/a1ae46a30dcd2fd80640c3a98f2fb3c95f1771fe/src/jobs/test.yml#L23
   b. https://circleci.com/docs/2.0/orb-author-faq/?section=configuration#secure-api-tokens