Release v1.5 (#235)

* feat: various cleanup (#234)

* feat: update dependencies

* documentation: update documentation

.circleci/config.yml

@@ -11,7 +11,7 @@ parameters:
 jobs:
   output:
     docker:
-      - image: cimg/base:2022.08
+      - image: cimg/base:2023.08
     steps:
       - run: "echo this is an output build, the output_value is: << pipeline.parameters.output_value >>"
 

.github/CODEOWNERS

@@ -0,0 +1 @@
+* @promiseofcake

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2019 GitHub Actions
+Copyright (c) 2019 Lucas Kacher
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,38 +1,41 @@
 # promiseofcake/circleci-trigger-action
 
-Github Action to trigger workflow runs via [API call in CircleCi](https://circleci.com/docs/api/v2/#get-a-pipeline-39-s-workflows).
+Github Action to trigger workflow runs via [API call in CircleCI](https://circleci.com/docs/api/v2/#get-a-pipeline-39-s-workflows).
 
 ## Use-case
 
 This action is for a very niche-audience, individuals who are running workflows
 in CircleCI but need to perform manual runs outside the scope of the provided /
 avaialble CircleCI triggering mechanisms.
 
-One may ask, why would I use CircleCi if I am also using Github Actions? This
+One may ask, why would I use CircleCI if I am also using Github Actions? This
 action does not aim to answer that question, but if you happen to be working in
 that paradigm, hopefuly it will be of use to you.
 
-The main use case is:
+The main use cases are:
 
-* I have enabled "Only build Pull Requests" in CircleCI
-* I want to trigger builds on pushes to non-main/master branches
+1. I have enabled "Only build Pull Requests" in CircleCI and I want to trigger builds on pushes to non-main/master branches
+2. I need some way to manually kick-off a job on a given branch in CircleCI.
 
 ### Caveat
 
-Since CircleCi alraedy allows individuals to trigger builds on pushes in a pull request context, this action isn't strictly designed for that. If for some reason you want to do that, you will need to do the parsing and groking of the branch name yourself from the [Github Context](https://docs.github.com/en/free-pro-team@latest/actions/reference/context-and-expression-syntax-for-github-actions#github-context) as opposed to following the example below.
+Since CircleCI already allows individuals to trigger builds on pushes in a pull request context, this action isn't strictly designed for that. If for some reason you want to do that, you will need to do the parsing and groking of the branch name yourself from the [Github Context](https://docs.github.com/en/free-pro-team@latest/actions/reference/context-and-expression-syntax-for-github-actions#github-context) as opposed to following the example below.
 
 ## Usage
 
 Requirements:
 
-- CircleCI User API Token
-- CircleCI Configured Parameterized Workflow
+* CircleCI User API Token (exposed as GitHub secret)
+* CircleCI Configured Parameterized Workflow (configured on CircleCI)
 
 See the sample Action config:
 
 ```yaml
 name: Execute CircleCI Workflow
 
+on:
+    workflow_dispatch:
+
 jobs:
   execute:
     runs-on: ubuntu-latest
@@ -61,7 +64,7 @@ parameters:
 jobs:
   output:
     docker:
-      - image: cimg/base:2022.08
+      - image: cimg/base:2023.08
     steps:
       - run: echo "this is an output build"