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

chore: Update boilerplate files #1

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .circleci/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,14 +16,14 @@ workflows:
- orb-tools/pack:
filters: *filters
- orb-tools/review:
orb_name: <orb-name>
orb_name: trigger-pipeline
filters: *filters
- shellcheck/check:
filters: *filters
# Triggers the next workflow in the Orb Development Kit.
- orb-tools/continue:
pipeline_number: << pipeline.number >>
vcs_type: << pipeline.project.type >>
orb_name: <orb-name>
orb_name: trigger-pipeline
requires: [orb-tools/lint, orb-tools/pack, orb-tools/review, shellcheck/check]
filters: *filters
8 changes: 4 additions & 4 deletions .circleci/test-deploy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ orbs:
# Reference your orb's jobs and commands below as they will exist when built.
orb-tools: circleci/[email protected]
# The orb definition is intentionally not included here. It will be injected into the pipeline.
<orb-name>: {}
trigger-pipeline: {}

# Use this tag to ensure test jobs always run,
# even though the downstream publish job will only run on release tags.
Expand All @@ -28,7 +28,7 @@ jobs:
steps:
- checkout
# Run your orb's commands to validate them.
- <orb-name>/greet
- trigger-pipeline/greet
workflows:
test-deploy:
jobs:
Expand All @@ -40,12 +40,12 @@ workflows:
- orb-tools/pack:
filters: *release-filters
- orb-tools/publish:
orb_name: <namespace>/<orb-name>
orb_name: circleci/trigger-pipeline
vcs_type: << pipeline.project.type >>
pub_type: production
# Ensure this job requires all test jobs and the pack job.
requires:
- orb-tools/pack
- command-test
context: <publishing-context>
context: orb-publisher
filters: *release-filters
1 change: 1 addition & 0 deletions .github/CODDEOWNERS
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
* @CircleCI-Public/orb-publishers
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/BUG.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ body:
- type: checkboxes
attributes:
label: "Is there an existing issue for this?"
description: "Please search [here](https://github.com/<organization>/<project-name>/issues?q=is%3Aissue) to see if an issue already exists for the bug you encountered"
description: "Please search [here](https://github.com/CircleCI-Public/trigger-pipeline-orb/issues?q=is%3Aissue) to see if an issue already exists for the bug you encountered"
options:
- label: "I have searched the existing issues"
required: true
Expand All @@ -16,7 +16,7 @@ body:
attributes:
label: "Orb version"
description: |
Which version of `<namespace>/<orb-name>` are you using?
Which version of `circleci/trigger-pipeline` are you using?
placeholder: "1.0.0"

- type: textarea
Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/FEATURE_REQUEST.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ body:
- type: checkboxes
attributes:
label: "Is there an existing issue that is already proposing this?"
description: "Please search [here](https://github.com/CircleCI-Public/circleci-config-sdk-ts/issues?q=is%3Aissue) to see if an issue already exists for the feature you are requesting"
description: "Please search [here](https://github.com/CircleCI-Public/trigger-pipeline-orb/issues?q=is%3Aissue) to see if an issue already exists for the feature you are requesting"
options:
- label: "I have searched the existing issues"
required: true
Expand Down
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
MIT License

Copyright (c) 2023 <organization>
Copyright (c) 2024 CircleCI Public

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
27 changes: 9 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,34 +1,25 @@
# Orb Template
# Trigger Pipeline Org

<!---
[![CircleCI Build Status](https://circleci.com/gh/<organization>/<project-name>.svg?style=shield "CircleCI Build Status")](https://circleci.com/gh/<organization>/<project-name>) [![CircleCI Orb Version](https://badges.circleci.com/orbs/<namespace>/<orb-name>.svg)](https://circleci.com/developer/orbs/orb/<namespace>/<orb-name>) [![GitHub License](https://img.shields.io/badge/license-MIT-lightgrey.svg)](https://raw.githubusercontent.com/<organization>/<project-name>/master/LICENSE) [![CircleCI Community](https://img.shields.io/badge/community-CircleCI%20Discuss-343434.svg)](https://discuss.circleci.com/c/ecosystem/orbs)
[![CircleCI Build Status](https://circleci.com/gh/CircleCI-Public/trigger-pipeline-orb.svg?style=shield "CircleCI Build Status")](https://circleci.com/gh/CircleCI-Public/trigger-pipeline-orb) [![CircleCI Orb Version](https://badges.circleci.com/orbs/circleci/trigger-pipeline.svg)](https://circleci.com/developer/orbs/orb/circleci/trigger-pipeline) [![GitHub License](https://img.shields.io/badge/license-MIT-lightgrey.svg)](https://raw.githubusercontent.com/CircleCI-Public/trigger-pipeline-orb/main/LICENSE) [![CircleCI Community](https://img.shields.io/badge/community-CircleCI%20Discuss-343434.svg)](https://discuss.circleci.com/c/ecosystem/orbs)

--->

A project template for Orbs.

This repository is designed to be automatically ingested and modified by the CircleCI CLI's `orb init` command.

_**Edit this area to include a custom title and description.**_

---
<!-- TBD. --->

## Resources

[CircleCI Orb Registry Page](https://circleci.com/developer/orbs/orb/<namespace>/<orb-name>) - The official registry page of this orb for all versions, executors, commands, and jobs described.
[CircleCI Orb Registry Page](https://circleci.com/developer/orbs/orb/circleci/trigger-pipeline) - The official registry page of this orb for all versions, executors, commands, and jobs described.

[CircleCI Orb Docs](https://circleci.com/docs/orb-intro/#section=configuration) - Docs for using, creating, and publishing CircleCI Orbs.

### How to Contribute

We welcome [issues](https://github.com/<organization>/<project-name>/issues) to and [pull requests](https://github.com/<organization>/<project-name>/pulls) against this repository!
We welcome [issues](https://github.com/CircleCI-Public/trigger-pipeline-orb/issues) to and [pull requests](https://github.com/CircleCI-Public/trigger-pipeline-orb/pulls) against this repository!

### How to Publish An Update
1. Merge pull requests with desired changes to the main branch.
- For the best experience, squash-and-merge and use [Conventional Commit Messages](https://conventionalcommits.org/).
2. Find the current version of the orb.
- You can run `circleci orb info <namespace>/<orb-name> | grep "Latest"` to see the current version.
3. Create a [new Release](https://github.com/<organization>/<project-name>/releases/new) on GitHub.
- You can run `circleci orb info circleci/trigger-pipeline | grep "Latest"` to see the current version.
3. Create a [new Release](https://github.com/CircleCI-Public/trigger-pipeline-orb/releases/new) on GitHub.
- Click "Choose a tag" and _create_ a new [semantically versioned](http://semver.org/) 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"_.
Expand All @@ -48,14 +39,14 @@ A [Development orb](https://circleci.com/docs/orb-concepts/#development-orbs) ca

```yaml
- orb-tools/publish:
orb_name: <namespace>/<orb-name>
orb_name: circleci/trigger-pipeline
vcs_type: << pipeline.project.type >>
pub_type: dev
# Ensure this job requires all test jobs and the pack job.
requires:
- orb-tools/pack
- command-test
context: <publishing-context>
context: orb-publisher
filters: *filters
```

Expand Down
4 changes: 2 additions & 2 deletions src/@orb.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@ description: >

# This information will be displayed in the orb registry and is not mandatory.
display:
home_url: "https://www.example.com/docs"
source_url: "https://github.com/<organization>/<project-name>"
home_url: "https://github.com/CircleCI-Public/trigger-pipeline-orb"
source_url: "https://github.com/CircleCI-Public/trigger-pipeline-orb"

# If your orb requires other orbs, you can import them like this. Otherwise remove the "orbs" stanza.
# orbs:
Expand Down
4 changes: 2 additions & 2 deletions src/examples/example.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ description: >
usage:
version: 2.1
orbs:
<orb-name>: <namespace>/<orb-name>@1.2.3
trigger-pipeline: circleci/[email protected]
workflows:
use-my-orb:
jobs:
- <orb-name>/<job-name>
- trigger-pipeline/hello