Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions .circleci/config.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
version: 2.1
orbs:
ruby: circleci/ruby@2.5.4
python: circleci/python@3.3.0
python: circleci/python@4.0.0

jobs:
"Test":
Expand All @@ -11,9 +11,9 @@ jobs:
steps:
- checkout
- python/install-packages:
pkg-manager: pipenv
pkg-manager: uv
- ruby/install-deps
- run: pipenv run bundle exec fastlane test
- run: uv run bundle exec fastlane test
- run: bundle exec rubocop
- run: bundle exec danger || echo "danger failed, moving on"
"Deploy":
Expand All @@ -23,9 +23,9 @@ jobs:
steps:
- checkout
- python/install-packages:
pkg-manager: pipenv
pkg-manager: uv
- ruby/install-deps
- run: pipenv run ./scripts/ci/deploy.sh
- run: uv run ./scripts/ci/deploy.sh

workflows:
version: 2
Expand Down
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,9 @@ site/
.keys
*.swp
vendor/bundle
.venv

# these files are generated during documentation build
docs/actions.md
docs/actions
docs/plugins/available-plugins.md
20 changes: 0 additions & 20 deletions Pipfile

This file was deleted.

364 changes: 0 additions & 364 deletions Pipfile.lock

This file was deleted.

38 changes: 7 additions & 31 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,34 +1,10 @@
# fastlane docs
_This repository contains all documentation for fastlane. You can access the `.md` files inside the [docs](docs) folder._

This repository contains all documentation for fastlane. You can access the `.md` files inside the [docs](docs) folder.
## Setup
1. Install [uv](https://docs.astral.sh/uv/getting-started/installation/)
2. `uv sync` to install dependencies
3. `uv run mkdocs serve` to preview the documentation locally

To preview the updated documentation locally, just clone the repo, modify the file, and run the command. Note that some of the files are in [generated](docs/generated) folder and are later copied with `mkdocs` pre-build hook.

```
mkdocs serve
```

The live version is available on [docs.fastlane.tools](https://docs.fastlane.tools).

## Why new docs?

You can find more information [here](https://github.com/fastlane/docs/issues/5)

## Deploy changes

Once a pull request (PR) is merged into master, the latest version will automatically be deployed to [docs.fastlane.tools](https://docs.fastlane.tools) by one of the hard-working fastlane bots. There is no need to perform any manual actions. The resulting HTML files are stored in the [`gh-pages`](https://github.com/fastlane/docs/tree/gh-pages) branch.

## Installation of [mkdocs](http://www.mkdocs.org/)

```sh
brew install python3 # if you don't have pip already
brew install pipenv
pipenv --three
# install dependencies from Pipfile.lock and run shell
pipenv install
pipenv shell
```

## Adding a Python dependency

Likely, to add a [Markdown extension](https://pythonhosted.org/Markdown/extensions/), install it with `pipenv install <some extension>` after making sure the virtualenv is loaded (`pipenv shell`).
## Deploy
1. Changes to `master` are automatically deployed to [docs.fastlane.tools](https://docs.fastlane.tools)
2 changes: 1 addition & 1 deletion netlify.toml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
[build]
command = "mkdocs build"
command = "curl -LsSf https://astral.sh/uv/install.sh | sh; uv sync; uv run mkdocs build"
Comment thread
iBotPeaches marked this conversation as resolved.
publish = "site/"
environment = { PYTHON_VERSION = "3.8.13" }
25 changes: 25 additions & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
[project]
name = "docs.fastlane.tools"
version = "0.0.1"
requires-python = ">=3.8.13"
dependencies = [
"markdown-include",
"mdx-truly-sane-lists",
"mkdocs",
"mkdocs-bootstrap",
"mkdocs-bootswatch",
"mkdocs-simple-hooks",
"pymdown-extensions",
"importlib-metadata",
"typing-extensions",
]

[dependency-groups]
dev = []

[tool.uv]
package = false

[[tool.uv.index]]
name = "pypi"
url = "https://pypi.python.org/simple"
447 changes: 447 additions & 0 deletions uv.lock

Large diffs are not rendered by default.

Loading