kosmos/nostr-gem
kosmos/nostr-gem
8
0
Fork 0
Code Issues Pull Requests Releases Activity

Update the rake task list

Browse Source
This commit is contained in:
Wilson Silva 2023-01-21 20:42:40 +07:00
parent e0f7a4cc50
commit 59e058d511
No known key found for this signature in database
GPG Key ID: 65135F94E23F82C8
1 changed files with 19 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
README.md
View File

@ -200,15 +200,25 @@ The health and maintainability of the codebase is ensured through a set of
Rake tasks to test, lint and audit the gem for security vulnerabilities and documentation: Rake tasks to test, lint and audit the gem for security vulnerabilities and documentation:
``` ```
rake bundle:audit # Checks for vulnerable versions of gems rake build # Build nostr.gem into the pkg directory
rake qa # Test, lint and perform security and documentation audits rake build:checksum # Generate SHA512 checksum if nostr.gem into the checksums directory
rake rubocop # Lint the codebase with RuboCop rake bundle:audit:check # Checks the Gemfile.lock for insecure dependencies
rake rubocop:auto_correct # Auto-correct RuboCop offenses rake bundle:audit:update # Updates the bundler-audit vulnerability database
rake spec # Run RSpec code examples rake clean # Remove any temporary products
rake verify_measurements # Verify that yardstick coverage is at least 100% rake clobber # Remove any generated files
rake yard # Generate YARD Documentation rake coverage # Run spec with coverage
rake yard:junk # Check the junk in your YARD Documentation rake install # Build and install nostr.gem into system gems
rake yardstick_measure # Measure docs in lib/**/*.rb with yardstick rake install:local # Build and install nostr.gem into system gems without network access
rake qa # Test, lint and perform security and documentation audits
rake release[remote] # Create a tag, build and push nostr.gem to rubygems.org
rake rubocop # Run RuboCop
rake rubocop:autocorrect # Autocorrect RuboCop offenses (only when it's safe)
rake rubocop:autocorrect_all # Autocorrect RuboCop offenses (safe and unsafe)
rake spec # Run RSpec code examples
rake verify_measurements # Verify that yardstick coverage is at least 100%
rake yard # Generate YARD Documentation
rake yard:junk # Check the junk in your YARD Documentation
rake yardstick_measure # Measure docs in lib/**/*.rb with yardstick
``` ```
## Contributing ## Contributing