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

v11.0.0 - GitHub Release Based Deployment #111

Closed KyleTryon closed 2 years ago

KyleTryon commented 3 years ago

Description

Orb tools 11 is a ground-up rewrite of the orb, designed to be more streamlined, easier to use, utilizing the latest CircleCI features, and most importantly improves the release process to not only publish the orb on the Orb Registry but also create and tag a Release on GitHub.com.

Context: For those coming to this PR for the first time, this orb is used within CircleCI pipelines to streamline the process of writing and testing your own orbs.

Notable changes:

Removed the 90 day limit
- Previously, the configuration relied on calling a dev:alpha tagged version of the orb for testing. Due to "dev" tags on CircleCI being ephemeral with a 90-day life span, if it had been over 90 days since the orb was last published this would result in an error in the CircleCI pipeline. Users would have to manually publish their orb locally to re-start the ci pipeline
- The new dynamic configuration system allows us to publish the dev version of the orb before calling it for testing. This means that the 90 day limit is no longer an issue.
Adopting Tag/Release based publishing
- Publishing previously required a special text flag to be added to the commit message and a new version was published on every merge to the main branch.
- The new tag/release based publishing system will simply publish your orb when you opt to push a versioned tag or use GitHub's releases feature, which will create a tag and give you an opportunity to create a change log via release notes.
Review system
- The new "review" job can automatically detect opportunities to improve best-practices and provide native JUNIT output which will be displayed in the CircleCI UI.
- Modeled after shellcheck, it is easy to skip any "review check" by supplying its "RC" code in the "exclude" parameter of the job.
Simplified/Improved PR Commenting
- Automatically comment on the PR associated with a commit when each new orb version is published (dev or production.)
- The comment will include a link to the Orb Registry to preview dev versions of the orb, and a live link to the production version of the orb.

Migration

View the included MIGRATION.md

KyleTryon commented 2 years ago

Ignore this comment: Testing GraphQL API to add comment functionality to orb for GitHub users. This is a manual test from GraphiQL.

orb-publisher commented 2 years ago

Your development orb has been published. It will expire in 30 days. You can preview what this will look like on the CircleCI Orb Registry at the following link: https://circleci.com/developer/orbs/orb/circleci/orb-tools?version=dev:aafe1bb79559c8cfdfb58da02c4c7246d4d5ef78

orb-publisher commented 2 years ago

Your development orb has been published. It will expire in 30 days. You can preview what this will look like on the CircleCI Orb Registry at the following link: https://circleci.com/developer/orbs/orb/circleci/orb-tools?version=dev:b8ef9a5fc0671fae5b9e6df1a3e39683bdd74e7b

orb-publisher commented 2 years ago

Your development orb has been published. It will expire in 30 days. You can preview what this will look like on the CircleCI Orb Registry at the following link: https://circleci.com/developer/orbs/orb/circleci/orb-tools?version=dev:b02213f0632eb6652e4e2d1d36050acd13331e6e

orb-publisher commented 2 years ago

Your development orb has been published. It will expire in 30 days. You can preview what this will look like on the CircleCI Orb Registry at the following link: https://circleci.com/developer/orbs/orb/circleci/orb-tools?version=dev:162902fec30fa901757b04370e9e54af35efa042

orb-publisher commented 2 years ago

Your development orb has been published. It will expire in 30 days. You can preview what this will look like on the CircleCI Orb Registry at the following link: https://circleci.com/developer/orbs/orb/circleci/orb-tools?version=dev:162902fec30fa901757b04370e9e54af35efa042

orb-publisher commented 2 years ago

Your development orb has been published. It will expire in 30 days. You can preview what this will look like on the CircleCI Orb Registry at the following link: https://circleci.com/developer/orbs/orb/circleci/orb-tools?version=dev:162902fec30fa901757b04370e9e54af35efa042

KyleTryon commented 2 years ago

Noticing that a PR comment was not sent with that last commit, though it appears as though it was successful here: https://app.circleci.com/pipelines/github/CircleCI-Public/orb-tools-orb/902/workflows/424f0cdf-4091-45f4-9b65-dee3acfeafce/jobs/5440

Realizing it may have stopped working a while ago actually..

orb-publisher commented 2 years ago

Your development orb has been published. It will expire in 30 days. You can preview what this will look like on the CircleCI Orb Registry at the following link: https://circleci.com/developer/orbs/orb/circleci/orb-tools?version=dev:e9029628fb8ec56ad1f9c92b990706e9788fdcf4

orb-publisher commented 2 years ago

Your development orb has been published. It will expire in 30 days. You can preview what this will look like on the CircleCI Orb Registry at the following link: https://circleci.com/developer/orbs/orb/circleci/orb-tools?version=dev:26af2115a3313c4695a5dfa31eb0f56beb9f32c5

orb-publisher commented 2 years ago

Your development orb has been published. It will expire in 30 days. You can preview what this will look like on the CircleCI Orb Registry at the following link: https://circleci.com/developer/orbs/orb/circleci/orb-tools?version=dev:d1f044230c312f589bf8ad1f78abe3fadca6506a

orb-publisher commented 2 years ago

Your development orb has been published. It will expire in 30 days. You can preview what this will look like on the CircleCI Orb Registry at the following link: https://circleci.com/developer/orbs/orb/circleci/orb-tools?version=dev:994e925234f5e0c606efe5b1132f3c0a154cfa5f

orb-publisher commented 2 years ago

Your development orb has been published. It will expire in 30 days. You can preview what this will look like on the CircleCI Orb Registry at the following link: https://circleci.com/developer/orbs/orb/circleci/orb-tools?version=dev:3833510c54f24a92ef8796f3c09dbdb48046dae2

orb-publisher commented 2 years ago

Your development orb has been published. It will expire in 30 days. You can preview what this will look like on the CircleCI Orb Registry at the following link: https://circleci.com/developer/orbs/orb/circleci/orb-tools?version=dev:bcc4737d65ccbf9c628b0ea469986c706a8ee8fc

orb-publisher commented 2 years ago

Your development orb has been published. It will expire in 30 days. You can preview what this will look like on the CircleCI Orb Registry at the following link: https://circleci.com/developer/orbs/orb/circleci/orb-tools?version=dev:6da5efaa0c76ae9e6d06a7cf402026a647c46401