From 8e958807f46cc80304ce1da1b784be42ceea05c5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ga=C3=ABtan=20Muller?= Date: Sun, 3 Nov 2024 10:59:25 +0100 Subject: [PATCH] Lint root `README.md` file (#345) --- .github/workflows/lint-markdown.yml | 1 + README.md | 51 +++++++++++++++++++---------- 2 files changed, 34 insertions(+), 18 deletions(-) diff --git a/.github/workflows/lint-markdown.yml b/.github/workflows/lint-markdown.yml index 5bda10cf4..27498ab27 100644 --- a/.github/workflows/lint-markdown.yml +++ b/.github/workflows/lint-markdown.yml @@ -22,5 +22,6 @@ jobs: with: config: ".markdownlint.jsonc" globs: | + "README.md" "docs/**/*.md" "#docs/javadoc/**/*.md" diff --git a/README.md b/README.md index a07b16636..a398ea880 100644 --- a/README.md +++ b/README.md @@ -1,22 +1,27 @@ # Robolectric -This repository contains the source of the documentation that lives at [robolectric.org](https://robolectric.org). +This repository contains the source of the documentation that lives at +[robolectric.org](https://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. +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](https://www.mkdocs.org/). +Before submitting a Pull Request, run the documentation locally to check that the content and layout +are correct. The documentation is built using [MkDocs](https://www.mkdocs.org/). -To do so, make sure that you have [Python 3+ installed](https://www.python.org/downloads/), and then install the required dependencies by running: +To do so, make sure that you have [Python 3+ installed](https://www.python.org/downloads/), and then +install the required dependencies by running: ```bash pip install -r requirements.txt ``` -Then you can execute the following command to access the documentation locally at http://127.0.0.1:8000/: +Then you can execute the following command to access the documentation locally at +[http://127.0.0.1:8000/](http://127.0.0.1:8000/): ```bash mkdocs serve --open @@ -38,6 +43,7 @@ my code snippet // --8<-- [end:my_code_snippet_identifier] ``` + 3. To use it in your Markdown file, use the following syntax: ````markdown @@ -53,38 +59,47 @@ my code snippet ### Validate your Markdown files -If you modified any Markdown file, we recommend using [`DavidAnson/markdownlint-cli2`](https://github.com/DavidAnson/markdownlint-cli2) to ensure that the formatting rules are respected. +If you modified any Markdown file, we recommend using +[`DavidAnson/markdownlint-cli2`](https://github.com/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. +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. ```bash -markdownlint-cli2 "docs/**/*.md" "#docs/javadoc/**/*.md" --config .markdownlint.jsonc +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. +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`](docs/javadoc) directory needs to be updated. This can be achieved either automatically, or manually. +When a new version of Robolectric is released, the [`docs/javadoc`](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](https://github.com/robolectric/robolectric.github.io/issues/new) whose title is `Publish javadoc for `, where `` is the version you want to deploy (for example `4.12`). +The simplest way to publish the javadoc for a specific version is to +[create an issue](https://github.com/robolectric/robolectric.github.io/issues/new) whose title is +`Publish javadoc for `, where `` is the version you want to deploy (for example +`4.12`). -This will trigger the [`publish-javadoc.yml` workflow](.github/workflows/publish-javadoc.yml) to build and publish the corresponding javadoc. +This will trigger the [`publish-javadoc.yml` workflow](.github/workflows/publish-javadoc.yml) to build and publish the corresponding +javadoc. > [!TIP] > If you use the [`gh`](https://cli.github.com/) command line tool, you can use the following command: -> +> > `gh issue create --title "Publish javadoc for " --body ""` ### Manual publication -To manually publish the javadoc, you can follow the guide in [Robolectric Wiki's release part](https://github.com/robolectric/robolectric/wiki/Performing-a-Release#update-docs). +To manually publish the javadoc, you can follow the guide in +[Robolectric Wiki's release part](https://github.com/robolectric/robolectric/wiki/Performing-a-Release#update-docs). ## 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. +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.