Redmine/rake

from HTYP, the free directory anyone can edit if they can prove to me that they're not a spambot
< Redmine
Revision as of 21:09, 16 May 2016 by Woozle (talk | contribs) (rake usage)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

rake appears to be a Ruby on Rails command. The following list of commands came up when I typed rake redmine:plugins:migrate RAILS_ENV=production -T; I'm not sure how it is actually supposed to be invoked:

rake about                                       # List versions of all Rails frameworks and the environment
rake assets:clean                                # Remove compiled assets
rake assets:precompile                           # Compile all the assets named in config.assets.precompile
rake ci                                          # Run the Continous Integration tests for Redmine
rake ci:build                                    # Build Redmine
rake ci:setup                                    # Setup Redmine for a new build
rake ci:teardown                                 # Finish the build
rake config/database.yml                         # Creates database.yml for the CI server
rake db:create                                   # Create the database from DATABASE_URL or config/database.yml for the current Rails.env (use db:create:all to create all dbs in the config)
rake db:decrypt                                  # Decrypts SCM and LDAP passwords in the database.
rake db:drop                                     # Drops the database using DATABASE_URL or the current Rails.env (use db:drop:all to drop all databases)
rake db:encrypt                                  # Encrypts SCM and LDAP passwords in the database.
rake db:fixtures:load                            # Load fixtures into the current environment's database.
rake db:migrate                                  # Migrate the database (options: VERSION=x, VERBOSE=false).
rake db:migrate:status                           # Display status of migrations
rake db:rollback                                 # Rolls the schema back to the previous version (specify steps w/ STEP=n).
rake db:schema:dump                              # Create a db/schema.rb file that can be portably used against any DB supported by AR
rake db:schema:load                              # Load a schema.rb file into the database
rake db:seed                                     # Load the seed data from db/seeds.rb
rake db:setup                                    # Create the database, load the schema, and initialize with the seed data (use db:reset to also drop the db first)
rake db:structure:dump                           # Dump the database structure to db/structure.sql. Specify another file with DB_STRUCTURE=db/my_structure.sql
rake db:version                                  # Retrieves the current schema version number
rake doc:app                                     # Generate docs for the app -- also available doc:rails, doc:guides, doc:plugins (options: TEMPLATE=/rdoc-template.rb, TITLE="Custom Title")
rake extract_fixtures                            # Create YAML test fixtures from data in an existing database.
rake generate_secret_token                       # Generates a secret token for the application.
rake locales                                     # Updates and checks locales against en.yml
rake locales:add_key                             # Adds a new top-level translation string to all locale file (only works for childless keys, probably doesn't work on windows, doesn't check f...
rake locales:check_interpolation                 # Checks interpolation arguments in locals against en.yml
rake locales:check_parsing_by_psych              # Check parsing yaml by psych library on Ruby 1.9.
rake locales:dup                                 # Duplicates a key.
rake locales:remove_key                          # Removes a translation string from all locale file (only works for top-level childless non-multiline keys, probably doesn't work on windows).
rake locales:update                              # Updates language files based on en.yml content (only works for new top level keys).
rake log:clear                                   # Truncates all *.log files in log/ to zero bytes
rake middleware                                  # Prints out your Rack middleware stack
rake notes                                       # Enumerate all annotations (use notes:optimize, :fixme, :todo for focus)
rake notes:custom                                # Enumerate a custom annotation, specify with ANNOTATION=CUSTOM
rake rails:template                              # Applies the template supplied by LOCATION=(/path/to/template) or URL
rake rails:update                                # Update configs and some other initially generated files (or use just update:configs, update:scripts, or update:application_controller)
rake redmine:attachments:move_to_subdirectories  # Moves attachments stored at the root of the file directory (ie.
rake redmine:attachments:prune                   # Removes uploaded files left unattached after one day.
rake redmine:email:read                          # Read an email from standard input.
rake redmine:email:receive_imap                  # Read emails from an IMAP server.
rake redmine:email:receive_pop3                  # Read emails from an POP3 server.
rake redmine:email:test[login]                   # Send a test email to the user with the provided login name
rake redmine:fetch_changesets                    # Fetch changesets from the repositories
rake redmine:load_default_data                   # Load Redmine default configuration data.
rake redmine:migrate_from_mantis                 # Mantis migration script
rake redmine:migrate_from_trac                   # Trac migration script
rake redmine:permissions                         # List all permissions and the actions registered with them
rake redmine:plugins                             # Migrates and copies plugins assets.
rake redmine:plugins:assets                      # Copies plugins assets into the public directory.
rake redmine:plugins:migrate                     # Migrates installed plugins.
rake redmine:plugins:test                        # Runs the plugins tests.
rake redmine:plugins:test:functionals            # Run tests for {:functionals=>"db:test:prepare"}
rake redmine:plugins:test:integration            # Run tests for {:integration=>"db:test:prepare"}
rake redmine:plugins:test:units                  # Run tests for {:units=>"db:test:prepare"}
rake redmine:send_reminders                      # Send reminders about issues due in the next days.
rake redmine:tokens:prune                        # Removes expired tokens.
rake redmine:watchers:prune                      # Removes watchers from what they can no longer view.
rake routes                                      # Print out all defined routes in match order, with names.
rake secret                                      # Generate a cryptographically secure secret key (this is typically used to generate a secret for cookie sessions).
rake stats                                       # Report code statistics (KLOCs, etc) from the application
rake test                                        # Runs test:units, test:functionals, test:integration together (also available: test:benchmark, test:profile, test:plugins)
rake test:coverage                               # Measures test coverage
rake test:rdm_routing                            # Run tests for rdm_routing / Run the routing tests
rake test:recent                                 # Run tests for {:recent=>"test:prepare"} / Test recent changes
rake test:scm                                    # Run unit and functional scm tests
rake test:scm:functionals                        # Run tests for {:functionals=>"db:test:prepare"} / Run the scm functional tests
rake test:scm:setup:all                          # Creates all test repositories
rake test:scm:setup:bazaar                       # Creates a test bazaar repository
rake test:scm:setup:create_dir                   # Creates directory for test repositories
rake test:scm:setup:cvs                          # Creates a test cvs repository
rake test:scm:setup:darcs                        # Creates a test darcs repository
rake test:scm:setup:filesystem                   # Creates a test filesystem repository
rake test:scm:setup:git                          # Creates a test git repository
rake test:scm:setup:mercurial                    # Creates a test mercurial repository
rake test:scm:setup:subversion                   # Creates a test subversion repository
rake test:scm:units                              # Run tests for {:units=>"db:test:prepare"} / Run the scm unit tests
rake test:scm:update                             # Updates installed test repositories
rake test:single                                 # Run tests for {:single=>"test:prepare"}
rake test:ui                                     # Run tests for {:ui=>"db:test:prepare"} / Run the UI tests with Capybara (PhantomJS listening on port 4444 is required)
rake test:uncommitted                            # Run tests for {:uncommitted=>"test:prepare"} / Test changes since last checkin (only Subversion and Git)
rake time:zones:all                              # Displays all time zones, also available: time:zones:us, time:zones:local -- filter with OFFSET parameter, e.g., OFFSET=-6
rake tmp:clear                                   # Clear session, cache, and socket files from tmp/ (narrow w/ tmp:sessions:clear, tmp:cache:clear, tmp:sockets:clear)
rake tmp:create                                  # Creates tmp directories for sessions, cache, sockets, and pids

More general help for rake (from rake -h):

rake [-f rakefile] {options} targets...

Options are ...
        --backtrace=[OUT]            Enable full backtrace.  OUT can be stderr (default) or stdout.
        --comments                   Show commented tasks only
        --job-stats [LEVEL]          Display job statistics. LEVEL=history displays a complete job list
        --rules                      Trace the rules resolution.
        --suppress-backtrace PATTERN Suppress backtrace lines matching regexp PATTERN. Ignored if --trace is on.
    -A, --all                        Show all tasks, even uncommented ones
    -D, --describe [PATTERN]         Describe the tasks (matching optional PATTERN), then exit.
    -e, --execute CODE               Execute some Ruby code and exit.
    -E, --execute-continue CODE      Execute some Ruby code, then continue with normal task processing.
    -f, --rakefile [FILE]            Use FILE as the rakefile.
    -G, --no-system, --nosystem      Use standard project Rakefile search paths, ignore system wide rakefiles.
    -g, --system                     Using system wide (global) rakefiles (usually '~/.rake/*.rake').
    -I, --libdir LIBDIR              Include LIBDIR in the search path for required modules.
    -j, --jobs [NUMBER]              Specifies the maximum number of tasks to execute in parallel. (default:2)
    -m, --multitask                  Treat all tasks as multitasks.
    -n, --dry-run                    Do a dry run without executing actions.
    -N, --no-search, --nosearch      Do not search parent directories for the Rakefile.
    -P, --prereqs                    Display the tasks and dependencies, then exit.
    -p, --execute-print CODE         Execute some Ruby code, print the result, then exit.
    -q, --quiet                      Do not log messages to standard output.
    -r, --require MODULE             Require MODULE before executing rakefile.
    -R, --rakelibdir RAKELIBDIR,     Auto-import any .rake files in RAKELIBDIR. (default is 'rakelib')
        --rakelib
    -s, --silent                     Like --quiet, but also suppresses the 'in directory' announcement.
    -t, --trace=[OUT]                Turn on invoke/execute tracing, enable full backtrace. OUT can be stderr (default) or stdout.
    -T, --tasks [PATTERN]            Display the tasks (matching optional PATTERN) with descriptions, then exit.
    -v, --verbose                    Log message to standard output.
    -V, --version                    Display the program version.
    -W, --where [PATTERN]            Describe the tasks (matching optional PATTERN), then exit.
    -X, --no-deprecation-warnings    Disable the deprecation warnings.
    -h, -H, --help                   Display this help message.