umts-auth

Authentication for UMTS rails apps.

Documentation and usage instructions are hosted on github pages.

Contributing

Bug reports and pull requests are welcome on GitHub.

Due to automatic version detection in our release process, all commits to the master branch must follow conventional commits formatting. Pay close attention to this when squashing your PRs and setting your commit messages on the main branch.

Development

• gem distribution files are located in app/, config/ and lib/

Requirements

• ruby
• node.js

Setup

bin/setup

Scripts

bin/dev           # development rails server
bin/haml-lint     # haml linter
bin/rails         # manage development rails server
bin/rake          # invoke task runner
bin/rspec         # tests
bin/rubocop       # ruby linter
bin/setup         # setup script
npm run docs      # build and serve documentation locally
npm run fmt       # formatter
npm run fmt:check # formatter (without corrections)
npm run lint      # javascript linter
npm run lint:css  # css linter

Release

Releases are (mostly) automated using semantic-release. It can be run using the release.yml github action, which has a manual workflow_dispatch trigger.

Again, all commits to the master branch must follow conventional commits format. Verify that all commits since the last release adhere to the standard before triggering a release.

License

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