Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

v11.0.0 - GitHub Release Based Deployment #111

Merged
merged 93 commits into from
Mar 8, 2022
Merged

v11.0.0 - GitHub Release Based Deployment #111

merged 93 commits into from
Mar 8, 2022

Conversation

KyleTryon
Copy link
Contributor

@KyleTryon KyleTryon commented May 20, 2021

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 KyleTryon requested a review from a team as a code owner May 20, 2021 21:02
@orb-publisher
Copy link

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
Copy link

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
Copy link

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

Copy link
Contributor

@Jaryt Jaryt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me!

migrate.sh Outdated Show resolved Hide resolved
src/scripts/review.sh Outdated Show resolved Hide resolved
src/scripts/review.sh Outdated Show resolved Hide resolved
@orb-publisher
Copy link

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
Copy link

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
Copy link

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

KyleTryon added a commit that referenced this pull request Mar 9, 2022
KyleTryon added a commit that referenced this pull request Mar 9, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
5 participants