Skip to content

Latest commit

 

History

History
38 lines (25 loc) · 2.71 KB

README.md

File metadata and controls

38 lines (25 loc) · 2.71 KB

membraneframework/elixir Orb

CircleCI Build Status CircleCI Orb Version GitHub License CircleCI Community

Common commands and jobs to build, test and lint Membrane Framework packages written in Elixir

Usage

The usage examples can be found at CircleCI Orb Registry Page for this Orb or inside this repo at src/examples


Resources

CircleCI Orb Registry Page - The official registry page of this orb for all versions, executors, commands, and jobs described.

CircleCI Orb Docs - Docs for using, creating, and publishing CircleCI Orbs.

How to Contribute

We welcome issues to and pull requests against this repository!

How to Publish An Update

  1. Merge pull requests with desired changes to the main branch.
  2. Find the current version of the orb.
    • You can run circleci orb info membraneframework/elixir | grep "Latest" to see the current version.
  3. Create a new Release on GitHub.
    • Click "Choose a tag" and create a new semantically versioned tag. (ex: v1.0.0)
      • We will have an opportunity to change this before we publish if needed after the next step.
  4. Click "+ Auto-generate release notes".
    • This will create a summary of all of the merged pull requests since the previous release.
    • If you have used Conventional Commit Messages it will be easy to determine what types of changes were made, allowing you to ensure the correct version tag is being published.
  5. Now ensure the version tag selected is semantically accurate based on the changes included.
  6. Click "Publish Release".
    • This will push a new tag and trigger your publishing pipeline on CircleCI.