Skip to content
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

Change 'file' to 'filepath' in help #32

Merged
merged 1 commit into from
Dec 4, 2020

Conversation

imjoehaines
Copy link
Member

Goal

Change arguments with a type of file to filepath, which is a bit clearer

Browser help
$ ./bin/cli upload-browser --help

  bugsnag-source-maps upload-browser [...opts] 

Options

  --api-key string        your project's API key required                                       
  --overwrite             whether to replace exiting source maps uploaded with the same version 
  --project-root string   the top level directory of your project                               
  --endpoint string       customize the endpoint for Bugsnag On-Premise                         
  --quiet                 less verbose logging                                                  
  --app-version string                                                                          

Single upload

  Options for uploading a source map for a single bundle 

  --source-map filepath   the path to the source map required                                
  --bundle-url url        the URL the bundle is served at (may contain * wildcards) required 
  --bundle filepath       the path to the bundle                                             

Multiple upload

  Options for recursing directory and upload multiple source maps 

  --directory path   the directory to start searching for source maps in required                  
  --base-url url     the base URL that JS bundles are served from (may contain * wildcards)        
                     required                                                                      
Node help
$ ./bin/cli upload-node --help

  bugsnag-source-maps upload-node [...opts] 

Options

  --api-key string        your project's API key required                                       
  --overwrite             whether to replace exiting source maps uploaded with the same version 
  --project-root string   the top level directory of your project                               
  --endpoint string       customize the endpoint for Bugsnag On-Premise                         
  --quiet                 less verbose logging                                                  
  --app-version string                                                                          

Single upload

  Options for uploading a source map for a single bundle 

  --source-map filepath   the path to the source map required 
  --bundle filepath       the path to the bundle required     

Multiple upload

  Options for recursing directory and upload multiple source maps 

  --directory path   the directory to start searching for source maps in required 
ReactNative help
$ ./bin/cli upload-react-native --help

  bugsnag-source-maps upload-react-native [...opts] 

Options

  --api-key string              your project's API key required                                       
  --overwrite                   whether to replace exiting source maps uploaded with the same version 
  --project-root string         the top level directory of your project                               
  --endpoint string             customize the endpoint for Bugsnag On-Premise                         
  --quiet                       less verbose logging                                                  
  --platform string             the application platform, either "android" or "ios" required          
  --app-version string                                                                                
  --code-bundle-id string                                                                             
  --app-version-code string                                                                           
  --app-bundle-version string                                                                         
  --dev                         indicates this is a debug build                                       

Provide souce map and bundle

  Options for uploading a source map and bundle 

  --source-map filepath   the path to the source map required 
  --bundle filepath       the path to the bundle required     

Fetch source map and bundle

  Options for fetching a source map and bundle from the React Native bundler 

  --fetch                          enable fetch mode required                
  --bundler-url url                the URL of the React Native bundle server 
  --bundler-entry-point filepath   the entry point of your React Native app  

@imjoehaines imjoehaines merged commit f7839f4 into next Dec 4, 2020
@imjoehaines imjoehaines deleted the clarify-file-type-arguments branch December 4, 2020 16:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants