-
Notifications
You must be signed in to change notification settings - Fork 576
build: migrate to uv, drop pip #1324
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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" | ||
| publish = "site/" | ||
| environment = { PYTHON_VERSION = "3.8.13" } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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" |
Large diffs are not rendered by default.
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.