Skip to content

Releases: CircleCI-Public/orb-tools-orb

v11.0.0 - Tag Based Deployment

10 Mar 19:24
@KyleTryon KyleTryon
v11.0.0
17ad1d6
This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
GPG key ID: 4AEE18F83AFDEB23
Expired
Learn about vigilant mode.
Compare
Choose a tag to compare
v11.0.0 - Tag Based Deployment

v11.0.0 - Tag Based Deployment

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 30 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 30-day life span, if it had been over 30 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 30 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

Assets 2
Loading