Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/vkatsuba/rebar3_plugin
The rebar3 plugin template
https://github.com/vkatsuba/rebar3_plugin
erlang rebar3 rebar3-plugin rebar3-template
Last synced: 4 months ago
JSON representation
The rebar3 plugin template
- Host: GitHub
- URL: https://github.com/vkatsuba/rebar3_plugin
- Owner: vkatsuba
- License: apache-2.0
- Created: 2021-10-27T10:45:51.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-03-25T19:02:42.000Z (almost 2 years ago)
- Last Synced: 2024-05-02T00:22:07.311Z (9 months ago)
- Topics: erlang, rebar3, rebar3-plugin, rebar3-template
- Language: Erlang
- Homepage: https://medium.com/erlang-battleground/the-rebar3-plugin-a-simple-rebar3-template-to-fast-build-your-plugins-71ab0129456b
- Size: 19.5 KB
- Stars: 16
- Watchers: 3
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# rebar3_plugin
A `rebar_plugin` is a simple [rebar3](http://rebar3.org) `GitHub` template which includes
the basic functionality that will be used in any `rebar3` plugin, as well as a ready-made template for `GitHub Actions`, `GitHub Issue Templates`, and the configuration for some useful tools like `dialyzer`, `xref`, `hank`, etc.
## How it works
* On the main page of this repository, you should find and click a button called `Use this template`.
* Add `Repository name` and `Description` for your particular plugin.
* Then clone and build your template plugin and push it into your GitHub repository
* Finally, run `./bootsrap` to setup your repository using the name you've chosen.
```sh
$ git clone https://github.com/yourname/your_rebar3_plugin_repo.git
$ cd your_rebar3_plugin_repo
$ ./bootstrap
$ git add .
$ git commit -m "Base rebar3 template"
$ git push origin main
```
## Commands
Currently supports the following commands:
* `bootstrap` - build by default with adding useful tools like `dialyzer`, `xref`, `hank`, etc
```sh
$ ./bootstrap
$ tree -a
├── .github
│ ├── ISSUE_TEMPLATE
│ │ ├── bug_report.md
│ │ ├── feature_request.md
│ │ └── other_issues.md
│ └── workflows
│ └── ci.yaml
├── src
│ ├── rebar3_plugin.app.src
│ ├── rebar3_plugin.erl
│ └── rebar3_plugin_prv.erl
└── test
└── rebar3_plugin_SUITE.erl
├── .gitignore
├── LICENSE
├── README.md
├── CHANGELOG.md
├── rebar.config
├── elvis.config
├── rebar.lock
```
* `bootstrap clean` - build without adding useful tools, configs, GitHub folder
```sh
$ ./bootstrap
$ tree -a
├── src
│ ├── rebar3_plugin.app.src
│ ├── rebar3_plugin.erl
│ └── rebar3_plugin_prv.erl
└── test
└── rebar3_plugin_SUITE.erl
├── .gitignore
├── LICENSE
├── README.md
├── CHANGELOG.md
├── rebar.config
├── rebar.lock
```