An open API service indexing awesome lists of open source software.

https://github.com/eksperimental/maintenance


https://github.com/eksperimental/maintenance

Last synced: 12 months ago
JSON representation

Awesome Lists containing this project

README

          

# Maintenance BEAM

[`Maintenance` BEAM project](https://github.com/eksperimental/maintenance) is an app which aims to automatize tasks in codebases of the Elixir, Erlang, or any other project using a Git repository (only GitHub is initially supported).

## Feature Requests & Bug reports

Feel free to open up an issue with your request/report.

## Usage

- 1. Store `SECRET_KEY_BASE` and `GITHUB_ACCESS_TOKEN` in `.env`. You can use `.sample_env` as a base.
- 2. Make sure `.env` is loaded. If you run `source .env` in your terminal.
- 3. Run `iex -S mix phx.server`.

The following commands can be run within IEx.

```elixir
# List projects
iex> Maintenance.projects()
[:otp]

# List jobs for a project
iex> Maintenance.jobs(:otp)
[:unicode]

# To run a specific job for a certain project
iex> Maintenance.Runner.update(:otp, :unicode)
{:ok, :no_update_needed}
```

## Contact

Eksperimental

## License

No Copyright

This work is released to the
[Public Domain](https://creativecommons.org/publicdomain/mark/1.0/) and multi-licensed under the
[Creative Commons Zero Universal version 1.0 license](https://creativecommons.org/publicdomain/zero/1.0/),
the [MIT No Attribution license](https://spdx.org/licenses/MIT-0.html),
and the [BSD Zero Clause license](https://opensource.org/licenses/0BSD).

You can choose between one of them if you use this work.

The author, [Eksperimental](https://github.com/eksperimental) has dedicated the work to the
public domain by waiving all copyright and related or neighboring rights to this work worldwide
under copyright law including all related and neighboring rights, to the extent allowed by law.

You can copy, modify, distribute and create derivative work, even for commercial purposes, all
without asking permission. Giving credits is appreciated though;
you may link to this repository if you wish.



Public Domain Mark



Creative Commons Zero

Check the [NOTICE](NOTICE),
[LICENSES/LICENSE.CC0-1.0.txt](LICENSES/LICENSE.CC0-1.0.txt),
[LICENSES/LICENSE.MIT-0.txt](LICENSES/LICENSE.MIT-0.txt),
[LICENSES/LICENSE.0BSD.txt](LICENSES/LICENSE.0BSD.txt) files for more information.

`SPDX-License-Identifier: CC0-1.0 or MIT-0 or 0BSD`