Giter VIP home page Giter VIP logo

orb-project-template's Introduction

Orb Project Template

A starter template for orb projects. Build, test, and publish orbs automatically on CircleCI with Orb-Tools.

Additional READMEs are available in each directory.

Meta: This repository is open for contributions! Feel free to open a pull request with your changes. Due to the nature of this repository, it is not built on CircleCI. The Resources and How to Contribute sections relate to an orb created with this template, rather than the template itself.

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 and creating CircleCI Orbs.

How to Contribute

We welcome issues to and pull requests against this repository!

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:<segment>] 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.

orb-project-template's People

Contributors

aaronstillwell avatar digitalmaster avatar gmemstr avatar kelvintaywl avatar kyletryon avatar nbialostosky avatar ntmarktnoonan avatar teesloane avatar ubaumann avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

orb-project-template's Issues

development broken after 90 days

Orb version:

latest

What happened:

The dev version of myorg/cdk@dev:alpha has expired. Dev versions of orbs are only valid for 90 days after publishing.

Expected behavior:

it should build as it did in the first 90 days. what do we need to do to recover from this error?

Additional Information:

CircleCI CLI validation error with shell script include

Orb version:

1.1.4

What happened:

Packing and validating this repo gives an error referencing the shell script:

$ circleci config pack src | circleci orb validate -

Error: Error calling command: 'greet'
Unclosed '<<' tag in string: '<<include(scripts/greet.sh)>>'
('<<' must be escaped as '\<<' in config v2.1+)
Error calling job: 'hello'
Error calling command: 'greet'
Unclosed '<<' tag in string: '<<include(scripts/greet.sh)>>'
('<<' must be escaped as '\<<' in config v2.1+)

Expected behavior:

The orb should validate successfully.

Additional Information:

$ circleci version

0.1.11458+44f80c2 (homebrew)

Enhancement: Provide shell example in README.md

Provide a comment on shell usage for different languages in scripts/README.md: https://github.com/CircleCI-Public/Orb-Project-Template/tree/master/src/scripts

ex:

steps:
  - run:
      environment:
        PARAM_TO: <<parameters.to>
      name: Hello <<parameters.to>
      shell: /bin/sh  # Not required for shell scripts, but useful for other shell environments i.e. python
      command: <<include(scripts/greet.sh)>>

This would help users who may expect the included script to execute without declaring the shell parameter: #25

Example doesn't seem to validate

Orb version: 2.1

Cloned this repo and attempted to pack and validate

What happened:

image

Expected behavior:

It should validate successfully

Orb Badge

Is there a way we can get the new orb badge in here in order to promote its usage?

Allow to set the default branch on `circle orb init`

Orb version:

What happened:

The job orb-tools/dev-promote-prod-from-commit-subject on integration-test_deploy workflow on Circle CI configuration doesn't work for the new repository, because since October 1, GitHub allows developers to set default branch, and the default value of it is main, not master.

Expected behavior:

circleci orb init allows us to set the default branch.

Additional Information:

Unable to add new command/job and a test for it in the same commit

Orb version:

Which orb?

What happened:

When using the Orb-Project-Template, if you create a commit for the orb you are working on that contains both a new command or job and an integration test for it, workflow execution will fail with a message similar to:

Error calling workflow: 'integration-test_deploy'Error calling job: 'integration-test-3'Cannot find a definition for command named cci-orb/test2

Expected behavior:

Being able to add a command and a test for it in the same commit.

If that is not possible to fix, clear documentation about this limitation in the readme would be appreciated.

Additional Information:

The workaround I've been using is to add another commit with the test removed from .circleci/config.yml and push it. Once that has been built and deployed you can then drop the commit, force push and finally get to where you wanted to be in the first place.

Looks like other people are also encountering the problem for example https://discuss.circleci.com/t/jobs-in-private-orbs-not-recognized-by-integration-tests/42812

allow include python script

Describe Request:

Allow to execute python script command like actually do with bash.

Example:

`
parameters:
to:
type: string
default: "World"
description: "Hello to whom?"
steps:

  • run:
    environment:
    PARAM_TO: <<parameters.to>>
    name: Hello Greeting
    command: <<include(scripts/greet.py)>>
    `

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.