Boilerplate for creating an actions repository.
Please consider following this project's author, Brian Woodward, and consider starring the project to show your ❤️ and support.
This boilerplate can be used for creating a repository that uses GitHub Actions for scheulding and running tasks. To get started using this boilerplate, follow along with the steps below:
Three steps
Let's walk through each step.
Download this boilerplate with the following command:
$ git clone https://github.com/transparent/actions-template.gitNext, update the default task or add new tasks to the tasks folder:
my-task.js
'use strict'
module.exports = async options => {
console.log('This task is run with the command line arguments passed in as an `options` object.');
console.log(options);
};Notes
- Update the tasks index file to include your new task:
module.exports = { default: require('./default'), 'my-task': require('./my-task') };
A default workflow file is included that will run the default task daily at 8AM UTC.
You can modify this file to change the time or specify another task or options to run.
You can also create new workflow files to run more tasks or schedule tasks to run at different times.
TODO: workflow file generator
Contributing
Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.
Please read the contributing guide for advice on opening issues, pull requests, and coding standards.
Running Tests
Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:
$ npm install && npm testBuilding docs
(This project's readme.md is generated by verb, please don't edit the readme directly. Any changes to the readme must be made in the .verb.md readme template.)
To generate the readme, run the following command:
$ npm install -g verbose/verb#dev verb-generate-readme && verbBrian Woodward
Copyright © 2020, Brian Woodward. Released under the MIT License.
This file was generated by verb-generate-readme, v0.8.0, on January 23, 2020.