7b81dc44e5
This new release is published using GitHub Packages rather than JitPack. This comes with a simpler release setup and a (hopefully) more stable package repository. A minor downside is that GitHub Packages require authenticated access, even for read access. The documentation has been updated accordingly. The new release is no longer published using a custom groupId, enabling some build simplifications. While there, some obsolete fork-related documentation and configuration is dropped. See: - https://github.com/PicnicSupermarket/error-prone/releases/tag/v2.36.0-picnic-2 - https://github.com/PicnicSupermarket/error-prone/compare/v2.36.0-picnic-1...v2.36.0-picnic-2
Error Prone Support website
This directory contains the majority of the source code that powers error-prone.picnic.tech. The website is statically generated using Jekyll.
Local development
To view the website on localhost, first follow the Jekyll installation
instructions. Once done, in this directory execute:
bundle install
../generate-docs.sh && bundle exec jekyll serve --livereload
The website will now be available on port 4000. Source
code modifications (including the result of rerunning ../generate-docs.sh)
will automatically be reflected. (An exception is _config.yml: changes to
this file require a server restart.) Subsequent server restarts do not require
running bundle install, unless Gemfile has been updated in the interim.
If you are not familiar with Jekyll, be sure to check out its documentation. It is recommended to follow the provided step-by-step tutorial.
We use the Just the Docs Jekyll theme, which also includes several configuration options.
Switch Ruby versions
The required Ruby version is set in .ruby-version. To switch, you can use
rvm to manage your Ruby version.
Resolve Bundler issues
On macOS, you may get an error such as the following when running bundle install:
fatal error: 'openssl/ssl.h' file not found
In that case, run:
bundle config build.eventmachine --with-cppflags="-I$(brew --prefix openssl)/include"
bundle install
Deployment
The website is regenerated and deployed using the
deploy-website.yml GitHub
Actions workflow any time a change is merged to master.