Skip to content

Latest commit

 

History

History
105 lines (73 loc) · 3.5 KB

README.md

File metadata and controls

105 lines (73 loc) · 3.5 KB
Raw

Robolectric

This repository contains the source of the documentation that lives at robolectric.org.

Contributing

Make sure that you are on the master branch, and that it is up to date before making any changes. This is the default branch, so Git should put you there automatically.

Build the documentation locally

Before submitting a Pull Request, run the documentation locally to check that the content and layout are correct. The documentation is built using MkDocs.

To do so, make sure that you have Python 3+ installed, and then install the required dependencies by running:

pip install -r requirements.txt

Then you can execute the following command to access the documentation locally at http://127.0.0.1:8000/:

mkdocs serve --open

Using code snippets

The code snippets displayed throughout the website are stored in the snippets Android project.

To use a new code snippet, follow these steps:

  1. Define your code snippet in the snippets/java module.
  2. Surround it with
// --8<-- [start:my_code_snippet_identifier]
my code snippet
// --8<-- [end:my_code_snippet_identifier]
  1. To use it in your Markdown file, use the following syntax:
```java
--8<-- "snippets/java/path/to/my/snippet/MyCodeSnippet.java:my_code_snippet_identifier"
```

Note

The migration of the code snippets to the snippets project is a work in progress. New code snippets should be added in the snippets project.

Validate your Markdown files

If you modified any Markdown file, we recommend using DavidAnson/markdownlint-cli2 to ensure that the formatting rules are respected.

Once installed, you can run the command below to perform the check. Add the --fix option to fix issues that can be addressed automatically. The non-resolved issues will be printed in the console.

markdownlint-cli2 "README.md" "docs/**/*.md" "#docs/javadoc/**/*.md" --config .markdownlint.jsonc

Once your Pull Request is merged, the documentation will be automatically built and deployed by GitHub Actions.

Javadocs

When a new version of Robolectric is released, the docs/javadoc directory needs to be updated. This can be achieved either automatically, or manually.

Automatic publication

The simplest way to publish the javadoc for a specific version is to create an issue whose title is Publish javadoc for <version>, where <version> is the version you want to deploy (for example 4.12).

This will trigger the publish-javadoc.yml workflow to build and publish the corresponding javadoc.

Tip

If you use the gh command line tool, you can use the following command:

gh issue create --title "Publish javadoc for <version>" --body ""

Manual publication

To manually publish the javadoc, you can follow the guide in Robolectric Wiki's release part.

Deploy process

When a new PR is merged, GitHub Actions will build and push site code to gh-pages branch. The repository has configured to deploy the site with gh-phages branch, and then GitHub Pages will deploy the site public automatically.