Skip to content
Release tracker that posts updates into Matrix rooms
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
bin
lib
test
.dockerignore
.gitignore
.rubocop.yml
.travis.yml
Dockerfile
Gemfile
LICENSE.txt
README.md
Rakefile
matrix_releasetracker.gemspec

README.md

Matrix Releasetracker

For more information, questions, or just the use of the hosted version, you can visit #releasetracker:kittenface.studio.

Example image

Usage

The bin/tracker binary will track and post updates on new GitHub releases, it requires a releasetracker.yml configuration file that it can read and write to.

Example config:

---
:backends:
- :access_token: 0000000000000000000000000000000000000000
  :type: github
  :users:
  - :name: ananace
    :room: '!exampleroomid:kittenface.studio'
  - :name: github
    :room: '!exampleroomid:matrix.org'
:client:
  :hs_url: https://kittenface.studio
  :access_token: <token>

Example systemd unit:

# ~/.config/systemd/user/matrix-releasetracker.service
[Unit]
Description=Release tracker for Matrix

[Service]
Type=simple
WorkingDirectory=/home/ace/Projects/ruby-matrix-releasetracker
ExecStart=/bin/bash -lc 'bundle exec bin/tracker'
Restart=on-failure

[Install]
WantedBy=default.target

TODO

  • Store data in an actual database, not the config file

  • Track releases in separate data structures - maybe partially on Matrix, map against update timestamps on each user

    • Allow requesting pre-release releases as well (Will require proper data storage)
    • Don't lose releases when multiple releases are done a short period
  • Improve markdown rendering and release note splitting (optional per user)

  • Implement bot-like bang commands to add/remove users and per-user configuration

  • Properly handle releases on moving tags (e.g. neovim/neovim nightly)

  • Handle PGP signatures better, don't just print the signature

  • Use GraphQL for the GitHub queries? (Doesn't seem to be possible with OAuth apps at the moment)

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/ananace/matrix_releasetracker

License

The gem is available as open source under the terms of the MIT License.

You can’t perform that action at this time.