This project is intended as an example (and my own, personal implementation) of how you can setup and use starter workflows to act as templates for all of your repositories.
There are 3 versions of each workflow, plus a configuration file which is read by GitHub whenever you create a new workflow using the GitHub editor.
- Standalone Workflow
- You can use these as-is in your own projects
- Reusable Workflow
- Add to your own repository of reusable workflows
- Caller for Reusable Workflow
- Call your reusable workflows from your other repositories
Currently, the following workflows are included with the project:
- Jekyll GH-Pages Tagging
- MegaLinter
When you include a workflow-templates directory as part of your personal or organisation's .github repository, GitHub will display those templates as selections whenever you create a new workflow using the New workflow button under the Actions tab for ALL of your repositories.
- Create a directory called
workflow-templatesin the root of your.githubrepository - Add your desired
template-name.ymlandtemplate-name.properties.jsonfiles to the directory.- You can optionally add
.svgfiles to use as icons for your templates, specified as theiconNameproperty of the template's.jsonproperties file.
- You can optionally add
- Add any required configuration files. You can find examples in the
template-configsdirectory.
If sponsorship isn't right for you, but you have found my work to be useful in some way,
would you please consider buying me a coffee to help keep me going?
🔐 Security
While I always good security practices, 100% security can never be guaranteed in any software package. These Workflow Templates are provided AS IS, and without warranty. You can find more details in the LICENSE file included with this repository.
If you discover any issue regarding the security of this project, please disclose that information responsibly by sending a security advisory. PLEASE DO NOT CREATE AN ISSUE OR DISCUSSION TOPIC. You can read more about this project's security policies HERE
This project incorporates ideas and / or code crafted by the following talented individuals:
"We see much further, and reach much higher,
only because we stand upon the shoulders of giants"
⚖️ License
Copyright © 2024 Redeyed Technologies
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Copyright © 2024 Redeyed Technologies