fastlane / docs Goto Github PK
View Code? Open in Web Editor NEWAll the fastlane docs
Home Page: https://docs.fastlane.tools
All the fastlane docs
Home Page: https://docs.fastlane.tools
https://docs.fastlane.tools/ still contains lots of outdated links that are a) redirected to the correct new places or b) land on Github READMEs with links to the correct new places.
Crawl complete website, fix all files.
available_options
already contains information about if a param is optional, if there is a default value for a param, and if there is a environment variable that can be used to set an action parameter.
This should be surfaced in the param table of the action documentation somehow.
Ideas:
<details>
) thingie next to descriptionThe list of actions could really benefit from a filter for supported platforms.
A simple implementation would give each action a class. Above the list of actions it would output a checkbox per platform. Unselecting or selecting a checkbox toggles (shows/hides) the class. Additionally, the selected/unselected checkboxes could be saved in a cookie.
Using a markdown parser extension (which we can define in mkdocs.yml
we could have those nice colourful boxes in our docs: https://facelessuser.github.io/pymdown-extensions/
To render the box, only the following code is needed
!!! Caution "Reminder"
Please read the [Usage Notes](usage_notes.md) for information on extension compatibility and general notes to be aware of when using these extensions.
I'd love to start using these boxes for things like:
gem cleanup
use_legacy_build_api
optionWould love everyone's opinion about where we can use them and how much 👍
Before the move to the new docs on Github there was a table of all the "main" actions linked on the main README and all the linked pages (the main actions). This seems to be gone now, which might make getting started with Fastlane a lot harder.
Search for "cordova":
Clicking the link "only" goes to https://docs.fastlane.tools/plugins/available-plugins/#available-plugins - not to an anchor which scrolls to the Cordova plugin (as it does not exist).
I am using following lane to upload symbols to crashlytics:
lane :refresh_dsyms do
download_dsyms # Download dSYM files from iTC
upload_symbols_to_crashlytics # Upload them to Crashlytics
clean_build_artifacts # Delete the local dSYM files
end
Issue#1 - It always fetches all dSYM files and upload it, there is no way to keep track of already uploaded symbols.
Issue#2 - If there dSYM file is already dowloaded, it still downloads it again, and use the newly downloaded.
This should happen automatically. Also we have to make sure to properly set the tag to not give control over the tab to the external page
Example: https://docs.fastlane.tools/advanced/
Here the headline level is used to push entries into the left navigation. For this to work, the headlines have to be on the same level #
as the main document headline which means the general headline hierarchy is broken.
This could be fixed by
a) allowing ##
headlines to appear in the navigation or
b) finding another way to "promote" headlines to the left navigation or
c) fix the navigation problem in a totally different way (#456).
I have installed xcode-select and fastlane. When I run "fastlane init", It show the error
I am trying to copy file from one folder to another folder using shell commands but we couldn't able to do this operation. Below is the command which we are trying it out. Could you please help me whether I am doing something wrong here.
sh("cp Sample\ Source\ Directory/Sub\ Directory/GoogleService-Info.plist Sample\ Destination\ Directory")
Thanks,
Giribabu R
This documentation could be more technical and refer explicitly to the attributes in the action ruby file etc so it is clearer which is which.
I would like to suggest some improvements to the code signing documentation under the Xcode 8 section. This is my first time using Xcode and fastlane (inherited from another dev) so keep that in mind when I mention my pain points. They may not be pain points for the vast majority of users.
https://github.com/fastlane/docs/blame/master/docs/codesigning/xcode-project.md#L27
I spent quite a few hours trying to get code signing working again, because we had multiple targets that had to be built with separate certificates, and I was attempting to setup configuration via the Build Settings
tab which is now deprecated.
I feel this line needs much more emphasis, including updating the associated screenshot:
You can now specify which provisioning profile to use in the General tab after disabling Automatically manage signing.
The screenshot does not show Automatically manage signing, so it was easy for me to skip past. Honestly, I couldn't find the General/Signing page for quite awhile. And since I did find the Build Settings tab, I focused a lot of my attentions there.
So my suggestions would be:
Update the screenshot showing the General/Signing settings to show the Automatically manage signing unticked
Drop the Alternatively section that describes the Build Settings tab, which is deprecated from XCode 8.3 anyway, and doesn't seem to work in isolation.
I hope this feedback is useful.
https://docs.fastlane.tools/plugins/available-plugins/ could have linkable anchors for the individual plugins that could be used to link to a specific plugin (like would be useful in search results for example).
Change fastlane/fastlane@5c58300 to https://github.com/fastlane/fastlane/blob/master/fastlane/docs/Advanced.md is not propagated to https://docs.fastlane.tools/advanced/
There is old content at https://docs.fastlane.tools/advanced/
Hello there i am trying to use fastlane in a bambo job at first it asked me to share the scheme in xcode. I did that after i ran the job again and it is saying Code signing is required for product type 'Application' in SDK 'iOS 10.2'�
this is the code in the job:
cd /Users/bamboo/app
fastlane beta
Is there anything i have missed configuring the job, the job is just a simple console job
We have a lot of advanced information, that we need to have somewhere, but we don't want them to fill up the whole sidebar and confuse users.
We need a way to somewhere hide those pages, but still be able to link to them
Basically what https://facelessuser.github.io/pymdown-extensions/ does. It's probably a markdown plugin, I'd love to start using it, as it looks much more polished than https://docs.fastlane.tools 👍
https://docs.fastlane.tools/ and https://github.com/fastlane/docs/blob/master/docs/index.md#using-the-fabric-app contain this:
If you're not familiar with the terminal and prefer a graphical user interface, download the Fabric app and use the built-in fastlane button.
I couldn't find this app and also not pulic documantation about it or a "fastlane button". Can someone please point me in the right direction?
I think the Available Plugins page could be improved to show the user more information inline, so the user doesn't have to go to the plugin's repo and check the Readme. I personally like the section on Danger.Systems with information about plugins.
Is this already documented somewhere?
Can this documentation be generated?
What would have to change so this can be done?
Do we use?
fastlane
yo yoI am not able to find any documentation regarding the 'sh' action. Neither in https://docs.fastlane.tools/actions nor fastlane actions
I am happy to create a description based on the code of the sh_helper.rb, but not sure how to include it in the docs.
Please may you advise?
... should better be unter "Actions" somehow.
https://docs.fastlane.tools/plugins/create-plugin/#local-actions
Maybe change the list of Actions to "Available Actions" and add a "Create your own action" menu point equivalent to how it is done with plugins?
Hello!
You have such a nice custom CSS for the documentation site, and I'm wondering if you allow to re-use it.
I did not found any notes about the license of this repository, so before stealing your code I decided to ask first 😇
Example: https://docs.fastlane.tools/actions/gym/
"Actions" in navigation is not expanded, "Building" is not highlighted.
Problem:
I am looking for a way to copy files using fastlane. I google for "fastlane copy file". This returns on position #3 a result to https://github.com/fastlane/fastlane/blob/master/fastlane/lib/fastlane/actions/copy_artifacts.rb. Clicking that link I can see the source code - and from that I know this is a fastlane action documented on docs.fastlane.tools - but the code file doesn't say "I am an action you can use" and I have no direct way to get to the documentation of that action at https://docs.fastlane.tools/actions/copy_artifacts/
Suggestion:
The Source code could get a standard comment/docs block at the beginning that tells the user what it is and where the proper documentation can be found.
PS: Even googling for "copy_artifacts fastlane" will return the same page as #1 instead of the real docs link.
Tools have special documentation source, but docs website only links to "actions" that don't actually create the documentation. These action files could include a comment where to look for the actual documentation.
Example: https://docs.fastlane.tools/actions/gradle/#gradle
"3 Examples" because array has 3 entries.
But each entry can (and does) contain several entries so one can add additional text after the pure code example.
Solution(s):
a) Find another way to count the examples
b) Don't abuse the array that way
c) Find another way to add text to code examples and b)
Links to code of action, that is normally used to generate docs:
https://github.com/fastlane/fastlane/edit/master/fastlane/lib/fastlane/actions/match.rb
The "special" actions (main fastlane actions) seem to get there docs from somewhere else.
Hi,
Thanks for the job on fastlane, it is really nice to use. I have a question about it.
I have a lane that is working well :
desc "Building a new release candidate version of the proto"
lane :build_rc do
gradle(task: "clean")
gradle(task: "assembleReleaseCandidate")
gradle(task: "createNewRevisionFile")
# upload to Beta by Crashlytics
crashlytics(
api_token: ENV["CRASHLYTICS_API_TOKEN"],
build_secret: ENV["CRASHLYTICS_BUILD_SECRET"],
)
send_slack(
message:"New release candidate version oavailable",
)
# sh "your_script.sh"
# You can also use other beta testing services here
end
My question is about the createNewRevisionFile (which is working on its own)
task createNewRevisionFile() << {
File f = new File("changelogs/"+version+"."+gitSha()+'.txt')
def string = 'git log -1 --pretty=%B'.execute().text.trim()
f.append(string)
return f.getPath()
}
What I want to do is :
String fileForTheRevision = gradle(task: "createNewRevisionFile")
crashlytics(
...
notes_path: "filteForTheRevision"
)
How can I get the return value of a gradle task in fastlane ?
So we have plugins (all external actions basically), and until now we called actions either "actions" or "integrations"
I was thinking it might make sense to call those things "integrations", as they're usually integrations with other services or tools. In the fastlane code base we'd still call them actions, as that's the term we've always used, but we can easily change the user facing docs, especially since we're writing them now.
fastlane has over 170 built-in actions
VS
fastlane has over 170 built-in integrations
Description of option "workspace" for action "match" is missing from https://docs.fastlane.tools/actions/#match
Looking at source code, I struggle to understand whether the option:
Until now, all fastlane
related docs are in the fastlane main repo.
The documentation of each of the tools was spread around the main repo, and it was hard for new users to understand fastlane
, and how to get started.
We set out to think of a concept for https://docs.fastlane.tools, a separate website, for all the documentation... unified.
The goal is to have a much more stream lined onboarding flow for new users. Instead of grouping docs by tool (which have ridiculous names sometimes sigh), we group the documentation around use-cases, e.g.
A few more notes:
gh-pages
branchI'm opening this because I can't quickly provide all of it myself. It would be good to have some basic documentation for Ruby version managers: Quick setup, common commands, basic usage with Fastlane, etc. I know RVM pretty well. I'm not aware of another brief guide to installing and using it, so I wrote this. I could contribute something similar to Fastlane, but I can't quickly write up rbenv or chruby. Perhaps others would be interested in contributing those guides.
I'd open a PR for the RVM stuff, but if that's the only thing there, it might sound like Fastlane was recommending or endorsing RVM. It might be best to try to get the others covered as well.
Looks like the Markdown isn't getting rendered on https://docs.fastlane.tools/actions/
The "Getting Started" articles should link out more to the actions/tools used so it is easier to get to the parameters and other documentation of the actions/tools used.
Example: https://docs.fastlane.tools/getting-started/android/release-deployment/ = 0 Links to https://docs.fastlane.tools/actions/supply/ or https://docs.fastlane.tools/actions/gradle/
Example: https://docs.fastlane.tools/plugins/create-plugin/
Right now it is very hard to get an overview of the content of a document, which is why other documents like https://docs.fastlane.tools/advanced/ use the headline levels to push entries into the navigation on the left (which has its own problems: #455)
For the create-plugin
document it would be a better idea to start the document with an auto generated Table of Contents display above the actual content.
This would also work for other documents, but probably not for all of them, which means there would have to be a way to configure this.
As I wanted to understand the plugin scoring, I found https://docs.fastlane.tools/actions/plugin_scores/ and two problems with it:
https://docs.fastlane.tools/actions/supply/
https://docs.fastlane.tools/actions/deliver/
Could use a Apple and Android icon after the title for example.
(Maybe obsolete with the action rename)
In the docs of actions, why don't you define the type of the parameter, or possible parameters if only a few exists? https://docs.fastlane.tools/actions/#building So for the tables Parameters, there should be Key Description Type or similar columns.
I had to look up an example fastfile to see what kind of value was needed for "include_bitcode". (Yes, 1, Maybe, Always, "Yes", "1", true, True, ON, on, On) ...
other_action
to call an "other action" in an action exists and is very useful. Unfortunately it is not documented in the new docs, where I am creating this issue.
My usecase is that I theoretically wanted to to use plugin in a plugin, which is not possible. So I was advised to copy the action over to the second plugin and use it there. To do that, I have to go from one action to another.
Background from Slack:
janpio [7:48 PM]
Can anyone think of a plugin that has at least 2 actions and one of these uses the other one? I need an example how to best implement this.
Hmm probably this: fastlane/fastlane#4441
Which means this: https://github.com/fastlane/fastlane/blob/master/fastlane/lib/fastlane/other_action.rb
Correct?
Is this documented anywhere?
Seems it was, but isn't any more in the new docs or anything accessible:
https://github.com/fastlane/fastlane/blob/master/fastlane/docs/README.md#extensionsjosh [10:36]
other_action.your_other_action_name
ieother_action.<action_name>
The search on the docs page is not "as-you-type" and can improve. After having a quick chat with Felix at a conference, he seems to be very open to such idea.
At Algolia, we have docsearch which can help you with that for free. We power the documentation of Stripe, React and more. You can learn more about it here.
Design was taken from https://docs.fabric.io. We have to adapt it to be more like fastlane (https://fastlane.tools). White, with a lot of colors (the 5 at least)
Must haves:
fastlane.css
the bottom part. There is some comments on why it's like this. However the menu item is too far to the right when you click on Home
for example (only when it's active)Secondary
Edit on GitHub
button to every page to the template, so people can easily contribute changes, without manually finding the docs repo and the .md
fileUnsure
Advanced
button in the sidebar, with a lot of sub-pages, but we don't want to list them all the time. docs.fabric.io already does that somehowTo make fastlane
the tool for deploying, let's get more people to start using fastlane
itself too:
Let's use the following for all code samples:
snapshot(scheme: "something")
sigh(user: "[email protected]")
and also mention that you can call each tool from the command line using
fastlane snapshot --scheme "something"
fastlane sigh -u [email protected]
(note that we prefix all calls with fastlane)
Install instructions should also always mention [sudo] gem install fastlane --verbose
, and not an individual tool (with the exception of spaceship
)
advanced.md is quite a collection of headlines right now. This could and should be structured a bit more to offer the user more guidance.
(Will probably only work if #455 is fixed somehow)
The bottom of the doc mentions the license. The link address in the blurb currently points to:
https://docs.fastlane.tools/LICENSE
Which gives a 404. It should instead point to a valid link, such as https://github.com/fastlane/fastlane/blob/master/LICENSE
(loving the docs site btw!)
Since frameit is mostly used for non-app store screenshots, the flow doesn't make a lot of sense for new users on https://docs.fastlane.tools/getting-started/ios/screenshots/.
Instead I'd move the frameit information to the bottom and mention it after uploading the screenshots to the app store
A declarative, efficient, and flexible JavaScript library for building user interfaces.
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google ❤️ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.